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

- Add note about ports/KNOBS file

Browse source
This commit is contained in:
Michael Johnson 2005-11-05 07:08:21 +00:00
parent f2de795646
commit f396824802
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=26247
1 changed files with 22 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
en_US.ISO8859-1/books/porters-handbook/book.sgml
View file

@ -3565,7 +3565,10 @@ ${PREFIX}/man/ja/man4/baz.4.gz</programlisting>
make users happy, and effectively provide 2 or more ports for the
price of one.</para>
<sect2>
<sect2>
<title><makevar>KNOBS</makevar></title>
<sect3>
<title><makevar>WITH_<replaceable>*</replaceable></makevar> and
<makevar>WITHOUT_<replaceable>*</replaceable></makevar></title>
@ -3683,6 +3686,21 @@ ${PREFIX}/man/ja/man4/baz.4.gz</programlisting>
</tgroup>
</table>
</sect3>
<sect3>
<title>Knob naming</title>
<para>It is recommended that porters use like-named knobs, for the
benefit of end-users and to help keep the number of knob names down.
A list of popular knob names can be found in the
<ulink url="http://www.freebsd.org/cgi/cvsweb.cgi/ports/KNOBS?rev=HEAD&amp;content-type=text/x-cvsweb-markup">KNOBS</ulink>
file.</para>
<para>Knob names should reflect what the knob is and does.
When a port has a lib-prefix in the <makevar>PORTNAME</makevar>
the lib-prefix should be dropped in knob naming.</para>
</sect3>
</sect2>
<sect2>
@ -3692,9 +3710,9 @@ ${PREFIX}/man/ja/man4/baz.4.gz</programlisting>
<title>Background</title>
<para>The <makevar>OPTIONS</makevar> variable gives the user who
installs the port a dialog with the available options and saves
them to <filename>/var/db/ports/portname/options</filename>. Next
time when the port has to be rebuild, the options are reused. Never
again you will have to remember all the twenty
them to <filename>/var/db/ports/<replaceable>portname</replaceable>/options</filename>.
Next time when the port has to be rebuild, the options are reused.
Never again you will have to remember all the twenty
<makevar>WITH_<replaceable>*</replaceable></makevar> and
<makevar>WITHOUT_<replaceable>*</replaceable></makevar> options you
used to build this port!</para>