2017-11-12 20:54:43 +01:00
|
|
|
# Maintaining the Build files
|
|
|
|
|
|
|
|
|
|
This document explains how to maintain the build files in the codebase.
|
|
|
|
|
|
|
|
|
|
## Overview
|
|
|
|
|
|
|
|
|
|
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
|
|
|
|
|
[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
|
2018-10-26 18:27:40 +02:00
|
|
|
formats: Makefile, MSbuild, ninja, or XCode project files (the main
|
2017-11-12 20:54:43 +01:00
|
|
|
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
|
2018-02-12 08:31:55 +01:00
|
|
|
subset of the targets available in the [Makefile](#makefile), and a few
|
|
|
|
|
targets of its own. For a detailed guide on this script, see
|
2018-10-02 06:38:04 +02:00
|
|
|
[vcbuild.bat](#vcbuildbat).
|
2017-11-12 20:54:43 +01:00
|
|
|
- `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).
|
|
|
|
|
|
|
|
|
|
On Windows `vcbuild.bat` runs [configure](#configure) before building the
|
|
|
|
|
Node.js binary, on other systems `configure` must be run manually before running
|
|
|
|
|
`make` on the `Makefile`.
|
|
|
|
|
|
|
|
|
|
## vcbuild.bat
|
|
|
|
|
|
|
|
|
|
To see the help text, run `.\vcbuild help`. Update this file when you need to
|
|
|
|
|
update the build and testing process on Windows.
|
|
|
|
|
|
|
|
|
|
## configure
|
|
|
|
|
|
|
|
|
|
To see the help text, run `python configure --help`. Update this file when you
|
|
|
|
|
need to update the configuration process.
|
|
|
|
|
|
|
|
|
|
## Makefile
|
|
|
|
|
|
|
|
|
|
To see the help text, run `make help`. This file is not generated, it is
|
2019-06-20 21:29:37 +02:00
|
|
|
maintained by humans. This is not usually run on Windows, where
|
2018-10-02 06:38:04 +02:00
|
|
|
[vcbuild.bat](#vcbuildbat) is used instead.
|
2017-11-12 20:54:43 +01:00
|
|
|
|
|
|
|
|
### Options
|
|
|
|
|
|
2019-06-20 21:29:37 +02:00
|
|
|
- `-j <n>`: number of threads used to build the binary. On the non-CI
|
2017-11-12 20:54:43 +01:00
|
|
|
targets, the parallel tests will take up all the available cores, regardless
|
|
|
|
|
of this option.
|
|
|
|
|
|
|
|
|
|
[GYP]: https://gyp.gsrc.io/docs/UserDocumentation.md
|
