Date: Fri, 3 Nov 2017 15:15:03 +0000 (UTC) From: Mathieu Arnold <mat@FreeBSD.org> To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r51175 - head/en_US.ISO8859-1/books/porters-handbook/makefiles Message-ID: <201711031515.vA3FF3hK005969@repo.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: mat Date: Fri Nov 3 15:15:02 2017 New Revision: 51175 URL: https://svnweb.freebsd.org/changeset/doc/51175 Log: Add a variablelist with all the options helpers. Sponsored by: Absolight Modified: head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml Modified: head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml Fri Nov 3 15:15:00 2017 (r51174) +++ head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml Fri Nov 3 15:15:02 2017 (r51175) @@ -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>
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201711031515.vA3FF3hK005969>