From d4cdf44367f5bc2cc5ab7227c8632d01a7973c19 Mon Sep 17 00:00:00 2001 From: Eitan Adler Date: Sun, 22 Jun 2014 07:51:24 +0000 Subject: 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 --- .../books/porters-handbook/makefiles/chapter.xml | 18 +++++++++--------- 1 file 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 Correct Declaration of an Optional Dependency OPTIONS_DEFINE= BAR -BAR_DESC= Bar support +BAR_DESC= Calling cellphones via bar BAR_LIB_DEPENDS= libbar.so:${PORTSDIR}/foo/bar @@ -3499,16 +3499,16 @@ OPT4_DESC= Describe OPT4 OPT5_DESC= Describe OPT5 OPT6_DESC= Describe OPT6 - - ports/Mk/bsd.options.desc.mk + ports/Mk/bsd.options.desc.mk has descriptions for many common - OPTIONS; there is usually no need to - override these. - + OPTIONS. While often useful, they + should be overriden if the description is insufficient + for the port. When describing options, view it from the - perspective of the user: What does it do? + perspective of the user: What functionality does it + change? and Why would I want to enable this? Do not just repeat the name. For example, describing the NLS option as @@ -3576,8 +3576,8 @@ OPTIONS_GROUP_GG1= OPT9 OPT10 Simple Use of <varname>OPTIONS</varname> 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 -- cgit v1.3