docs: document balancing cores and max-jobs #2749
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
10 tasks
edolstra
reviewed
Mar 29, 2019
| <listitem><para> | ||
| Dictates how many separate derivations will be built at the same | ||
| time. If you set this to zero, the local machine will attempt to | ||
| do no builds (forcing it to be built remotely.) |
There was a problem hiding this comment.
will attempt to do no build -> will do no builds.
edolstra
reviewed
Mar 29, 2019
| <listitem><para> | ||
| Dictates how many cores each derivation is allowed to use. If | ||
| you set this to zero, the builds will be given access to all the | ||
| cores of your system. |
There was a problem hiding this comment.
"Dictates" -> "suggests" (and drop the second sentence). There is nothing that stops a derivation from using more cores. In practice, the "cores" option translates to GNU Make's -j <cores> flag.
edolstra
reviewed
Mar 29, 2019
| </tbody> | ||
| </table> | ||
|
|
||
| <para>It is up to the derivations' build scirpt to respect |
|
ping @grahamc I still think this is really valuable, and would love to have it in the manual :) |
grahamc
force-pushed
the
docs-cores-max-jobs
branch
from
a9e32d3
to
3601b8a
Compare
|
Thanks @jonringer, I've updated the docs and addressed @edolstra's feedback. Would you might giving it a read for mistakes? I have a tendency to make silly mistakes :x |
jonringer
approved these changes
Jul 19, 2019
| <xi:include href="diff-hook.xml" /> | ||
|
|
||
|
|
There was a problem hiding this comment.
Extra white space? I don't see 2 newlines anywhere else.
Suggested change
grahamc
force-pushed
the
docs-cores-max-jobs
branch
from
e92c925
to
b33b434
Compare
grahamc
force-pushed
the
docs-cores-max-jobs
branch
from
b33b434
to
cf6172f
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Write a bit about the balance between max-jobs and cores.