Skip to content

Commit 084741d

Browse files
joyeecheungaduh95
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 <rafael.nunu@hotmail.com> Reviewed-By: Stefan Stojanovic <stefan.stojanovic@janeasystems.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de> Reviewed-By: Xuguang Mei <meixuguang@gmail.com>
1 parent ed4de37 commit 084741d

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
@@ -792,6 +792,11 @@ To test if Node.js was built correctly:
792792
Release\node -e "console.log('Hello from Node.js', process.version)"
793793
```
794794

795+
> \[!TIP]
796+
> On Windows, creating symlinks requires [Developer Mode][] to be enabled or
797+
> running the command as Administrator. Tests that rely on creating symlinks
798+
> may fail with EPERM errors if symlink creation is not permitted.
799+
795800
##### Using ccache:
796801

797802
Follow <https://github.com/ccache/ccache/wiki/MS-Visual-Studio>, and you
@@ -1052,4 +1057,5 @@ by opening a pull request against the registry available at
10521057
<https://github.com/nodejs/node/blob/HEAD/doc/abi_version_registry.json>.
10531058

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

0 commit comments

Comments
 (0)