Skip to content

Commit 98579de

Browse files
joyeecheungMylesBorins
authored andcommitted
doc: prefer make test-only when verifying the build
PR-URL: #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>
1 parent f7e6fe2 commit 98579de

File tree

1 file changed

+20
-3
lines changed

1 file changed

+20
-3
lines changed

BUILDING.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ Depending on host platform, the selection of toolchains may vary.
9595

9696
### Unix / macOS
9797

98-
Prerequisites:
98+
#### Prerequisites
9999

100100
* `gcc` and `g++` 4.9.4 or newer, or
101101
* `clang` and `clang++` 3.4.2 or newer (macOS: latest Xcode Command Line Tools)
@@ -121,6 +121,8 @@ directory and the symbolic `node` link in the project's root directory.
121121
On FreeBSD and OpenBSD, you may also need:
122122
* libexecinfo
123123

124+
#### Building Node.js
125+
124126
To build Node.js:
125127

126128
```console
@@ -139,13 +141,26 @@ for more information.
139141
Note that the above requires that `python` resolve to Python 2.6 or 2.7
140142
and not a newer version.
141143

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

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

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

151166
To run the tests and generate code coverage reports:
@@ -167,6 +182,8 @@ reports:
167182
$ make coverage-clean
168183
```
169184

185+
#### Building the documentation
186+
170187
To build the documentation:
171188

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

0 commit comments

Comments
 (0)