improve parallel build instructions #2241
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Add an explicit example of how to use
make -j
to run a parallelbuilds, i.e.
make -j<N>
, or for example,make -j3
.The install instructions suggest using
make -j
for parallel builds butif this command is executed without a limit being provided to the
-j
option, it may lock up the machine it is being run on. For those not
familiar with the
-j
option it is a bit of a trap. Changing the examplecommand to show the use of the limit should prevent people who are
building this repo for the first time and unfamiliar with the
-j
optionfrom copy-pasting the command verbatim and making that mistake.
Checklist
Ranclang-format
v5.0.0 (viamake format
or the Visual Studio extension)CompilesRan all testsIf change impacts performance, include supporting evidence per the performance document