Skip to content

doc: fix environment variable settings for ccache #40550

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Trott merged 2 commits into from
Oct 24, 2021
Merged

doc: fix environment variable settings for ccache #40550

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
edd716b
doc: fix macOS environment variables for ccache
Trott Oct 21, 2021
31d7d6c
doc: simplify ccache instructions
Trott Oct 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
doc: fix macOS environment variables for ccache 
macOS requires `cc` and `c++` rather than `gcc` and `g++`.

Closes: #40542

PR-URL: #40550
Fixes: #40542
Reviewed-By: Geoffrey Booth <webadmin@geoffreybooth.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
  • Loading branch information
@Trott
Trott committed Oct 24, 2021
commit edd716beb1c8d620f8b1edf547ea0eea119adf38
12 changes: 12 additions & 0 deletions BUILDING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -519,6 +519,8 @@ $ make test-only
If you plan to frequently rebuild Node.js, especially if using several branches,
installing `ccache` can help to greatly reduce build times. Set up with:

On GNU/Linux:

```console
$ sudo apt install ccache # for Debian/Ubuntu, included in most Linux distros
$ ccache -o cache_dir=<tmp_dir>
Expand All @@ -527,6 +529,16 @@ $ export CC="ccache gcc" # add to your .profile
$ export CXX="ccache g++" # add to your .profile
```

On macOS:

```console
$ brew install ccache # see https://brew.sh
$ ccache -o cache_dir=<tmp_dir>
$ ccache -o max_size=5.0G
$ export CC="ccache cc" # add to ~/.zshrc or other shell config file
$ export CXX="ccache c++" # add to ~/.zshrc or other shell config file
```
Comment thread
Trott marked this conversation as resolved.
Outdated

This will allow for near-instantaneous rebuilds even when switching branches.

When modifying only the JS layer in `lib`, it is possible to externally load it
Expand Down