about summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorEelco Dolstra <eelco.dolstra@logicblox.com>2015-02-17T15·42+0100
committerEelco Dolstra <eelco.dolstra@logicblox.com>2015-02-17T15·42+0100
commitbd9106415099b32a51f66be886d18271e65ac9dd (patch)
treea2cf442a8c265fee174b817eef64d6cae0126159 /doc
parenta70d275f3d25f6e1eb1b6d528ee07ecd7265ada5 (diff)
Use $<attr>Path instead of $<attr> for passAsFile
Diffstat (limited to 'doc')
-rw-r--r--doc/manual/expressions/advanced-attributes.xml16
1 files changed, 11 insertions, 5 deletions
diff --git a/doc/manual/expressions/advanced-attributes.xml b/doc/manual/expressions/advanced-attributes.xml
index fee35f0bef48..83ad6eefc8b1 100644
--- a/doc/manual/expressions/advanced-attributes.xml
+++ b/doc/manual/expressions/advanced-attributes.xml
@@ -254,11 +254,17 @@ big = "a very long string";
     </programlisting>
 
     then when the builder runs, the environment variable
-    <envar>big</envar> will contain the absolute path to a temporary
-    file containing <literal>a very long string</literal>. This is
-    useful when you need to pass large strings to a builder, since
-    most operating systems impose a limit on the size of the
-    environment (typically, a few hundred kilobyte).</para></listitem>
+    <envar>bigPath</envar> will contain the absolute path to a
+    temporary file containing <literal>a very long
+    string</literal>. That is, for any attribute
+    <replaceable>x</replaceable> listed in
+    <varname>passAsFile</varname>, Nix will pass an environment
+    variable <envar><replaceable>x</replaceable>Path</envar> holding
+    the path of the file containing the value of attribute
+    <replaceable>x</replaceable>. This is useful when you need to pass
+    large strings to a builder, since most operating systems impose a
+    limit on the size of the environment (typically, a few hundred
+    kilobyte).</para></listitem>
 
   </varlistentry>