jiangcuo/node
1
0
Fork 0
mirror of https://github.com/nodejs/node.git synced 2025-04-28 05:25:19 +00:00
Code Issues Actions 21 Packages Projects Releases Wiki Activity

doc: fix Windows ccache section position

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/57326
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
This commit is contained in:
Stefan Stojanovic 2025-03-05 17:33:52 +01:00 committed by GitHub
parent 157b36b91b
commit 755e4603fd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 37 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
BUILDING.md
View File

@ -40,6 +40,7 @@ file a new issue.
* [Option 2: Automated install with WinGet](#option-2-automated-install-with-winget)
* [Option 3: Automated install with Boxstarter](#option-3-automated-install-with-boxstarter)
* [Building Node.js](#building-nodejs-2)
* [Using ccache](#using-ccache)
* [Android](#android)
* [`Intl` (ECMA-402) support](#intl-ecma-402-support)
* [Build with full ICU support (all locales supported by ICU)](#build-with-full-icu-support-all-locales-supported-by-icu)
@ -577,42 +578,6 @@ export CC="ccache cc" # add to ~/.zshrc or other shell config file
export CXX="ccache c++" # add to ~/.zshrc or other shell config file
```
On Windows:
Follow <https://github.com/ccache/ccache/wiki/MS-Visual-Studio>, and you
should notice that obj file will be bigger than the normal one.
First, install ccache. Assuming the installation of ccache is in `c:\ccache`
(where you can find `ccache.exe`), copy `c:\ccache\ccache.exe` to `c:\ccache\cl.exe`
with this command.
```powershell
cp c:\ccache\ccache.exe c:\ccache\cl.exe
```
With newer version of Visual Studio, it may need the copy to be `clang-cl.exe`
instead. If the output of `vcbuild.bat` suggestion missing `clang-cl.exe`, copy
it differently:
```powershell
cp c:\ccache\ccache.exe c:\ccache\clang-cl.exe
```
When building Node.js, provide a path to your ccache via the option:
```powershell
.\vcbuild.bat ccache c:\ccache\
```
This will allow for near-instantaneous rebuilds when switching branches back
and forth that were built with cache.
To use it with ClangCL, run this instead:
```powershell
.\vcbuild.bat clang-cl ccache c:\ccache\
```
##### Loading JS files from disk instead of embedding
When modifying only the JS layer in `lib`, it is possible to externally load it
@ -810,6 +775,42 @@ To test if Node.js was built correctly:
Release\node -e "console.log('Hello from Node.js', process.version)"
```
##### Using ccache:
Follow <https://github.com/ccache/ccache/wiki/MS-Visual-Studio>, and you
should notice that obj file will be bigger than the normal one.
First, install ccache. Assuming the installation of ccache is in `c:\ccache`
(where you can find `ccache.exe`), copy `c:\ccache\ccache.exe` to `c:\ccache\cl.exe`
with this command.
```powershell
cp c:\ccache\ccache.exe c:\ccache\cl.exe
```
With newer version of Visual Studio, it may need the copy to be `clang-cl.exe`
instead. If the output of `vcbuild.bat` suggestion missing `clang-cl.exe`, copy
it differently:
```powershell
cp c:\ccache\ccache.exe c:\ccache\clang-cl.exe
```
When building Node.js, provide a path to your ccache via the option:
```powershell
.\vcbuild.bat ccache c:\ccache\
```
This will allow for near-instantaneous rebuilds when switching branches back
and forth that were built with cache.
To use it with ClangCL, run this instead:
```powershell
.\vcbuild.bat clang-cl ccache c:\ccache\
```
### Android
Android is not a supported platform. Patches to improve the Android build are