Skip to content

Commit

Permalink
doc: remove mold use on mac for speeding up build
Browse files Browse the repository at this point in the history
Co-authored-by: Vinicius Lourenço
<12551007+H4ad@users.noreply.github.com>
PR-URL: nodejs#52252
Reviewed-By: Vinícius Lourenço Claro Cardoso <contact@viniciusl.com.br>
Reviewed-By: Yagiz Nizipli <yagiz.nizipli@sentry.io>
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
  • Loading branch information
congzhangzh authored and eliphazbouye committed Jun 20, 2024
1 parent 42a18f3 commit e957dd1
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -546,25 +546,32 @@ If you encounter any difficulties, consider disabling `mold` as a
troubleshooting step.

If you plan to frequently rebuild Node.js, especially if using several
branches, installing `ccache` and `mold` can help to greatly reduce build
branches, installing `ccache` can help to greatly reduce build
times. Set up with:

On GNU/Linux:

Tips: `mold` can speed up the link process, which can't be cached, you may
need to install the latest version but not the apt version.

```bash
sudo apt install ccache mold # for Debian/Ubuntu, included in most Linux distros
export CC="ccache gcc" # add to your .profile
export CXX="ccache g++" # add to your .profile
export LDFLAGS="-fuse-ld=mold" # add to your .profile
```

Refs:

1. <https://ccache.dev/performance.html>
2. <https://github.com/rui314/mold>

On macOS:

```bash
brew install ccache mold # see https://brew.sh
brew install ccache # see https://brew.sh
export CC="ccache cc" # add to ~/.zshrc or other shell config file
export CXX="ccache c++" # add to ~/.zshrc or other shell config file
export LDFLAGS="-fuse-ld=mold" # add to ~/.zshrc or other shell config file
```

This will allow for near-instantaneous rebuilds when switching branches back
Expand All @@ -582,11 +589,6 @@ the specified directory. The JS debugger of Visual Studio Code supports this
configuration since the November 2020 version and allows for setting
breakpoints.

Refs:

1. <https://ccache.dev/performance.html>
2. <https://github.com/rui314/mold>

#### Troubleshooting Unix and macOS builds

Stale builds can sometimes result in `file not found` errors while building.
Expand Down

0 comments on commit e957dd1

Please sign in to comment.