Skip to content

Commit a733c18

Browse files
swagatataTrott
authored andcommitted
doc: add note in BUILDING.md about running make distclean
Fixes: #28675 PR-URL: #31542 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: Rich Trott <[email protected]>
1 parent f9a27ea commit a733c18

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

BUILDING.md

+14-2
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,12 @@ file a new issue.
2828
* [Running Coverage](#running-coverage)
2929
* [Building the documentation](#building-the-documentation)
3030
* [Building a debug build](#building-a-debug-build)
31+
* [Troubleshooting Unix and macOS builds](#troubleshooting-unix-and-macos-builds)
3132
* [Windows](#windows)
3233
* [Prerequisites](#prerequisites)
3334
* [Option 1: Manual install](#option-1-manual-install)
3435
* [Option 2: Automated install with Boxstarter](#option-2-automated-install-with-boxstarter)
35-
* [Building Node.js](#building-nodejs-1)
36+
* [Building Node.js](#building-nodejs-2)
3637
* [Android/Android-based devices (e.g. Firefox OS)](#androidandroid-based-devices-eg-firefox-os)
3738
* [`Intl` (ECMA-402) support](#intl-ecma-402-support)
3839
* [Build with full ICU support (all locales supported by ICU)](#build-with-full-icu-support-all-locales-supported-by-icu)
@@ -44,7 +45,7 @@ file a new issue.
4445
* [Building without Intl support](#building-without-intl-support)
4546
* [Unix/macOS](#unixmacos-2)
4647
* [Windows](#windows-3)
47-
* [Use existing installed ICU (Unix/macOS only)](#use-existing-installed-icu-unixmacOS-only)
48+
* [Use existing installed ICU (Unix/macOS only)](#use-existing-installed-icu-unixmacos-only)
4849
* [Build with a specific ICU](#build-with-a-specific-icu)
4950
* [Unix/macOS](#unixmacos-3)
5051
* [Windows](#windows-4)
@@ -488,6 +489,17 @@ $ gdb /opt/node-debug/node core.node.8.1535359906
488489
$ backtrace
489490
```
490491

492+
#### Troubleshooting Unix and macOS builds
493+
494+
Stale builds can sometimes result in `file not found` errors while building.
495+
This and some other problems can be resolved with `make distclean`. The
496+
`distclean` recipe aggressively removes build artifacts. You will need to
497+
build again (`make -j4`). Since all build artifacts have been removed, this
498+
rebuild may take a lot more time than previous builds. Additionally,
499+
`distclean` removes the file that stores the results of `./configure`. If you
500+
ran `./configure` with non-default options (such as `--debug`), you will need
501+
to run it again before invoking `make -j4`.
502+
491503
### Windows
492504

493505
#### Prerequisites

0 commit comments

Comments
 (0)