Date: Fri, 30 Jan 2015 18:11:27 +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: r46244 - head/en_US.ISO8859-1/books/porters-handbook/makefiles Message-ID: <201501301811.t0UIBRGi082808@svn.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: mat (ports committer) Date: Fri Jan 30 18:11:26 2015 New Revision: 46244 URL: https://svnweb.freebsd.org/changeset/doc/46244 Log: Catch up with options changes. Various sentence rearranging and rewording. Differential Revision: https://reviews.freebsd.org/D1599 Approved by: wblock 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 Jan 30 08:25:47 2015 (r46243) +++ head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml Fri Jan 30 18:11:26 2015 (r46244) @@ -3711,6 +3711,7 @@ SSL_DESC= Build with OpenSSL support OPTIONS_DEFAULT= PGSQL LDAP SSL +# Will add USE_PGSQL=yes PGSQL_USE= pgsql=yes # Will add --enable-postgres / --disable-postgres PGSQL_CONFIGURE_ENABLE= postgres @@ -3856,16 +3857,17 @@ SUB_LIST+= OPT1="@comment " NO_OPT1="" <sect3 xml:id="options-use"> <title><varname><replaceable>OPT</replaceable>_USE</varname></title> - <para>For each + <para>When option <replaceable>OPT</replaceable> is selected, + for each <literal><replaceable>key</replaceable>=<replaceable>value</replaceable></literal> pair in - <varname><replaceable>OPT</replaceable>_USE</varname> the + <varname><replaceable>OPT</replaceable>_USE</varname>, + <replaceable>value</replaceable> is appended to the corresponding - <varname>USE_<replaceable>KEY</replaceable></varname> - will be set to <replaceable>value</replaceable>. - If <replaceable>value</replaceable> has spaces in it, - replace them with commas, they will be changed back to - spaces during processing. For example:</para> + <varname>USE_<replaceable>KEY</replaceable></varname>. If + <replaceable>value</replaceable> has spaces in it, replace + them with commas and they will be changed back to spaces + during processing. For example:</para> <programlisting>OPTIONS_DEFINE= OPT1 OPT1_USE= mysql=yes xorg=x11,xextproto,xext,xrandr</programlisting> @@ -3882,22 +3884,56 @@ USE_XORG= x11 xextproto xext xrandr .endif</programlisting> </sect3> + <sect3 xml:id="options-use-off"> + <title><varname><replaceable>OPT</replaceable>_USE_OFF</varname></title> + + <para>When option <replaceable>OPT</replaceable> <emphasis>is + not</emphasis> selected, for each + <literal><replaceable>key</replaceable>=<replaceable>value</replaceable></literal> + pair in + <varname><replaceable>OPT</replaceable>_USE_OFF</varname>, + <replaceable>value</replaceable> is appended to the + corresponding + <varname>USE_<replaceable>KEY</replaceable></varname>. If + <replaceable>value</replaceable> has spaces in it, replace + them with commas and they will be changed back to spaces + during processing. For example:</para> + + <programlisting>OPTIONS_DEFINE= OPT1 +OPT1_USE_OFF= mysql=yes xorg=x11,xextproto,xext,xrandr</programlisting> + + <para>is equivalent to:</para> + + <programlisting>OPTIONS_DEFINE= OPT1 + +.include <bsd.port.options.mk> + +.if ! ${PORT_OPTIONS:MOPT1} +USE_MYSQL= yes +USE_XORG= x11 xextproto xext xrandr +.endif</programlisting> + </sect3> + <sect3 xml:id="options-configure_enable"> <title><varname><replaceable>OPT</replaceable>_CONFIGURE_ENABLE</varname></title> - <para>If + <para>When option <replaceable>OPT</replaceable> is selected, + for each <replaceable>entry</replaceable> in <varname><replaceable>OPT</replaceable>_CONFIGURE_ENABLE</varname> - is set then - <literal>--enable-${<replaceable>OPT</replaceable>_CONFIGURE_ENABLE}</literal> - or - <literal>--disable-${<replaceable>OPT</replaceable>_CONFIGURE_ENABLE}</literal> - will be added to <varname>CONFIGURE_ARGS</varname> depending - on the value of the option - <literal><replaceable>OPT</replaceable></literal>, for - example:</para> + then + <literal>--enable-<replaceable>entry</replaceable></literal> + is appended to <varname>CONFIGURE_ARGS</varname>. When option + <replaceable>OPT</replaceable> is not selected, + <literal>--disable-<replaceable>entry</replaceable></literal> + is appended to <varname>CONFIGURE_ARGS</varname>. An optional + argument can be specified with an <literal>=</literal> + symbol. This argument is only appended to the + <literal>--enable-<replaceable>entry</replaceable></literal> + configure option. For example:</para> - <programlisting>OPTIONS_DEFINE= OPT1 -OPT1_CONFIGURE_ENABLE= test</programlisting> + <programlisting>OPTIONS_DEFINE= OPT1 OPT2 +OPT1_CONFIGURE_ENABLE= test1 test2 +OPT2_CONFIGURE_ENABLE= test2=exhaustive</programlisting> <para>is equivalent to:</para> @@ -3906,33 +3942,38 @@ OPT1_CONFIGURE_ENABLE= test</programlist .include <bsd.port.options.mk> .if ${PORT_OPTIONS:MOPT1} -CONFIGURE_ARGS+= --enable-test +CONFIGURE_ARGS+= --enable-test1 --enable-test2 .else -CONFIGURE_ARGS+= --disable-test +CONFIGURE_ARGS+= --disable-test1 --disable-test2 +.endif + +.if ${PORT_OPTIONS:MOPT2} +CONFIGURE_ARGS+= --enable-test2=exhaustive +.else +CONFIGURE_ARGS+= --disable-test2 .endif</programlisting> </sect3> <sect3 xml:id="options-configure_with"> <title><varname><replaceable>OPT</replaceable>_CONFIGURE_WITH</varname></title> - <para>If - <varname><replaceable>OPT</replaceable>_CONFIGURE_WITH</varname> - is set then - <literal>--with-${<replaceable>OPT</replaceable>_CONFIGURE_WITH}</literal> - or - <literal>--without-${<replaceable>OPT</replaceable>_CONFIGURE_WITH}</literal> - will be added to <varname>CONFIGURE_ARGS</varname> depending - on the status of the option - <literal><replaceable>OPT</replaceable></literal>. An - optional argument can be specified with an - <literal>=</literal> symbol. This argument is only appended - to the - <literal>--with-<replaceable>opt</replaceable></literal> + <para>When option <replaceable>OPT</replaceable> is selected, + for each <replaceable>entry</replaceable> in + <varname><replaceable>OPT</replaceable>_CONFIGURE_ENABLE</varname> + then + <literal>--with-<replaceable>entry</replaceable></literal> + is appended to <varname>CONFIGURE_ARGS</varname>. When option + <replaceable>OPT</replaceable> is not selected, + <literal>--without-<replaceable>entry</replaceable></literal> + is appended to <varname>CONFIGURE_ARGS</varname>. An optional + argument can be specified with an <literal>=</literal> + symbol. This argument is only appended to the + <literal>--with-<replaceable>entry</replaceable></literal> configure option. For example:</para> <programlisting>OPTIONS_DEFINE= OPT1 OPT2 OPT1_CONFIGURE_WITH= test1 -OPT1_CONFIGURE_WITH= test2=exhaustive</programlisting> +OPT2_CONFIGURE_WITH= test2=exhaustive</programlisting> <para>is equivalent to:</para> @@ -3956,13 +3997,11 @@ CONFIGURE_ARGS+= --without-test2 <sect3 xml:id="options-configure_on"> <title><varname><replaceable>OPT</replaceable>_CONFIGURE_ON</varname></title> - <para>If - <varname><replaceable>OPT</replaceable>_CONFIGURE_ON</varname> - is set then its value will be appended to - <varname>CONFIGURE_ARGS</varname> depending on the status of - the option - <literal><replaceable>OPT</replaceable></literal>, for - example:</para> + <para>When option <replaceable>OPT</replaceable> is selected, + the value of + <varname><replaceable>OPT</replaceable>_CONFIGURE_ON</varname>, + if defined, is appended to + <varname>CONFIGURE_ARGS</varname>. For example:</para> <programlisting>OPTIONS_DEFINE= OPT1 OPT1_CONFIGURE_ON= --add-test</programlisting> @@ -3981,13 +4020,11 @@ CONFIGURE_ARGS+= --add-test <sect3 xml:id="options-configure_off"> <title><varname><replaceable>OPT</replaceable>_CONFIGURE_OFF</varname></title> - <para>If - <varname><replaceable>OPT</replaceable>_CONFIGURE_OFF</varname> - is set then its value will be appended to - <varname>CONFIGURE_ARGS</varname> depending on the status of - the option - <literal><replaceable>OPT</replaceable></literal>, for - example:</para> + <para>When option <replaceable>OPT</replaceable> <emphasis>is + not</emphasis> selected, the value of + <varname><replaceable>OPT</replaceable>_CONFIGURE_ON</varname>, + if defined, is appended to + <varname>CONFIGURE_ARGS</varname>. For example:</para> <programlisting>OPTIONS_DEFINE= OPT1 OPT1_CONFIGURE_OFF= --no-test</programlisting> @@ -4006,12 +4043,11 @@ CONFIGURE_ARGS+= --no-test <sect3 xml:id="options-cmake_on"> <title><varname><replaceable>OPT</replaceable>_CMAKE_ON</varname></title> - <para>If - <varname><replaceable>OPT</replaceable>_CMAKE_ON</varname> - is set then its value will be appended to - <varname>CMAKE_ARGS</varname> depending on the status of the - option <literal><replaceable>OPT</replaceable></literal>, - for example:</para> + <para>When option <replaceable>OPT</replaceable> is selected, + the value of + <varname><replaceable>OPT</replaceable>_CMAKE_ON</varname>, + if defined, is appended to <varname>CMAKE_ARGS</varname>. + For example:</para> <programlisting>OPTIONS_DEFINE= OPT1 OPT1_CMAKE_ON= -DTEST:BOOL=true</programlisting> @@ -4030,12 +4066,11 @@ CMAKE_ARGS+= -DTEST:BOOL=true <sect3 xml:id="options-cmake_off"> <title><varname><replaceable>OPT</replaceable>_CMAKE_OFF</varname></title> - <para>If - <varname><replaceable>OPT</replaceable>_CMAKE_OFF</varname> - is set then its value will be appended to - <varname>CMAKE_ARGS</varname> depending on the status of the - option <literal><replaceable>OPT</replaceable></literal>, - for example:</para> + <para>When option <replaceable>OPT</replaceable> <emphasis>is + not</emphasis> selected, the value of + <varname><replaceable>OPT</replaceable>_CMAKE_OFF</varname>, + if defined, is appended to <varname>CMAKE_ARGS</varname>. + For example:</para> <programlisting>OPTIONS_DEFINE= OPT1 OPT1_CMAKE_OFF= -DTEST:BOOL=false</programlisting> @@ -4051,6 +4086,52 @@ CMAKE_ARGS+= -DTEST:BOOL=false .endif</programlisting> </sect3> + <sect3 xml:id="options-qmake_on"> + <title><varname><replaceable>OPT</replaceable>_QMAKE_ON</varname></title> + + <para>When option <replaceable>OPT</replaceable> is selected, + the value of + <varname><replaceable>OPT</replaceable>_QMAKE_ON</varname>, + if defined, is appended to + <varname>QMAKE_ARGS</varname>. For example:</para> + + <programlisting>OPTIONS_DEFINE= OPT1 +OPT1_QMAKE_ON= -DTEST:BOOL=true</programlisting> + + <para>is equivalent to:</para> + + <programlisting>OPTIONS_DEFINE= OPT1 + +.include <bsd.port.options.mk> + +.if ${PORT_OPTIONS:MOPT1} +QMAKE_ARGS+= -DTEST:BOOL=true +.endif</programlisting> + </sect3> + + <sect3 xml:id="options-qmake_off"> + <title><varname><replaceable>OPT</replaceable>_QMAKE_OFF</varname></title> + + <para>When option <replaceable>OPT</replaceable> <emphasis>is + not</emphasis> selected, the value of + <varname><replaceable>OPT</replaceable>_QMAKE_OFF</varname>, + if defined, is appended to + <varname>QMAKE_ARGS</varname>. For example:</para> + + <programlisting>OPTIONS_DEFINE= OPT1 +OPT1_QMAKE_OFF= -DTEST:BOOL=false</programlisting> + + <para>is equivalent to:</para> + + <programlisting>OPTIONS_DEFINE= OPT1 + +.include <bsd.port.options.mk> + +.if ! ${PORT_OPTIONS:MOPT1} +QMAKE_ARGS+= -DTEST:BOOL=false +.endif</programlisting> + </sect3> + <sect3 xml:id="options-dependencies"> <title>Dependencies</title> @@ -4089,13 +4170,12 @@ CMAKE_ARGS+= -DTEST:BOOL=false <sect4> <title><varname><replaceable>OPT</replaceable>_<replaceable>ABOVEVARIABLE</replaceable></varname></title> - <para>If - <varname><replaceable>OPT</replaceable>_<replaceable>ABOVEVARIABLE</replaceable></varname> - is defined then its value will be appended to - <literal><replaceable>ABOVEVARIABLE</replaceable></literal> - depending on the status of the option - <literal><replaceable>OPT</replaceable></literal>, for - example:</para> + <para>When option <replaceable>OPT</replaceable> is + selected, the value of + <varname><replaceable>OPT</replaceable>_<replaceable>ABOVEVARIABLE</replaceable></varname>, + if defined, is appended to + <literal><replaceable>ABOVEVARIABLE</replaceable></literal>. + For example:</para> <programlisting>OPTIONS_DEFINE= OPT1 OPT1_LIB_DEPENDS= liba.so:${PORTSDIR}/devel/a</programlisting> @@ -4115,13 +4195,12 @@ LIB_DEPENDS+= liba.so:${PORTSDIR}/devel/ <sect4> <title><varname><replaceable>OPT</replaceable>_<replaceable>ABOVEVARIABLE</replaceable>_OFF</varname></title> - <para>If - <varname><replaceable>OPT</replaceable>_<replaceable>ABOVEVARIABLE</replaceable>_OFF</varname> - is set then a dependency of type - <literal><replaceable>ABOVEVARIABLE</replaceable></literal> - will be added when option - <literal><replaceable>OPT</replaceable></literal> is not - selected. For example:</para> + <para>When option <replaceable>OPT</replaceable> + <emphasis>is not</emphasis> selected, the value of + <varname><replaceable>OPT</replaceable>_<replaceable>ABOVEVARIABLE</replaceable>_OFF</varname>, + if defined, is appended to + <literal><replaceable>ABOVEVARIABLE</replaceable></literal>. + For example:</para> <programlisting>OPTIONS_DEFINE= OPT1 OPT1_LIB_DEPENDS_OFF= liba.so:${PORTSDIR}/devel/a</programlisting> @@ -4270,13 +4349,12 @@ DOCS_ALL_TARGET= doc</programlisting> <sect4> <title><varname><replaceable>OPT</replaceable>_<replaceable>ABOVEVARIABLE</replaceable></varname></title> - <para>If - <varname><replaceable>OPT</replaceable>_<replaceable>ABOVEVARIABLE</replaceable></varname> - is defined then its value will be appended to - <literal><replaceable>ABOVEVARIABLE</replaceable></literal> - depending on the status of the option - <literal><replaceable>OPT</replaceable></literal>, for - example:</para> + <para>When option <replaceable>OPT</replaceable> is + selected, the value of + <varname><replaceable>OPT</replaceable>_<replaceable>ABOVEVARIABLE</replaceable></varname>, + if defined, is appended to + <literal><replaceable>ABOVEVARIABLE</replaceable></literal>. + For example:</para> <programlisting>OPTIONS_DEFINE= OPT1 OPT1_USES= gmake @@ -4297,13 +4375,11 @@ CFLAGS+= -DTEST <sect4> <title><varname><replaceable>OPT</replaceable>_<replaceable>ABOVEVARIABLE</replaceable>_OFF</varname></title> - <para>If - <varname><replaceable>OPT</replaceable>_<replaceable>ABOVEVARIABLE</replaceable>_OFF</varname> - is set then a flag - <literal><replaceable>ABOVEVARIABLE</replaceable></literal> - will be automatically set when option - <literal><replaceable>OPT</replaceable></literal> is not - selected. For example:</para> + <para>When option OPT is not selected, the value of + <varname><replaceable>OPT</replaceable>_<replaceable>ABOVEVARIABLE</replaceable>_OFF</varname>, + if defined, is appended to + <literal><replaceable>ABOVEVARIABLE</replaceable></literal>. + For example:</para> <programlisting>OPTIONS_DEFINE= OPT1 OPT1_USES_OFF=gmake</programlisting>
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201501301811.t0UIBRGi082808>