Skip to content

Commit

Permalink
doc: fix inconsistency in documentation for building
Browse files Browse the repository at this point in the history
Specifically, fix the inconsistency where the documentation
suggests running "$ make test" instead of "$ make -j4 test".
The "-j4" flag uses multiple processes, making the command
faster.

Fixes: #19919

PR-URL: #20091
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
  • Loading branch information
spwg authored and jasnell committed Apr 20, 2018
1 parent 1aa74cc commit 0b7e626
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,10 +179,10 @@ If you are running tests prior to submitting a Pull Request, the recommended
command is:

```console
$ make test
$ make -j4 test
```

`make test` does a full check on the codebase, including running linters and
`make -j4 test` does a full check on the codebase, including running linters and
documentation tests.

Optionally, continue below.
Expand Down

0 comments on commit 0b7e626

Please sign in to comment.