Skip to content

Commit e83af20

Browse files
swagatatacodebytere
authored andcommittedMar 30, 2020
doc: add note in BUILDING.md about running make distclean
Fixes: #28675 PR-URL: #31542 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
1 parent 2a4d31a commit e83af20

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
* [Default: `small-icu` (English only) support](#default-small-icu-english-only-support)
@@ -42,7 +43,7 @@ file a new issue.
4243
* [Building without Intl support](#building-without-intl-support)
4344
* [Unix/macOS](#unixmacos-1)
4445
* [Windows](#windows-2)
45-
* [Use existing installed ICU (Unix/macOS only)](#use-existing-installed-icu-unixmacOS-only)
46+
* [Use existing installed ICU (Unix/macOS only)](#use-existing-installed-icu-unixmacos-only)
4647
* [Build with a specific ICU](#build-with-a-specific-icu)
4748
* [Unix/macOS](#unixmacos-2)
4849
* [Windows](#windows-3)
@@ -495,6 +496,17 @@ $ gdb /opt/node-debug/node core.node.8.1535359906
495496
$ backtrace
496497
```
497498

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

500512
#### Prerequisites

0 commit comments

Comments
 (0)
Please sign in to comment.