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

Catch up with options changes. Various sentence rearranging and rewording.

Browse source 
Differential Revision:	https://reviews.freebsd.org/D1599
Approved by:	wblock
Sponsored by:	Absolight
This commit is contained in:
Mathieu Arnold 2015-01-30 18:11:26 +00:00
parent 5e81b5e582
commit ee7adc115d
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=46244
1 changed files with 164 additions and 88 deletions

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

@ -3711,6 +3711,7 @@ SSL_DESC= Build with OpenSSL support
OPTIONS_DEFAULT= PGSQL LDAP SSL OPTIONS_DEFAULT= PGSQL LDAP SSL
# Will add USE_PGSQL=yes
PGSQL_USE= pgsql=yes PGSQL_USE= pgsql=yes
# Will add --enable-postgres / --disable-postgres # Will add --enable-postgres / --disable-postgres
PGSQL_CONFIGURE_ENABLE= postgres PGSQL_CONFIGURE_ENABLE= postgres
@ -3856,16 +3857,17 @@ SUB_LIST+= OPT1="@comment " NO_OPT1=""
<sect3 xml:id="options-use"> <sect3 xml:id="options-use">
<title><varname><replaceable>OPT</replaceable>_USE</varname></title> <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> <literal><replaceable>key</replaceable>=<replaceable>value</replaceable></literal>
pair in pair in
<varname><replaceable>OPT</replaceable>_USE</varname> the <varname><replaceable>OPT</replaceable>_USE</varname>,
<replaceable>value</replaceable> is appended to the
corresponding corresponding
<varname>USE_<replaceable>KEY</replaceable></varname> <varname>USE_<replaceable>KEY</replaceable></varname>. If
will be set to <replaceable>value</replaceable>. <replaceable>value</replaceable> has spaces in it, replace
If <replaceable>value</replaceable> has spaces in it, them with commas and they will be changed back to spaces
replace them with commas, they will be changed back to during processing. For example:</para>
spaces during processing. For example:</para>
<programlisting>OPTIONS_DEFINE= OPT1 <programlisting>OPTIONS_DEFINE= OPT1
OPT1_USE= mysql=yes xorg=x11,xextproto,xext,xrandr</programlisting> OPT1_USE= mysql=yes xorg=x11,xextproto,xext,xrandr</programlisting>
@ -3882,22 +3884,56 @@ USE_XORG= x11 xextproto xext xrandr
.endif</programlisting> .endif</programlisting>
</sect3> </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 &lt;bsd.port.options.mk&gt;
.if ! ${PORT_OPTIONS:MOPT1}
USE_MYSQL= yes
USE_XORG= x11 xextproto xext xrandr
.endif</programlisting>
</sect3>
<sect3 xml:id="options-configure_enable"> <sect3 xml:id="options-configure_enable">
<title><varname><replaceable>OPT</replaceable>_CONFIGURE_ENABLE</varname></title> <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> <varname><replaceable>OPT</replaceable>_CONFIGURE_ENABLE</varname>
is set then then
<literal>--enable-${<replaceable>OPT</replaceable>_CONFIGURE_ENABLE}</literal> <literal>--enable-<replaceable>entry</replaceable></literal>
or is appended to <varname>CONFIGURE_ARGS</varname>. When option
<literal>--disable-${<replaceable>OPT</replaceable>_CONFIGURE_ENABLE}</literal> <replaceable>OPT</replaceable> is not selected,
will be added to <varname>CONFIGURE_ARGS</varname> depending <literal>--disable-<replaceable>entry</replaceable></literal>
on the value of the option is appended to <varname>CONFIGURE_ARGS</varname>. An optional
<literal><replaceable>OPT</replaceable></literal>, for argument can be specified with an <literal>=</literal>
example:</para> symbol. This argument is only appended to the
<literal>--enable-<replaceable>entry</replaceable></literal>
configure option. For example:</para>
<programlisting>OPTIONS_DEFINE= OPT1 <programlisting>OPTIONS_DEFINE= OPT1 OPT2
OPT1_CONFIGURE_ENABLE= test</programlisting> OPT1_CONFIGURE_ENABLE= test1 test2
OPT2_CONFIGURE_ENABLE= test2=exhaustive</programlisting>
<para>is equivalent to:</para> <para>is equivalent to:</para>
@ -3906,33 +3942,38 @@ OPT1_CONFIGURE_ENABLE= test</programlisting>
.include &lt;bsd.port.options.mk&gt; .include &lt;bsd.port.options.mk&gt;
.if ${PORT_OPTIONS:MOPT1} .if ${PORT_OPTIONS:MOPT1}
CONFIGURE_ARGS+= --enable-test CONFIGURE_ARGS+= --enable-test1 --enable-test2
.else .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> .endif</programlisting>
</sect3> </sect3>
<sect3 xml:id="options-configure_with"> <sect3 xml:id="options-configure_with">
<title><varname><replaceable>OPT</replaceable>_CONFIGURE_WITH</varname></title> <title><varname><replaceable>OPT</replaceable>_CONFIGURE_WITH</varname></title>
<para>If <para>When option <replaceable>OPT</replaceable> is selected,
<varname><replaceable>OPT</replaceable>_CONFIGURE_WITH</varname> for each <replaceable>entry</replaceable> in
is set then <varname><replaceable>OPT</replaceable>_CONFIGURE_ENABLE</varname>
<literal>--with-${<replaceable>OPT</replaceable>_CONFIGURE_WITH}</literal> then
or <literal>--with-<replaceable>entry</replaceable></literal>
<literal>--without-${<replaceable>OPT</replaceable>_CONFIGURE_WITH}</literal> is appended to <varname>CONFIGURE_ARGS</varname>. When option
will be added to <varname>CONFIGURE_ARGS</varname> depending <replaceable>OPT</replaceable> is not selected,
on the status of the option <literal>--without-<replaceable>entry</replaceable></literal>
<literal><replaceable>OPT</replaceable></literal>. An is appended to <varname>CONFIGURE_ARGS</varname>. An optional
optional argument can be specified with an argument can be specified with an <literal>=</literal>
<literal>=</literal> symbol. This argument is only appended symbol. This argument is only appended to the
to the <literal>--with-<replaceable>entry</replaceable></literal>
<literal>--with-<replaceable>opt</replaceable></literal>
configure option. For example:</para> configure option. For example:</para>
<programlisting>OPTIONS_DEFINE= OPT1 OPT2 <programlisting>OPTIONS_DEFINE= OPT1 OPT2
OPT1_CONFIGURE_WITH= test1 OPT1_CONFIGURE_WITH= test1
OPT1_CONFIGURE_WITH= test2=exhaustive</programlisting> OPT2_CONFIGURE_WITH= test2=exhaustive</programlisting>
<para>is equivalent to:</para> <para>is equivalent to:</para>
@ -3956,13 +3997,11 @@ CONFIGURE_ARGS+= --without-test2
<sect3 xml:id="options-configure_on"> <sect3 xml:id="options-configure_on">
<title><varname><replaceable>OPT</replaceable>_CONFIGURE_ON</varname></title> <title><varname><replaceable>OPT</replaceable>_CONFIGURE_ON</varname></title>
<para>If <para>When option <replaceable>OPT</replaceable> is selected,
<varname><replaceable>OPT</replaceable>_CONFIGURE_ON</varname> the value of
is set then its value will be appended to <varname><replaceable>OPT</replaceable>_CONFIGURE_ON</varname>,
<varname>CONFIGURE_ARGS</varname> depending on the status of if defined, is appended to
the option <varname>CONFIGURE_ARGS</varname>. For example:</para>
<literal><replaceable>OPT</replaceable></literal>, for
example:</para>
<programlisting>OPTIONS_DEFINE= OPT1 <programlisting>OPTIONS_DEFINE= OPT1
OPT1_CONFIGURE_ON= --add-test</programlisting> OPT1_CONFIGURE_ON= --add-test</programlisting>
@ -3981,13 +4020,11 @@ CONFIGURE_ARGS+= --add-test
<sect3 xml:id="options-configure_off"> <sect3 xml:id="options-configure_off">
<title><varname><replaceable>OPT</replaceable>_CONFIGURE_OFF</varname></title> <title><varname><replaceable>OPT</replaceable>_CONFIGURE_OFF</varname></title>
<para>If <para>When option <replaceable>OPT</replaceable> <emphasis>is
<varname><replaceable>OPT</replaceable>_CONFIGURE_OFF</varname> not</emphasis> selected, the value of
is set then its value will be appended to <varname><replaceable>OPT</replaceable>_CONFIGURE_ON</varname>,
<varname>CONFIGURE_ARGS</varname> depending on the status of if defined, is appended to
the option <varname>CONFIGURE_ARGS</varname>. For example:</para>
<literal><replaceable>OPT</replaceable></literal>, for
example:</para>
<programlisting>OPTIONS_DEFINE= OPT1 <programlisting>OPTIONS_DEFINE= OPT1
OPT1_CONFIGURE_OFF= --no-test</programlisting> OPT1_CONFIGURE_OFF= --no-test</programlisting>
@ -4006,12 +4043,11 @@ CONFIGURE_ARGS+= --no-test
<sect3 xml:id="options-cmake_on"> <sect3 xml:id="options-cmake_on">
<title><varname><replaceable>OPT</replaceable>_CMAKE_ON</varname></title> <title><varname><replaceable>OPT</replaceable>_CMAKE_ON</varname></title>
<para>If <para>When option <replaceable>OPT</replaceable> is selected,
<varname><replaceable>OPT</replaceable>_CMAKE_ON</varname> the value of
is set then its value will be appended to <varname><replaceable>OPT</replaceable>_CMAKE_ON</varname>,
<varname>CMAKE_ARGS</varname> depending on the status of the if defined, is appended to <varname>CMAKE_ARGS</varname>.
option <literal><replaceable>OPT</replaceable></literal>, For example:</para>
for example:</para>
<programlisting>OPTIONS_DEFINE= OPT1 <programlisting>OPTIONS_DEFINE= OPT1
OPT1_CMAKE_ON= -DTEST:BOOL=true</programlisting> OPT1_CMAKE_ON= -DTEST:BOOL=true</programlisting>
@ -4030,12 +4066,11 @@ CMAKE_ARGS+= -DTEST:BOOL=true
<sect3 xml:id="options-cmake_off"> <sect3 xml:id="options-cmake_off">
<title><varname><replaceable>OPT</replaceable>_CMAKE_OFF</varname></title> <title><varname><replaceable>OPT</replaceable>_CMAKE_OFF</varname></title>
<para>If <para>When option <replaceable>OPT</replaceable> <emphasis>is
<varname><replaceable>OPT</replaceable>_CMAKE_OFF</varname> not</emphasis> selected, the value of
is set then its value will be appended to <varname><replaceable>OPT</replaceable>_CMAKE_OFF</varname>,
<varname>CMAKE_ARGS</varname> depending on the status of the if defined, is appended to <varname>CMAKE_ARGS</varname>.
option <literal><replaceable>OPT</replaceable></literal>, For example:</para>
for example:</para>
<programlisting>OPTIONS_DEFINE= OPT1 <programlisting>OPTIONS_DEFINE= OPT1
OPT1_CMAKE_OFF= -DTEST:BOOL=false</programlisting> OPT1_CMAKE_OFF= -DTEST:BOOL=false</programlisting>
@ -4051,6 +4086,52 @@ CMAKE_ARGS+= -DTEST:BOOL=false
.endif</programlisting> .endif</programlisting>
</sect3> </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 &lt;bsd.port.options.mk&gt;
.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 &lt;bsd.port.options.mk&gt;
.if ! ${PORT_OPTIONS:MOPT1}
QMAKE_ARGS+= -DTEST:BOOL=false
.endif</programlisting>
</sect3>
<sect3 xml:id="options-dependencies"> <sect3 xml:id="options-dependencies">
<title>Dependencies</title> <title>Dependencies</title>
@ -4089,13 +4170,12 @@ CMAKE_ARGS+= -DTEST:BOOL=false
<sect4> <sect4>
<title><varname><replaceable>OPT</replaceable>_<replaceable>ABOVEVARIABLE</replaceable></varname></title> <title><varname><replaceable>OPT</replaceable>_<replaceable>ABOVEVARIABLE</replaceable></varname></title>
<para>If <para>When option <replaceable>OPT</replaceable> is
<varname><replaceable>OPT</replaceable>_<replaceable>ABOVEVARIABLE</replaceable></varname> selected, the value of
is defined then its value will be appended to <varname><replaceable>OPT</replaceable>_<replaceable>ABOVEVARIABLE</replaceable></varname>,
<literal><replaceable>ABOVEVARIABLE</replaceable></literal> if defined, is appended to
depending on the status of the option <literal><replaceable>ABOVEVARIABLE</replaceable></literal>.
<literal><replaceable>OPT</replaceable></literal>, for For example:</para>
example:</para>
<programlisting>OPTIONS_DEFINE= OPT1 <programlisting>OPTIONS_DEFINE= OPT1
OPT1_LIB_DEPENDS= liba.so:${PORTSDIR}/devel/a</programlisting> OPT1_LIB_DEPENDS= liba.so:${PORTSDIR}/devel/a</programlisting>
@ -4115,13 +4195,12 @@ LIB_DEPENDS+= liba.so:${PORTSDIR}/devel/a
<sect4> <sect4>
<title><varname><replaceable>OPT</replaceable>_<replaceable>ABOVEVARIABLE</replaceable>_OFF</varname></title> <title><varname><replaceable>OPT</replaceable>_<replaceable>ABOVEVARIABLE</replaceable>_OFF</varname></title>
<para>If <para>When option <replaceable>OPT</replaceable>
<varname><replaceable>OPT</replaceable>_<replaceable>ABOVEVARIABLE</replaceable>_OFF</varname> <emphasis>is not</emphasis> selected, the value of
is set then a dependency of type <varname><replaceable>OPT</replaceable>_<replaceable>ABOVEVARIABLE</replaceable>_OFF</varname>,
<literal><replaceable>ABOVEVARIABLE</replaceable></literal> if defined, is appended to
will be added when option <literal><replaceable>ABOVEVARIABLE</replaceable></literal>.
<literal><replaceable>OPT</replaceable></literal> is not For example:</para>
selected. For example:</para>
<programlisting>OPTIONS_DEFINE= OPT1 <programlisting>OPTIONS_DEFINE= OPT1
OPT1_LIB_DEPENDS_OFF= liba.so:${PORTSDIR}/devel/a</programlisting> OPT1_LIB_DEPENDS_OFF= liba.so:${PORTSDIR}/devel/a</programlisting>
@ -4270,13 +4349,12 @@ DOCS_ALL_TARGET= doc</programlisting>
<sect4> <sect4>
<title><varname><replaceable>OPT</replaceable>_<replaceable>ABOVEVARIABLE</replaceable></varname></title> <title><varname><replaceable>OPT</replaceable>_<replaceable>ABOVEVARIABLE</replaceable></varname></title>
<para>If <para>When option <replaceable>OPT</replaceable> is
<varname><replaceable>OPT</replaceable>_<replaceable>ABOVEVARIABLE</replaceable></varname> selected, the value of
is defined then its value will be appended to <varname><replaceable>OPT</replaceable>_<replaceable>ABOVEVARIABLE</replaceable></varname>,
<literal><replaceable>ABOVEVARIABLE</replaceable></literal> if defined, is appended to
depending on the status of the option <literal><replaceable>ABOVEVARIABLE</replaceable></literal>.
<literal><replaceable>OPT</replaceable></literal>, for For example:</para>
example:</para>
<programlisting>OPTIONS_DEFINE= OPT1 <programlisting>OPTIONS_DEFINE= OPT1
OPT1_USES= gmake OPT1_USES= gmake
@ -4297,13 +4375,11 @@ CFLAGS+= -DTEST
<sect4> <sect4>
<title><varname><replaceable>OPT</replaceable>_<replaceable>ABOVEVARIABLE</replaceable>_OFF</varname></title> <title><varname><replaceable>OPT</replaceable>_<replaceable>ABOVEVARIABLE</replaceable>_OFF</varname></title>
<para>If <para>When option OPT is not selected, the value of
<varname><replaceable>OPT</replaceable>_<replaceable>ABOVEVARIABLE</replaceable>_OFF</varname> <varname><replaceable>OPT</replaceable>_<replaceable>ABOVEVARIABLE</replaceable>_OFF</varname>,
is set then a flag if defined, is appended to
<literal><replaceable>ABOVEVARIABLE</replaceable></literal> <literal><replaceable>ABOVEVARIABLE</replaceable></literal>.
will be automatically set when option For example:</para>
<literal><replaceable>OPT</replaceable></literal> is not
selected. For example:</para>
<programlisting>OPTIONS_DEFINE= OPT1 <programlisting>OPTIONS_DEFINE= OPT1
OPT1_USES_OFF=gmake</programlisting> OPT1_USES_OFF=gmake</programlisting>