jaiden/lix
0
0
Fork 0
forked from lix-project/lix
Code Pull requests Activity

doc/manual: add note to allowSubstitutes advanced attribute

Browse source
This commit is contained in:
Profpatsch 2019-12-03 18:01:45 +01:00
parent e59e2b2951
commit 7395e091c5
1 changed files with 13 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
doc/manual/expressions/advanced-attributes.xml
View file

@ -325,12 +325,23 @@ big = "a very long string";
<varlistentry><term><varname>allowSubstitutes</varname></term> <varlistentry><term><varname>allowSubstitutes</varname></term>
<listitem><para>If this attribute is set to <listitem>
<para>If this attribute is set to
<literal>false</literal>, then Nix will always build this <literal>false</literal>, then Nix will always build this
derivation; it will not try to substitute its outputs. This is derivation; it will not try to substitute its outputs. This is
useful for very trivial derivations (such as useful for very trivial derivations (such as
<function>writeText</function> in Nixpkgs) that are cheaper to <function>writeText</function> in Nixpkgs) that are cheaper to
build than to substitute from a binary cache.</para></listitem> build than to substitute from a binary cache.</para>
<note><para>You need to have a builder configured which satisfies
the derivation’s <literal>system</literal> attribute, since the
derivation cannot be substituted. Thus it is usually a good idea
to align <literal>system</literal> with
<literal>builtins.currentSystem</literal> when setting
<literal>allowSubstitutes</literal> to <literal>false</literal>.
For most trivial derivations this should be the case.
</para></note>
</listitem>
</varlistentry> </varlistentry>