Skip to content

docs: document balancing cores and max-jobs#2749

Merged
edolstra merged 1 commit intoNixOS:masterfrom
grahamc:docs-cores-max-jobs
Jul 19, 2019
Merged

docs: document balancing cores and max-jobs#2749
edolstra merged 1 commit intoNixOS:masterfrom
grahamc:docs-cores-max-jobs

Conversation

@grahamc
Copy link
Copy Markdown
Member

@grahamc grahamc commented Mar 28, 2019

Write a bit about the balance between max-jobs and cores.

<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.)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will attempt to do no build -> will do no builds.

<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.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"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.

</tbody>
</table>

<para>It is up to the derivations' build scirpt to respect
Copy link
Copy Markdown
Member

@edolstra edolstra Mar 29, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

scirpt -> script.

@jonringer
Copy link
Copy Markdown
Contributor

ping @grahamc

I still think this is really valuable, and would love to have it in the manual :)

@grahamc grahamc force-pushed the docs-cores-max-jobs branch from a9e32d3 to 3601b8a Compare July 18, 2019 23:56
@grahamc
Copy link
Copy Markdown
Member Author

grahamc commented Jul 18, 2019

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

Copy link
Copy Markdown
Contributor

@jonringer jonringer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Even though English is my first language, i still struggle greatly with it as well :).

Looks good to me, except i think there's an extra newline added accidentally.

<xi:include href="cores-vs-jobs.xml" />
<xi:include href="diff-hook.xml" />


Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Extra white space? I don't see 2 newlines anywhere else.

Suggested change

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Fixed up!

@grahamc grahamc force-pushed the docs-cores-max-jobs branch from e92c925 to b33b434 Compare July 19, 2019 00:24
@grahamc grahamc force-pushed the docs-cores-max-jobs branch from b33b434 to cf6172f Compare July 19, 2019 12:28
@edolstra edolstra merged commit 1bace40 into NixOS:master Jul 19, 2019
@grahamc grahamc deleted the docs-cores-max-jobs branch July 19, 2019 12:40
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.

3 participants