summary refs log tree commit diff
path: root/doc/stdenv.xml
diff options
context:
space:
mode:
authorOrivej Desh <orivej@gmx.fr>2017-12-03 06:42:25 +0000
committerOrivej Desh <orivej@gmx.fr>2017-12-07 08:52:42 +0000
commit683047f8ab449388859c3982bd366cfbc2787ee2 (patch)
tree3666509bd127b58c2dbc346a24f8b033f1733979 /doc/stdenv.xml
parentf568450637a22529c2eae97bee0adaf71ea96ac8 (diff)
downloadnixlib-683047f8ab449388859c3982bd366cfbc2787ee2.tar
nixlib-683047f8ab449388859c3982bd366cfbc2787ee2.tar.gz
nixlib-683047f8ab449388859c3982bd366cfbc2787ee2.tar.bz2
nixlib-683047f8ab449388859c3982bd366cfbc2787ee2.tar.lz
nixlib-683047f8ab449388859c3982bd366cfbc2787ee2.tar.xz
nixlib-683047f8ab449388859c3982bd366cfbc2787ee2.tar.zst
nixlib-683047f8ab449388859c3982bd366cfbc2787ee2.zip
doc: document enableParallelBuilding being unset
Diffstat (limited to 'doc/stdenv.xml')
-rw-r--r--doc/stdenv.xml15
1 files changed, 11 insertions, 4 deletions
diff --git a/doc/stdenv.xml b/doc/stdenv.xml
index 46b562a794f0..ee3403c196a4 100644
--- a/doc/stdenv.xml
+++ b/doc/stdenv.xml
@@ -251,10 +251,17 @@ genericBuild
 
   <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>
+    <listitem>
+      <para>If set to <literal>true</literal>, <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>
+
+      <para>Unless set to <literal>false</literal>, some build systems with good
+      support for parallel building including <literal>cmake</literal>,
+      <literal>meson</literal>, and <literal>qmake</literal> will set it to
+      <literal>true</literal>.</para>
+    </listitem>
   </varlistentry>
 
   <varlistentry>