summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorworldofpeace <worldofpeace@protonmail.ch>2019-08-05 21:53:07 -0400
committerworldofpeace <worldofpeace@protonmail.ch>2019-09-17 21:33:57 -0400
commitc8c01e2a9566008055a6374e5795f90c3b090898 (patch)
treea442b00feae21b9b82b7c65babf14483cf088670 /doc
parent44808beb7dbc7a7198028f646fe74f36b972742c (diff)
doc/stdenv: document meson variables
(cherry picked from commit cd518845e2ca008f5a00b38ffa0f1c99f154f6cc)
Diffstat (limited to 'doc')
-rw-r--r--doc/stdenv.xml73
1 files changed, 67 insertions, 6 deletions
diff --git a/doc/stdenv.xml b/doc/stdenv.xml
index 16003fb4acfbe..cd65035e2fc49 100644
--- a/doc/stdenv.xml
+++ b/doc/stdenv.xml
@@ -2806,17 +2806,78 @@ postInstall = ''
     </varlistentry>
     <varlistentry>
      <term>
-      meson
+      Meson
      </term>
      <listitem>
       <para>
-       Overrides the configure phase to run meson to generate Ninja files. You
-       can disable this behavior by setting configurePhase to a custom value,
-       or by setting dontUseMesonConfigure. To run these files, you should
-       accompany meson with ninja. mesonFlags controls only the flags passed to
-       meson. By default, parallel building is enabled as Meson supports
+       Overrides the configure phase to run meson to generate Ninja files. To
+       run these files, you should accompany Meson with ninja. By default,
+       <varname>enableParallelBuilding</varname> is enabled as Meson supports
        parallel building almost everywhere.
       </para>
+      <variablelist>
+       <title>Variables controlling Meson</title>
+       <varlistentry>
+        <term>
+         <varname>mesonFlags</varname>
+        </term>
+        <listitem>
+         <para>
+          Controls the flags passed to meson.
+         </para>
+        </listitem>
+       </varlistentry>
+       <varlistentry>
+        <term>
+         <varname>mesonBuildType</varname>
+        </term>
+        <listitem>
+         <para>
+          Which
+          <link
+          xlink:href="https://mesonbuild.com/Builtin-options.html#core-options"><command>--buildtype</command></link>
+          to pass to Meson. We default to <literal>plain</literal>.
+         </para>
+        </listitem>
+       </varlistentry>
+       <varlistentry>
+        <term>
+         <varname>mesonAutoFeatures</varname>
+        </term>
+        <listitem>
+         <para>
+          What value to set
+          <link
+          xlink:href="https://mesonbuild.com/Builtin-options.html#core-options"><command>-Dauto_features=</command></link>
+          to. We default to <command>enabled</command>.
+         </para>
+        </listitem>
+       </varlistentry>
+       <varlistentry>
+        <term>
+         <varname>mesonWrapMode</varname>
+        </term>
+        <listitem>
+         <para>
+          What value to set
+          <link
+          xlink:href="https://mesonbuild.com/Builtin-options.html#core-options"><command>-Dwrap_mode=</command></link>
+          to. We default to <command>nodownload</command> as we disallow
+          network access.
+         </para>
+        </listitem>
+       </varlistentry>
+       <varlistentry>
+        <term>
+         <varname>dontUseMesonConfigure</varname>
+        </term>
+        <listitem>
+         <para>
+          Disables using Meson's <varname>configurePhase</varname>.
+         </para>
+        </listitem>
+       </varlistentry>
+      </variablelist>
      </listitem>
     </varlistentry>
     <varlistentry>