about summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorEelco Dolstra <eelco.dolstra@logicblox.com>2014-02-12T09·53+0100
committerEelco Dolstra <eelco.dolstra@logicblox.com>2014-02-12T09·53+0100
commitf9fc6acbf4eadd2d9018d3da14394fdfbddde5f6 (patch)
tree5b8c88d5cbe2d117210fb06d2fb1ab600314393c /doc
parent1f841c9d50a100a3d40fec6260d36ec9ee309af3 (diff)
Document current meaning of preferLocalBuild
Closes #208.
Diffstat (limited to 'doc')
-rw-r--r--doc/manual/writing-nix-expressions.xml13
1 files changed, 8 insertions, 5 deletions
diff --git a/doc/manual/writing-nix-expressions.xml b/doc/manual/writing-nix-expressions.xml
index 3e6cd7379015..c5b355ea0469 100644
--- a/doc/manual/writing-nix-expressions.xml
+++ b/doc/manual/writing-nix-expressions.xml
@@ -1740,12 +1740,15 @@ impureEnvVars = [ "http_proxy" "https_proxy" <replaceable>...</replaceable> ];
   <varlistentry><term><varname>preferLocalBuild</varname></term>
 
     <listitem><para>If this attribute is set to
-    <literal>true</literal> and <link
+    <literal>true</literal>, it has two effects.  First, the
+    derivation will always be built, not substituted, even if a
+    substitute is available.  Second, if <link
     linkend="chap-distributed-builds">distributed building is
-    enabled</link>, then, if possible, perform this build locally
-    instead of forwarding it to a remote machine.  This is appropriate
-    for trivial builders where the cost of doing a remote build would
-    exceed the cost of building locally.</para></listitem>
+    enabled</link>, then, if possible, the derivaton will be built
+    locally instead of forwarded to a remote machine.  This is
+    appropriate for trivial builders where the cost of doing a
+    download or remote build would exceed the cost of building
+    locally.</para></listitem>
 
   </varlistentry>