From owner-svn-doc-head@FreeBSD.ORG Sun Jun 22 07:51:24 2014 Return-Path: Delivered-To: svn-doc-head@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [8.8.178.115]) (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits)) (No client certificate requested) by hub.freebsd.org (Postfix) with ESMTPS id C565CB66; Sun, 22 Jun 2014 07:51:24 +0000 (UTC) Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:1900:2254:2068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mx1.freebsd.org (Postfix) with ESMTPS id 985ED2E0D; Sun, 22 Jun 2014 07:51:24 +0000 (UTC) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.8/8.14.8) with ESMTP id s5M7pOhu091507; Sun, 22 Jun 2014 07:51:24 GMT (envelope-from eadler@svn.freebsd.org) Received: (from eadler@localhost) by svn.freebsd.org (8.14.8/8.14.8/Submit) id s5M7pOkH091506; Sun, 22 Jun 2014 07:51:24 GMT (envelope-from eadler@svn.freebsd.org) Message-Id: <201406220751.s5M7pOkH091506@svn.freebsd.org> From: Eitan Adler Date: Sun, 22 Jun 2014 07:51:24 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r45097 - head/en_US.ISO8859-1/books/porters-handbook/makefiles X-SVN-Group: doc-head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 22 Jun 2014 07:51:24 -0000 Author: eadler Date: Sun Jun 22 07:51:24 2014 New Revision: 45097 URL: http://svnweb.freebsd.org/changeset/doc/45097 Log: 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 Modified: head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml Modified: head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml Sat Jun 21 23:37:15 2014 (r45096) +++ head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml Sun Jun 22 07:51:24 2014 (r45097) @@ -3288,7 +3288,7 @@ LIB_DEPENDS= libbar.so:${PORTSDIR}/foo/b 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 OPT10Simple Use of OPTIONS 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