diff options
| author | Eitan Adler <eadler@FreeBSD.org> | 2014-06-22 07:51:24 +0000 |
|---|---|---|
| committer | Eitan Adler <eadler@FreeBSD.org> | 2014-06-22 07:51:24 +0000 |
| commit | d4cdf44367f5bc2cc5ab7227c8632d01a7973c19 (patch) | |
| tree | c60658c885abd9b432d29c263f9aa3399d7f8602 | |
| parent | 43603eebf3e350efe976bae2dc06f07b2fa69833 (diff) | |
porter's handbook: better handle OPTION_DESC
- Make some of the porter's handbook examples better.
- move a tip to a general paragraph.
- clarify a tip
Notes
svn path=/head/; revision=45097
| -rw-r--r-- | en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml b/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml index 1fb552fc4d..79bd46e1c6 100644 --- a/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml +++ b/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml @@ -3288,7 +3288,7 @@ LIB_DEPENDS= libbar.so:${PORTSDIR}/foo/bar <title>Correct Declaration of an Optional Dependency</title> <programlisting>OPTIONS_DEFINE= BAR -BAR_DESC= Bar support +BAR_DESC= Calling cellphones via bar BAR_LIB_DEPENDS= libbar.so:${PORTSDIR}/foo/bar</programlisting> </example> @@ -3499,16 +3499,16 @@ OPT4_DESC= Describe OPT4 OPT5_DESC= Describe OPT5 OPT6_DESC= Describe OPT6</programlisting> - <tip> - <para><filename>ports/Mk/bsd.options.desc.mk</filename> + <para><filename>ports/Mk/bsd.options.desc.mk</filename> has descriptions for many common - <varname>OPTIONS</varname>; there is usually no need to - override these.</para> - </tip> + <varname>OPTIONS</varname>. While often useful, they + should be overriden if the description is insufficient + for the port.</para> <tip> <para>When describing options, view it from the - perspective of the user: <quote>What does it do?</quote> + perspective of the user: <quote>What functionality does it + change?</quote> and <quote>Why would I want to enable this?</quote> Do not just repeat the name. For example, describing the <literal>NLS</literal> option as @@ -3576,8 +3576,8 @@ OPTIONS_GROUP_GG1= OPT9 OPT10</programlisting> <title>Simple Use of <varname>OPTIONS</varname></title> <programlisting>OPTIONS_DEFINE= FOO BAR -FOO_DESC= Enable option foo -BAR_DESC= Support feature bar +FOO_DESC= Option foo support +BAR_DESC= Feature bar support OPTIONS_DEFAULT=FOO |