1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: prefer make test-only when verifying the build

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/18061
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
This commit is contained in:
Joyee Cheung 2018-01-09 19:34:11 +08:00
parent c893f488c3
commit e8c491a801
No known key found for this signature in database
GPG Key ID: F586868AAD831D0C
1 changed files with 20 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
BUILDING.md
View File

@ -94,7 +94,7 @@ Depending on host platform, the selection of toolchains may vary.
### Unix/macOS ### Unix/macOS
Prerequisites: #### Prerequisites
* `gcc` and `g++` 4.9.4 or newer, or * `gcc` and `g++` 4.9.4 or newer, or
* `clang` and `clang++` 3.4.2 or newer (macOS: latest Xcode Command Line Tools) * `clang` and `clang++` 3.4.2 or newer (macOS: latest Xcode Command Line Tools)
@ -120,6 +120,8 @@ directory and the symbolic `node` link in the project's root directory.
On FreeBSD and OpenBSD, you may also need: On FreeBSD and OpenBSD, you may also need:
* libexecinfo * libexecinfo
#### Building Node.js
To build Node.js: To build Node.js:
```console ```console
@ -138,13 +140,26 @@ for more information.
Note that the above requires that `python` resolve to Python 2.6 or 2.7 Note that the above requires that `python` resolve to Python 2.6 or 2.7
and not a newer version. and not a newer version.
To run the tests: #### Running Tests
To verify the build:
```console
$ make test-only
```
At this point, you are ready to make code changes and re-run the tests.
If you are running tests prior to submitting a Pull Request, the recommended
command is:
```console ```console
$ make test $ make test
``` ```
At this point you are ready to make code changes and re-run the tests! `make test` does a full check on the codebase, including running linters and
documentation tests.
Optionally, continue below. Optionally, continue below.
To run the tests and generate code coverage reports: To run the tests and generate code coverage reports:
@ -166,6 +181,8 @@ reports:
$ make coverage-clean $ make coverage-clean
``` ```
#### Building the documentation
To build the documentation: To build the documentation:
This will build Node.js first (if necessary) and then use it to build the docs: This will build Node.js first (if necessary) and then use it to build the docs: