Skip to content

Commit 0e8596e

Browse files
joyeecheungevanlucas
authored andcommitted
doc: prefer make test-only when verifying the build
PR-URL: #18061 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]> Reviewed-By: Khaidi Chu <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]>
1 parent bbdc3c4 commit 0e8596e

File tree

1 file changed

+20
-3
lines changed

1 file changed

+20
-3
lines changed

BUILDING.md

+20-3
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ Depending on host platform, the selection of toolchains may vary.
9494

9595
### Unix/macOS
9696

97-
Prerequisites:
97+
#### Prerequisites
9898

9999
* `gcc` and `g++` 4.9.4 or newer, or
100100
* `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.
120120
On FreeBSD and OpenBSD, you may also need:
121121
* libexecinfo
122122

123+
#### Building Node.js
124+
123125
To build Node.js:
124126

125127
```console
@@ -138,13 +140,26 @@ for more information.
138140
Note that the above requires that `python` resolve to Python 2.6 or 2.7
139141
and not a newer version.
140142

141-
To run the tests:
143+
#### Running Tests
144+
145+
To verify the build:
146+
147+
```console
148+
$ make test-only
149+
```
150+
151+
At this point, you are ready to make code changes and re-run the tests.
152+
153+
If you are running tests prior to submitting a Pull Request, the recommended
154+
command is:
142155

143156
```console
144157
$ make test
145158
```
146159

147-
At this point you are ready to make code changes and re-run the tests!
160+
`make test` does a full check on the codebase, including running linters and
161+
documentation tests.
162+
148163
Optionally, continue below.
149164

150165
To run the tests and generate code coverage reports:
@@ -166,6 +181,8 @@ reports:
166181
$ make coverage-clean
167182
```
168183

184+
#### Building the documentation
185+
169186
To build the documentation:
170187

171188
This will build Node.js first (if necessary) and then use it to build the docs:

0 commit comments

Comments
 (0)