Skip to content

Commit 5e8eb5f

Browse files
joyeecheungRafaelGSS
authored andcommitted
doc: add a tip about developer mode on Windows
On Windows, creating symlinks requires Developer Mode to be enabled or running the command as Administrator. Tests that rely on creating symlinks may fail with EPERM errors if symlink creation is not permitted. Add a tip about this for the docs about running tests on Windows. PR-URL: #61112 Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Stefan Stojanovic <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Gerhard Stöbich <[email protected]> Reviewed-By: Xuguang Mei <[email protected]>
1 parent a424877 commit 5e8eb5f

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

BUILDING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -870,6 +870,11 @@ To test if Node.js was built correctly:
870870
Release\node -e "console.log('Hello from Node.js', process.version)"
871871
```
872872

873+
> \[!TIP]
874+
> On Windows, creating symlinks requires [Developer Mode][] to be enabled or
875+
> running the command as Administrator. Tests that rely on creating symlinks
876+
> may fail with EPERM errors if symlink creation is not permitted.
877+
873878
##### Using ccache:
874879

875880
Follow <https://github.com/ccache/ccache/wiki/MS-Visual-Studio>, and you
@@ -1130,4 +1135,5 @@ by opening a pull request against the registry available at
11301135
<https://github.com/nodejs/node/blob/HEAD/doc/abi_version_registry.json>.
11311136

11321137
[AIX toolbox]: https://www.ibm.com/support/pages/aix-toolbox-open-source-software-overview
1138+
[Developer Mode]: https://learn.microsoft.com/en-us/windows/advanced-settings/developer-mode
11331139
[Python versions]: https://devguide.python.org/versions/

0 commit comments

Comments
 (0)