diff options
Diffstat (limited to 'doc/guides/maintaining-the-build-files.md')
| -rw-r--r-- | doc/guides/maintaining-the-build-files.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/guides/maintaining-the-build-files.md b/doc/guides/maintaining-the-build-files.md index d36e827145..72b2318e63 100644 --- a/doc/guides/maintaining-the-build-files.md +++ b/doc/guides/maintaining-the-build-files.md @@ -8,17 +8,17 @@ On how to build the Node.js core, see [Building Node.js](../../BUILDING.md). There are three main build files that may be directly run when building Node.js: -- `configure`: A Python 2 script that detects system capabilities and runs +* `configure`: A Python 2 script that detects system capabilities and runs [GYP][]. It generates `config.gypi` which includes parameters used by GYP to create platform-dependent build files. Its output is usually in one of these formats: Makefile, MSbuild, ninja, or XCode project files (the main Makefile mentioned below is maintained separately by humans). For a detailed guide on this script, see [configure](#configure). -- `vcbuild.bat`: A Windows Batch Script that locates build tools, provides a +* `vcbuild.bat`: A Windows Batch Script that locates build tools, provides a subset of the targets available in the [Makefile](#makefile), and a few targets of its own. For a detailed guide on this script, see [vcbuild.bat](#vcbuildbat). -- `Makefile`: A Makefile that can be run with GNU Make. It provides a set of +* `Makefile`: A Makefile that can be run with GNU Make. It provides a set of targets that build and test the Node.js binary, produce releases and documentation, and interact with the CI to run benchmarks or tests. For a detailed guide on this file, see [Makefile](#makefile). @@ -45,7 +45,7 @@ maintained by humans. This is not usually run on Windows, where ### Options -- `-j <n>`: number of threads used to build the binary. On the non-CI +* `-j <n>`: number of threads used to build the binary. On the non-CI targets, the parallel tests will take up all the available cores, regardless of this option. |