Add documentation about the newly added OPTIONS knobs.

Submitted by:	bapt
Approved by:	joel (mentor)
This commit is contained in:
Niclas Zeising 2012-12-10 11:23:32 +00:00
parent d430e0f74d
commit ca7a7a2d70
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=40316

View file

@ -4427,6 +4427,13 @@ OPT6_DESC= Describe OPT6</programlisting>
<programlisting>OPTIONS_SINGLE= SG1
OPTIONS_SINGLE_SG1= OPT3 OPT4</programlisting>
<para><makevar>OPTIONS</makevar> can be grouped as radio
choices, where none or only one choice from each group
is allowed:</para>
<programlisting>OPTIONS_RADIO= RG1
OPTIONS_RADIO_RG1= OPT7 OPT8</programlisting>
<para><makevar>OPTIONS</makevar> can also be grouped as
<quote>multiple-choice</quote> lists, where
<emphasis>at least one</emphasis> option must be
@ -4435,20 +4442,12 @@ OPTIONS_SINGLE_SG1= OPT3 OPT4</programlisting>
<programlisting>OPTIONS_MULTI= MG1
OPTIONS_MULTI_MG1= OPT5 OPT6</programlisting>
<para><makevar>OPTIONS_MULTI</makevar> and
<makevar>OPTIONS_SINGLE</makevar> can also allow zero
choices by including the group in
<makevar>OPTIONS_DEFINE</makevar>:</para>
<para><makevar>OPTIONS</makevar> can also be grouped as
<quote>multiple-choice</quote> lists, where non or any
option can be enabled:</para>
<programlisting>OPTIONS_DEFINE= MG1
OPTIONS_MULTI= MG1
OPTIONS_MULTI_MG1= OPT5 OPT6</programlisting>
<para>This group then requires at least one
<makevar>OPTION</makevar> from <makevar>MG1</makevar>
only if the new <makevar>MG1</makevar>
<makevar>OPTION</makevar> is selected. Experimentation
is encouraged to ensure that this is understood.</para>
<programlisting>OPTIONS_GROUP= GG1
OPTIONS_GROUP_GG1= OPT9 OPT10</programlisting>
<para><makevar>OPTIONS</makevar> are unset by default,
unless they are listed in