From owner-svn-doc-head@freebsd.org Tue Apr 12 20:37:56 2016 Return-Path: Delivered-To: svn-doc-head@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 72913B0DCB6; Tue, 12 Apr 2016 20:37:56 +0000 (UTC) (envelope-from mat@FreeBSD.org) Received: from prod2.absolight.net (mx3.absolight.net [IPv6:2a01:678:2:100::25]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "plouf.absolight.net", Issuer "CAcert Class 3 Root" (not verified)) by mx1.freebsd.org (Postfix) with ESMTPS id 2E3A31184; Tue, 12 Apr 2016 20:37:56 +0000 (UTC) (envelope-from mat@FreeBSD.org) Received: from prod2.absolight.net (localhost [127.0.0.1]) by prod2.absolight.net (Postfix) with ESMTP id 9E253BDC73; Tue, 12 Apr 2016 22:37:53 +0200 (CEST) Received: from atuin.in.mat.cc (atuin.in.mat.cc [79.143.241.205]) by prod2.absolight.net (Postfix) with ESMTPA id 67468BDC2E; Tue, 12 Apr 2016 22:37:53 +0200 (CEST) Received: from localhost (localhost [127.0.0.1]) by atuin.in.mat.cc (Postfix) with ESMTP id 2AEEF592D1BC; Tue, 12 Apr 2016 22:37:53 +0200 (CEST) Date: Tue, 12 Apr 2016 22:37:52 +0200 From: Mathieu Arnold To: Jason Helfman , doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: Re: svn commit: r48574 - head/en_US.ISO8859-1/books/porters-handbook/makefiles Message-ID: In-Reply-To: <201604121842.u3CIgAQA099949@repo.freebsd.org> References: <201604121842.u3CIgAQA099949@repo.freebsd.org> X-Mailer: Mulberry/4.0.8 (Mac OS X) MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha1; protocol="application/pgp-signature"; boundary="==========7BD3D85BD03719B310AC==========" X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.21 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: Tue, 12 Apr 2016 20:37:56 -0000 --==========7BD3D85BD03719B310AC========== Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Content-Disposition: inline +--On 12 avril 2016 18:42:10 +0000 Jason Helfman wrote: | Author: jgh | Date: Tue Apr 12 18:42:10 2016 | New Revision: 48574 | URL: https://svnweb.freebsd.org/changeset/doc/48574 |=20 | Log: | - convert ordered list to unordered list Thing is, now, one can't say "this goes against the COMMENT rule n=C2=B0X". (Which is a thing people say, right now.) | - address rules verbiage and grammar | | Reviewed with: wblock@ |=20 | Modified: | head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml |=20 | Modified: | head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml | = =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D | =3D=3D=3D=3D=3D --- | 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=3D | yes | | <varname>COMMENT</varname> | =20 | - 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: | =20 | - | + | | - 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. | | =20 | | - Do not include the package name (or | - version number of the software); | + Do not include the package name or | + version number of software. | | =20 | | The comment must begin with a capital and end without | - a period; | + a period. | | =20 | | Do not start with an indefinite article (that is, A or | - An); | + An). | | =20 | | - Names are capitalized (for example, Apache, JavaScript, | - Perl); | + Capitalize names such as Apache, JavaScript, or Perl. | | =20 | | - 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." | | =20 | | - Spell check the text. | + Check for spelling errors. | | - | + | =20 | Here is an example: | =20 |=20 |=20 --=20 Mathieu Arnold --==========7BD3D85BD03719B310AC========== Content-Type: application/pgp-signature Content-Transfer-Encoding: 7bit -----BEGIN PGP SIGNATURE----- Version: GnuPG v1 iQJ8BAEBCgBmBQJXDVygXxSAAAAAAC4AKGlzc3Vlci1mcHJAbm90YXRpb25zLm9w ZW5wZ3AuZmlmdGhob3JzZW1hbi5uZXQzQUI2OTc4OUQyRUQxMjEwNjQ0MEJBNUIz QTQ1MTZGMzUxODNDRTQ4AAoJEDpFFvNRg85IScMQAJtH27TYjHOFfs89eYR79BpG ofVCiJ5o2st1k9bwEjGSJoQvcBJVN+K36ekhSa7RtsWli2ERDsK1Nd++EPhvsrXa PGyKW6I0Q9kN9KtUMbEXmROo21nhgPAgTJiczNzHpcMwaGIrUNrjUhRBoShE3ED4 gvpd/lm5B3NFnBETLQJkrT8IDnNX0DgsnLtabKS8HgzI/u3NimuHlu4AOGOmptLV JWXsQx6osMOj1XV4RoxZZqeIxJPGmTUoUcYiwFZzv5YmFXhEM+sdzfSV/1qNaHrG 1iwhXmrDuUAix+EbC50SC/iudmADqI7+af9jG7adDvP/GJGOOYhS78s5fA1dpAtG hmY3hiW1hOWhVJfOoapHLM96W6eXYCzgnQ1EjvQSDQc8GMV5CyTpcBE4zBG0ogDe jBch51+Y5OSwz6I2vNW8XPPik/raY0PD5MLX1GTdsIjm2RWVAxrP+jdGTtXfHsBu Rb+AF6EXvbX+zh1RLRhu4ikoVbqOPia6l4ufw7wtUYnlSFzshx1TNZ9bUmDBqulY vtXkBXzhsgfcUvIAmV0JHyCDi2uAEc2j6riHtJ0S6W3s3wSILKroBpK6qEcEqRsV da+kHh3z/S8IPVlDgARXde6O10OrYs4GHnRBxQfmXw9KXLF3QjS1hGsHLRzmWEGV SOs8kddvYnhVZJHmOrtm =V6V3 -----END PGP SIGNATURE----- --==========7BD3D85BD03719B310AC==========--