os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Add a variablelist with all the options helpers.

Browse source 
Sponsored by:	Absolight
This commit is contained in:
Mathieu Arnold 2017-11-03 15:15:02 +00:00
parent f1c1e9281a
commit 34a38b937a
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=51175
1 changed files with 128 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

129
en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml
View file

@ -6010,7 +6010,134 @@ FOO_CONFIGURE_ENABLE= foo</programlisting>
<title>Options Helpers</title>
<para>There are some macros to help simplify conditional values
which differ based on the options set.</para>
which differ based on the options set. For easier access, a
list is provided in the list bellow:</para>
<variablelist xml:id="options-helpers-list">
<varlistentry>
<term><varname>PLIST_SUB</varname>,
<varname>SUB_LIST</varname></term>
<listitem>
<para>See <xref linkend="options_sub"/>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>CONFIGURE_ARGS</varname></term>
<listitem>
<para>For
<literal>--enable-<replaceable>x</replaceable></literal>
and
<literal>--disable-<replaceable>x</replaceable></literal>,
see <xref linkend="options-configure_enable"/>.</para>
<para>For
<literal>--with-<replaceable>x</replaceable></literal>
and
<literal>--without-<replaceable>x</replaceable></literal>,
see <xref linkend="options-configure_with"/>.</para>
<para>For all other cases, see <xref
linkend="options-configure_on"/>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>CMAKE_ARGS</varname></term>
<listitem>
<para>For arguments that are booleans
(<literal>on</literal>, <literal>off</literal>,
<literal>true</literal>, <literal>false</literal>,
<literal>0</literal>, <literal>1</literal>) see <xref
linkend="options-cmake_bool"/>.</para>
<para>For all other cases, see <xref
linkend="options-cmake_on"/>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>MESON_ARGS</varname></term>
<listitem>
<para>For arguments that take <literal>true</literal> or
<literal>false</literal>, see <xref
linkend="options-meson_true"/>.</para>
<para>For arguments that take <literal>yes</literal> or
<literal>no</literal>, use <xref
linkend="options-meson_yes"/>.</para>
<para>For all other cases, use <xref
linkend="options-meson_on"/>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>QMAKE_ARGS</varname></term>
<listitem>
<para>See <xref linkend="options-qmake_on"/>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>USE_<replaceable>*</replaceable></varname></term>
<listitem>
<para>See <xref linkend="options-use"/>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname><replaceable>*</replaceable>_DEPENDS</varname></term>
<listitem>
<para>See <xref linkend="options-dependencies"/>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>*</replaceable> (Any variable)</term>
<listitem>
<para>The most used variables have direct helpers, see
<xref linkend="options-variables"/>.</para>
<para>For any variable without a specific helper, see
<xref linkend="options-vars"/>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Options dependencies</term>
<listitem>
<para>When an option need another option to work, see
<xref linkend="options-implies"/>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Options conflicts</term>
<listitem>
<para>When an option cannot work if another is also
enabled, see <xref linkend="options-prevents"/>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Build targets</term>
<listitem>
<para>When an option need some extra processing, see <xref
linkend="options-targets"/>.</para>
</listitem>
</varlistentry>
</variablelist>
<sect3 xml:id="options_sub">
<title><varname>OPTIONS_SUB</varname></title>