aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNiklas Hambüchen <mail@nh2.me>2019-03-31 03:47:43 +0200
committerNiklas Hambüchen <mail@nh2.me>2019-03-31 03:57:45 +0200
commitcaa76c369a6d77eb3ccaa14bd8144581c8cd50a7 (patch)
treef050f3cfc47481f6b653bdfb83662adfbc262935
parentf32fbf952d8eb15963da65a162da169de72f36fa (diff)
docs: Mention `--max-jobs 0` to build remotely only
-rw-r--r--doc/manual/advanced-topics/distributed-builds.xml3
-rw-r--r--doc/manual/command-ref/opt-common.xml12
2 files changed, 13 insertions, 2 deletions
diff --git a/doc/manual/advanced-topics/distributed-builds.xml b/doc/manual/advanced-topics/distributed-builds.xml
index ce2e077ed..9ac4a92cd 100644
--- a/doc/manual/advanced-topics/distributed-builds.xml
+++ b/doc/manual/advanced-topics/distributed-builds.xml
@@ -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>
diff --git a/doc/manual/command-ref/opt-common.xml b/doc/manual/command-ref/opt-common.xml
index 4c572e129..b8a2f260e 100644
--- a/doc/manual/command-ref/opt-common.xml
+++ b/doc/manual/command-ref/opt-common.xml
@@ -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>