Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve parallel build instructions #2241

Merged
merged 1 commit into from
Aug 21, 2019
Merged

improve parallel build instructions #2241

merged 1 commit into from
Aug 21, 2019

Conversation

leighmcculloch
Copy link
Member

Description

Add an explicit example of how to use make -j to run a parallel
builds, i.e. make -j<N>, or for example, make -j3.

The install instructions suggest using make -j for parallel builds but
if 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 example
command to show the use of the limit should prevent people who are
building this repo for the first time and unfamiliar with the -j option
from copy-pasting the command verbatim and making that mistake.

Checklist

  • Reviewed the contributing document
  • Rebased on top of master (no merge commits)
  • Ran clang-format v5.0.0 (via make format or the Visual Studio extension)
  • Compiles
  • Ran all tests
  • If change impacts performance, include supporting evidence per the performance document

Add an explicit example of how to use `make -j` to run a parallel
builds, i.e. `make -j<N>`, or for example, `make -j3`.

The install instructions suggest using `make -j` for parallel builds but
if 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
example command to show the use of the limit should prevent folks new to
building this repo and unfamiliar with the `-j` option from making that
mistake.
@MonsieurNicolas MonsieurNicolas merged commit dfc8a03 into stellar:master Aug 21, 2019
@leighmcculloch leighmcculloch deleted the readme-make-j-example-with-N branch August 21, 2019 20:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants