Add two tips for speeding up the dev builds #36452
Conversation
nodejs-github-bot
added
build
mmomtchev
force-pushed
the
doc-fast-build
branch
from
b7f8758
to
af1427d
Compare
BUILDING.md
Outdated
| If you plan to frequently rebuild Node.js, especially if using several branches, | ||
| installing `ccache` can help to greatly reduce build times. Setup with: | ||
| ```console | ||
| $ sudo apt install ccache # for Debian/Ubuntu, included in most Linux distros |
There was a problem hiding this comment.
Probably a good idea to include how to install ccache on max and windows as well in a comment?
brew install ccache
choco install ccache
And maybe link to https://ccache.dev/download.html ?
There was a problem hiding this comment.
OSX is flawless, but support for Visual Studio is far from perfect, I don't know if we should recommend to people to use it?
BUILDING.md
Outdated
| $ ccache -o cache_dir=<tmp_dir> | ||
| $ ccache -o max_size=5.0G | ||
| $ export CC="ccache gcc" # add to your .profile | ||
| $ export CXX="ccache g++" # add to your .profile |
There was a problem hiding this comment.
I would mention that in windows this is set and not export for the windows users?
(To be fair I've never used ccache in windows)
There was a problem hiding this comment.
I don't think ccache officially works with VS on Windows. I know in the CI we don't use it (we use clcache instead https://github.com/nodejs/build/blob/36202a24f7d19729bea1e0efb0fe7045b2c42dc6/ansible/roles/visual-studio/tasks/main.yml#L27-L54).
There was a problem hiding this comment.
Left a comment about the anchor format but that's easy to fix. I agree that more can be done to show how to make it work in non apt-get environments, but those can be subsequent PRs. I'm OK with "I'm only PR'ing in the platforms I actually use a lot." This is useful as is and I'm totally OK if someone wants to land it.
Trott
force-pushed
the
doc-fast-build
branch
from
7f96f9f
to
36581f1
Compare
Add two important tips for novice Node.js contributors PR-URL: #36452 Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Franziska Hinkelmann <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: James M Snell <[email protected]>
|
Landed in 36581f1 |
Add two important tips for novice Node.js contributors PR-URL: #36452 Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Franziska Hinkelmann <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: James M Snell <[email protected]>
Add two important tips for novice Node.js contributors PR-URL: #36452 Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Franziska Hinkelmann <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: James M Snell <[email protected]>
Add two tips for speeding up the dev builds
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes