summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBalakrishna Avulapati <bavulapati@gmail.com>2022-02-25 08:50:41 +0530
committerDanielle Adams <adamzdanielle@gmail.com>2022-04-23 22:47:04 -0400
commita70a1ce3a95dac0bf3261071265c6b93fbe87ee3 (patch)
tree9089ff5428f5b0bd4ccc559afac2cbd3cb3234a9
parent978b50fe4490e0072c19a76a56402ca123d0bb5b (diff)
downloadnode-new-a70a1ce3a95dac0bf3261071265c6b93fbe87ee3.tar.gz
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 <rtrott@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Mestery <mestery@protonmail.com> Reviewed-By: Filip Skokan <panva.ip@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com>
-rw-r--r--BUILDING.md4
-rw-r--r--doc/contributing/pull-requests.md4
2 files changed, 8 insertions, 0 deletions
diff --git a/BUILDING.md b/BUILDING.md
index 54cdb1b007..d6ca30104b 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 00868c4bfc..bc0d072484 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