Skip to content

Commit

Permalink
doc: make building with ninja more discoverable
Browse files Browse the repository at this point in the history
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: #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>
  • Loading branch information
bavulapati authored and sxa committed Mar 7, 2022
1 parent d0f68a3 commit a32ec98
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
4 changes: 4 additions & 0 deletions BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
4 changes: 4 additions & 0 deletions doc/contributing/pull-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit a32ec98

Please sign in to comment.