Gecko [ unitednationsplay.com ]

Name	Size	Permission	Date
contributing	[ DIR ]	drwxr-xr-x	2022-01-26 16:43
doc_img	[ DIR ]	drwxr-xr-x	2022-01-26 16:43
adding-new-napi-api.md	2.55 KB	-rw-r--r--	2022-01-10 13:06
backporting-to-release-lines.md	4.38 KB	-rw-r--r--	2022-01-10 13:06
building-node-with-ninja.md	1.42 KB	-rw-r--r--	2022-01-10 13:06
collaborator-guide.md	40.27 KB	-rw-r--r--	2022-01-10 13:06
commit-queue.md	5.4 KB	-rw-r--r--	2022-01-10 13:06
cpp-style-guide.md	12.79 KB	-rw-r--r--	2022-01-10 13:06
diagnostic-tooling-support-tiers.md	8.66 KB	-rw-r--r--	2022-01-10 13:06
doc-style-guide.md	5.72 KB	-rw-r--r--	2022-01-10 13:06
internal-api.md	539 B	-rw-r--r--	2022-01-10 13:06
investigating_native_memory_leak.md	26.95 KB	-rw-r--r--	2022-01-10 13:06
maintaining-V8.md	17.66 KB	-rw-r--r--	2022-01-10 13:06
maintaining-c-ares.md	1.63 KB	-rw-r--r--	2022-01-10 13:06
maintaining-icu.md	8.27 KB	-rw-r--r--	2022-01-10 13:06
maintaining-npm.md	1.2 KB	-rw-r--r--	2022-01-10 13:06
maintaining-openssl.md	3.82 KB	-rw-r--r--	2022-01-10 13:06
maintaining-root-certs.md	3.57 KB	-rw-r--r--	2022-01-10 13:06
maintaining-the-build-files.md	2.39 KB	-rw-r--r--	2022-01-10 13:06
maintaining-zlib.md	892 B	-rw-r--r--	2022-01-10 13:06
node-postmortem-support.md	2.53 KB	-rw-r--r--	2022-01-10 13:06
offboarding.md	727 B	-rw-r--r--	2022-01-10 13:06
releases.md	34.1 KB	-rw-r--r--	2022-01-10 13:06
security-release-process.md	5.99 KB	-rw-r--r--	2022-01-10 13:06
strategic-initiatives.md	2.93 KB	-rw-r--r--	2022-01-10 13:06
technical-values.md	2.77 KB	-rw-r--r--	2022-01-10 13:06
using-internal-errors.md	4.9 KB	-rw-r--r--	2022-01-10 13:06
using-symbols.md	2.31 KB	-rw-r--r--	2022-01-10 13:06
writing-and-running-benchmarks.md	22.76 KB	-rw-r--r--	2022-01-10 13:06
writing-tests.md	15.83 KB	-rw-r--r--	2022-01-10 13:06

Rename

# 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
  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
  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
  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

The `configure` script recognizes many CLI flags for special build formulas.
Many are not represented by `vcbuild` shortcuts, and need to be passed
either by:

* Calling `python configure --XXX --YYY=PPPP` directly, followed by `vcbuild
  noprojgen`
* Setting `set config_flags=--XXX --YYY=PPPP` before calling `vcbuild`

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
maintained by humans. This is not usually run on Windows, where
[vcbuild.bat](#vcbuildbat) is used instead.

### Options

* `-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.

[GYP]: https://gyp.gsrc.io/docs/UserDocumentation.md