summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorNikolay Amiantov <ab@fmap.me>2016-01-21 18:43:52 +0300
committerNikolay Amiantov <ab@fmap.me>2016-01-21 18:44:27 +0300
commitf727f815cb075f6ff466f8c8a02a275502709eec (patch)
tree9593448df8b9022589df1ade2724933fa8aad73f /doc
parentf63db297d6c411d058389da96aa34697ea531075 (diff)
downloadnixpkgs-f727f815cb075f6ff466f8c8a02a275502709eec.tar
nixpkgs-f727f815cb075f6ff466f8c8a02a275502709eec.tar.gz
nixpkgs-f727f815cb075f6ff466f8c8a02a275502709eec.tar.bz2
nixpkgs-f727f815cb075f6ff466f8c8a02a275502709eec.tar.lz
nixpkgs-f727f815cb075f6ff466f8c8a02a275502709eec.tar.xz
nixpkgs-f727f815cb075f6ff466f8c8a02a275502709eec.tar.zst
nixpkgs-f727f815cb075f6ff466f8c8a02a275502709eec.zip
nixpkgs manual: mention preferLocalBuild and enableParallelBuilding
Diffstat (limited to 'doc')
-rw-r--r--doc/stdenv.xml24
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/stdenv.xml b/doc/stdenv.xml
index 6bb1002a4c6..8df23c91152 100644
--- a/doc/stdenv.xml
+++ b/doc/stdenv.xml
@@ -224,6 +224,30 @@ genericBuild
 
 </variablelist>
 
+<variablelist>
+  <title>Variables affecting build properties</title>
+
+  <varlistentry>
+    <term><varname>enableParallelBuilding</varname></term>
+    <listitem><para>If set, <literal>stdenv</literal> will pass specific
+    flags to <literal>make</literal> and other build tools to enable
+    parallel building with up to <literal>build-cores</literal>
+    workers.</para></listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term><varname>preferLocalBuild</varname></term>
+    <listitem><para>If set, specifies that the package is so lightweight
+    in terms of build operations (e.g. write a text file from a Nix string
+    to the store) that there's no need to look for it in binary caches --
+    it's faster to just build it locally. It also tells Hydra and other
+    facilities that this package doesn't need to be exported in binary
+    caches (noone would use it, after all).</para></listitem>
+  </varlistentry>
+
+</variablelist>
+
+
 </section>