From owner-svn-doc-all@freebsd.org Tue Apr 12 18:42:11 2016 Return-Path: Delivered-To: svn-doc-all@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id BF7F3B0ED5C; Tue, 12 Apr 2016 18:42:11 +0000 (UTC) (envelope-from jgh@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::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 71D3710BE; Tue, 12 Apr 2016 18:42:11 +0000 (UTC) (envelope-from jgh@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id u3CIgAti099950; Tue, 12 Apr 2016 18:42:10 GMT (envelope-from jgh@FreeBSD.org) Received: (from jgh@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id u3CIgAQA099949; Tue, 12 Apr 2016 18:42:10 GMT (envelope-from jgh@FreeBSD.org) Message-Id: <201604121842.u3CIgAQA099949@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: jgh set sender to jgh@FreeBSD.org using -f From: Jason Helfman Date: Tue, 12 Apr 2016 18:42:10 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r48574 - 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-all@freebsd.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: "SVN commit messages for the entire doc trees \(except for " user" , " projects" , and " translations" \)" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 12 Apr 2016 18:42:11 -0000 Author: jgh Date: Tue Apr 12 18:42:10 2016 New Revision: 48574 URL: https://svnweb.freebsd.org/changeset/doc/48574 Log: - convert ordered list to unordered list - address rules verbiage and grammar Reviewed with: wblock@ 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 Tue Apr 12 18:19:29 2016 (r48573) +++ head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml Tue Apr 12 18:42:10 2016 (r48574) @@ -3124,46 +3124,43 @@ ALWAYS_KEEP_DISTFILES= yes <varname>COMMENT</varname> - This is a one-line description of the port. Please respect - these rules: + The comment is a one-line description of a port shown by + pkg info. Please follow these rules when + composing it: - + - Try to keep the COMMENT value at no longer than 70 - characters, as this line will be used by - pkg info (see &man.pkg-info.8;) to - display a one-line summary of the port; + The COMMENT string should be 70 characters or less. - Do not include the package name (or - version number of the software); + Do not include the package name or + version number of software. The comment must begin with a capital and end without - a period; + a period. Do not start with an indefinite article (that is, A or - An); + An). - Names are capitalized (for example, Apache, JavaScript, - Perl); + Capitalize names such as Apache, JavaScript, or Perl. - For lists of words, use the Oxford comma (for example, - green, red, and blue); + Use a serial comma for lists of words: "green, + red, and blue." - Spell check the text. + Check for spelling errors. - + Here is an example: