Skip to content

Commit

Permalink
docs: Mention --max-jobs 0 to build remotely only
Browse files Browse the repository at this point in the history
  • Loading branch information
nh2 committed Mar 31, 2019
1 parent f32fbf9 commit caa76c3
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
3 changes: 3 additions & 0 deletions doc/manual/advanced-topics/distributed-builds.xml
Expand Up @@ -184,4 +184,7 @@ to be included. (This is the default.)</para>
the option <link linkend='conf-builders-use-substitutes'><literal>builders-use-substitutes</literal></link>
in your local <filename>nix.conf</filename>.</para>

<para>To build only on remote builders and disable building on the local machine,
you can use the option <option>--max-jobs 0</option>.</para>

</chapter>
12 changes: 10 additions & 2 deletions doc/manual/command-ref/opt-common.xml
Expand Up @@ -107,14 +107,22 @@
<varlistentry xml:id="opt-max-jobs"><term><option>--max-jobs</option> / <option>-j</option>
<replaceable>number</replaceable></term>

<listitem><para>Sets the maximum number of build jobs that Nix will
<listitem>

<para>Sets the maximum number of build jobs that Nix will
perform in parallel to the specified number. Specify
<literal>auto</literal> to use the number of CPUs in the system.
The default is specified by the <link
linkend='conf-max-jobs'><literal>max-jobs</literal></link>
configuration setting, which itself defaults to
<literal>1</literal>. A higher value is useful on SMP systems or to
exploit I/O latency.</para></listitem>
exploit I/O latency.</para>

<para> Setting it to <literal>0</literal> disallows building on the local
machine, which is useful when you want builds to happen only on remote
builders.</para>

</listitem>

</varlistentry>

Expand Down

0 comments on commit caa76c3

Please sign in to comment.