From 6d3c3f82fc8ac0eb1f085b15f490e3fb292a96c6 Mon Sep 17 00:00:00 2001 From: Aviv Keller <38299977+RedYetiDev@users.noreply.github.com> Date: Thu, 23 May 2024 09:50:10 -0400 Subject: [PATCH 1/2] doc: add note for windows users and symlinks --- BUILDING.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/BUILDING.md b/BUILDING.md index 7148fe8e6ac7ee..f2af1c8b6781bd 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -691,6 +691,13 @@ disk space. git clone https://github.com/nodejs/node.git cd node ``` +> [!TIP] +> If you are building from a Windows machine, symlinks are disabled by default, and can be enabled by cloning +> with the `-c core.symlinks=true` flag. +> ```powershell +> git clone -c core.symlinks=true +> ``` + * If the path to your build directory contains a space or a non-ASCII character, the build will likely fail From 4732654ec330aeac65ea07144409466b8683ee54 Mon Sep 17 00:00:00 2001 From: Aviv Keller <38299977+RedYetiDev@users.noreply.github.com> Date: Thu, 23 May 2024 10:08:50 -0400 Subject: [PATCH 2/2] Update BUILDING.md --- BUILDING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/BUILDING.md b/BUILDING.md index f2af1c8b6781bd..c42c7877272001 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -691,9 +691,11 @@ disk space. git clone https://github.com/nodejs/node.git cd node ``` -> [!TIP] + +> \[!TIP] > If you are building from a Windows machine, symlinks are disabled by default, and can be enabled by cloning > with the `-c core.symlinks=true` flag. +> > ```powershell > git clone -c core.symlinks=true > ```