Skip to content

Commit

Permalink
doc: removed number of jobs from -j option when running make
Browse files Browse the repository at this point in the history
Removing specified number of jobs from -j option in the documentation
steps for running the make command. A '-j' without a number specified
will use the maximum number allowed for any given machine.
Fixes: nodejs#8286
  • Loading branch information
thecoolestguy committed Aug 26, 2016
1 parent a6d53c6 commit b13a841
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Contributors guide: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md
##### Checklist
<!-- Remove items that do not apply. For completed items, change [ ] to [x]. -->

- [ ] `make -j4 test` (UNIX), or `vcbuild test nosign` (Windows) passes
- [ ] `make -j test` (UNIX), or `vcbuild test nosign` (Windows) passes
- [ ] tests and/or benchmarks are included
- [ ] documentation is changed or added
- [ ] commit message follows commit guidelines
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ to see how they should be structured can also help.
To run the tests on Unix / OS X:

```text
$ ./configure && make -j8 test
$ ./configure && make -j test
```

Windows:
Expand Down Expand Up @@ -178,7 +178,7 @@ You can run tests directly with node:
$ ./node ./test/parallel/test-stream2-transform.js
```

Remember to recompile with `make -j8` in between test runs if you change
Remember to recompile with `make -j` in between test runs if you change
core modules.

### Step 6: Push
Expand Down
2 changes: 1 addition & 1 deletion doc/guides/building-node-with-ninja.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ ninja: Entering directory `out/Release`

The bottom line will change while building, showing the progress as `[finished/total]` build steps.
This is useful output that `make` does not produce and is one of the benefits of using Ninja.
Also, Ninja will likely compile much faster than even `make -j8` (or `-j<number of processor threads on your machine>`).
Also, Ninja will likely compile much faster than even `make -j` (or `-j<number of processor threads on your machine>`).

## Considerations

Expand Down
2 changes: 1 addition & 1 deletion doc/onboarding-extras.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Please use these when possible / appropriate
* major vs. everything else: run last versions tests against this version, if they pass, **probably** minor or patch
* A breaking change helper ([full source](https://gist.github.com/chrisdickinson/ba532fa0e4e243fb7b44)):
```sh
git checkout $(git show -s --pretty='%T' $(git show-ref -d $(git describe --abbrev=0) | tail -n1 | awk '{print $1}')) -- test; make -j8 test
git checkout $(git show -s --pretty='%T' $(git show-ref -d $(git describe --abbrev=0) | tail -n1 | awk '{print $1}')) -- test; make -j test
```


Expand Down
2 changes: 1 addition & 1 deletion doc/onboarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ Landing a PR
* if it all looks good, `curl -L 'url-of-pr.patch' | git am`
* `git rebase -i upstream/master`
* squash into logical commits if necessary
* `./configure && make -j8 test` (`-j8` builds node in parallel with 8 threads. adjust to the number of cores (or processor-level threads) your processor has (or slightly more) for best results.)
* `./configure && make -j test` (`-j` sets the number of jobs that run simultaneously for the make command. To adjust the number of simultaneous jobs, specify a number immediately after '-j' (e.g., '-j8' for 8 jobs, '-j4' for 4 simultaneous jobs)
* Amend the commit description
* commits should follow `subsystem[,subsystem]: small description\n\nbig description\n\n<metadata>`
* first line 50 columns, all others 72
Expand Down

0 comments on commit b13a841

Please sign in to comment.