From a70a1ce3a95dac0bf3261071265c6b93fbe87ee3 Mon Sep 17 00:00:00 2001 From: Balakrishna Avulapati Date: Fri, 25 Feb 2022 08:50:41 +0530 Subject: [PATCH] doc: make building with ninja more discoverable Building with ninja would speed up the build We have the documenation about building with ninja, but not easily discoverable. And present this early to the contributors. PR-URL: https://github.com/nodejs/node/pull/41840 Reviewed-By: Rich Trott Reviewed-By: Darshan Sen Reviewed-By: Mestery Reviewed-By: Filip Skokan Reviewed-By: Michael Dawson --- BUILDING.md | 4 ++++ doc/contributing/pull-requests.md | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/BUILDING.md b/BUILDING.md index 54cdb1b0075913..d6ca30104b77f4 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -273,6 +273,10 @@ $ ./configure $ make -j4 ``` +We can speed up the builds by using [Ninja](https://ninja-build.org/). For more +information, see +[Building Node.js with Ninja](doc/contributing/building-node-with-ninja.md). + The `-j4` option will cause `make` to run 4 simultaneous compilation jobs which may reduce build time. For more information, see the [GNU Make Documentation](https://www.gnu.org/software/make/manual/html_node/Parallel.html). diff --git a/doc/contributing/pull-requests.md b/doc/contributing/pull-requests.md index 00868c4bfc91d9..bc0d072484897f 100644 --- a/doc/contributing/pull-requests.md +++ b/doc/contributing/pull-requests.md @@ -244,6 +244,10 @@ test suite. To run the tests (including code linting) on Unix / macOS: ./configure && make -j4 test ``` +We can speed up the builds by using [Ninja](https://ninja-build.org/). For more +information, see +[Building Node.js with Ninja](building-node-with-ninja.md). + And on Windows: ```text