From owner-svn-doc-all@FreeBSD.ORG Sun Jul 29 19:12:10 2012 Return-Path: Delivered-To: svn-doc-all@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id 74CF7106564A; Sun, 29 Jul 2012 19:12:10 +0000 (UTC) (envelope-from cs@FreeBSD.org) Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:4f8:fff6::2c]) by mx1.freebsd.org (Postfix) with ESMTP id 458228FC08; Sun, 29 Jul 2012 19:12:10 +0000 (UTC) Received: from svn.freebsd.org (localhost [127.0.0.1]) by svn.freebsd.org (8.14.4/8.14.4) with ESMTP id q6TJCAdQ089084; Sun, 29 Jul 2012 19:12:10 GMT (envelope-from cs@svn.freebsd.org) Received: (from cs@localhost) by svn.freebsd.org (8.14.4/8.14.4/Submit) id q6TJCAPB089082; Sun, 29 Jul 2012 19:12:10 GMT (envelope-from cs@svn.freebsd.org) Message-Id: <201207291912.q6TJCAPB089082@svn.freebsd.org> From: Carlo Strub Date: Sun, 29 Jul 2012 19:12:10 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org X-SVN-Group: doc-head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Cc: Subject: svn commit: r39282 - head/en_US.ISO8859-1/books/porters-handbook X-BeenThere: svn-doc-all@freebsd.org X-Mailman-Version: 2.1.5 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: Sun, 29 Jul 2012 19:12:10 -0000 Author: cs (ports committer) Date: Sun Jul 29 19:12:09 2012 New Revision: 39282 URL: http://svn.freebsd.org/changeset/doc/39282 Log: Add in more details about how to write a good COMMENT Approved by: portmgr@ (implicit) Modified: head/en_US.ISO8859-1/books/porters-handbook/book.sgml Modified: head/en_US.ISO8859-1/books/porters-handbook/book.sgml ============================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/book.sgml Sun Jul 29 17:35:46 2012 (r39281) +++ head/en_US.ISO8859-1/books/porters-handbook/book.sgml Sun Jul 29 19:12:09 2012 (r39282) @@ -133,7 +133,7 @@ CATEGORIES= games MASTER_SITES= ftp://ftp.cs.columbia.edu/archives/X11R5/contrib/ MAINTAINER= asami@FreeBSD.org -COMMENT= A cat chasing a mouse all over the screen +COMMENT= Cat chasing a mouse all over the screen MAN1= oneko.1 MANCOMPRESSED= yes @@ -3411,20 +3411,42 @@ ALWAYS_KEEP_DISTFILES= yes <makevar>COMMENT</makevar> This is a one-line description of the port. - Please do not include the package name - (or version number of the software) in the comment. The - comment should begin with a capital and end without a period. - Here is an example: + Please respect the following rules: + + + Try to keep the COMMENT value at no longer than 70 + characters, as this line will be used by the &man.pkg.info.1; + utility to display a one-line summary of the port; + + + Do not include the package name + (or version number of the software); + + + The comment should begin with a capital and end without a + period; + + + Do not start with an indefinite article (i.e. A or An); + + + Names are capitalized (e.g. Apache, JavaScript, Perl); + + + For lists of words use the Oxford comma (e.g. green, + red, and blue); + + + Spell check the text. + + + Here is an example: - COMMENT= A cat chasing a mouse all over the screen + COMMENT= Cat chasing a mouse all over the screen The COMMENT variable should immediately follow the MAINTAINER variable in the Makefile. - - Please try to keep the COMMENT value at no longer than 70 - characters, as this line will be used by the &man.pkg.info.1; - utility to display a one-line summary of the port.