Skip to content
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.

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

doc: add note in BUILDING.md about running make distclean #31542

Closed
wants to merge 3 commits into from
Closed
Changes from 2 commits
Commits
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
33 changes: 31 additions & 2 deletions BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,14 @@ file a new issue.
* [Running Coverage](#running-coverage)
* [Building the documentation](#building-the-documentation)
* [Building a debug build](#building-a-debug-build)
* [Cleaning up the build](#cleaning-up-the-build)
* [Windows](#windows)
* [Prerequisites](#prerequisites)
* [Option 1: Manual install](#option-1-manual-install)
* [Option 2: Automated install with Boxstarter](#option-2-automated-install-with-boxstarter)
* [Building Node.js](#building-nodejs-1)
* [Building Node.js](#building-nodejs-2)
* [Android/Android-based devices (e.g. Firefox OS)](#androidandroid-based-devices-eg-firefox-os)
* [Troubleshooting Build failures](#troubleshooting-build-failures)
* [`Intl` (ECMA-402) support](#intl-ecma-402-support)
* [Build with full ICU support (all locales supported by ICU)](#build-with-full-icu-support-all-locales-supported-by-icu)
* [Unix/macOS](#unixmacos)
Expand All @@ -44,7 +46,7 @@ file a new issue.
* [Building without Intl support](#building-without-intl-support)
* [Unix/macOS](#unixmacos-2)
* [Windows](#windows-3)
* [Use existing installed ICU (Unix/macOS only)](#use-existing-installed-icu-unixmacOS-only)
* [Use existing installed ICU (Unix/macOS only)](#use-existing-installed-icu-unixmacos-only)
* [Build with a specific ICU](#build-with-a-specific-icu)
* [Unix/macOS](#unixmacos-3)
* [Windows](#windows-4)
Expand Down Expand Up @@ -488,6 +490,27 @@ $ gdb /opt/node-debug/node core.node.8.1535359906
$ backtrace
```

#### Cleaning up the build

Always try

``` console
$ make clean
$ make -j4
```

first, to clean the current build and build again.

For a more thorough clean up, try

``` console
$ make distclean
$ ./configure
$ make -j4
```
```distclean``` should be followed by ```./configure```, and therefore takes
significantly longer to rebuild than using ```make clean```.

### Windows

#### Prerequisites
Expand Down Expand Up @@ -596,6 +619,12 @@ $ ./android-configure /path/to/your/android-ndk
$ make
```

### Troubleshooting Build failures
Error: ``` fatal error: 'src/snapshot/macros.h' file not found```

This is probably due to a stale build, and should be fixed with a full clean.
Refer to [Cleaning up the build](#cleaning-up-the-build)

## `Intl` (ECMA-402) support

[Intl](https://github.com/nodejs/node/blob/master/doc/api/intl.md) support is
Expand Down