Document current meaning of preferLocalBuild

Closes #208.
This commit is contained in:
Eelco Dolstra 2014-02-12 10:53:22 +01:00
parent 1f841c9d50
commit f9fc6acbf4

View file

@ -1740,12 +1740,15 @@ impureEnvVars = [ "http_proxy" "https_proxy" <replaceable>...</replaceable> ];
<varlistentry><term><varname>preferLocalBuild</varname></term> <varlistentry><term><varname>preferLocalBuild</varname></term>
<listitem><para>If this attribute is set to <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 linkend="chap-distributed-builds">distributed building is
enabled</link>, then, if possible, perform this build locally enabled</link>, then, if possible, the derivaton will be built
instead of forwarding it to a remote machine. This is appropriate locally instead of forwarded to a remote machine. This is
for trivial builders where the cost of doing a remote build would appropriate for trivial builders where the cost of doing a
exceed the cost of building locally.</para></listitem> download or remote build would exceed the cost of building
locally.</para></listitem>
</varlistentry> </varlistentry>