Date: Tue, 12 Apr 2016 22:37:52 +0200 From: Mathieu Arnold <mat@FreeBSD.org> To: Jason Helfman <jgh@FreeBSD.org>, 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: <CD1E78612ED5902BF4A1B350@atuin.in.mat.cc> In-Reply-To: <201604121842.u3CIgAQA099949@repo.freebsd.org> References: <201604121842.u3CIgAQA099949@repo.freebsd.org>
index | next in thread | previous in thread | raw e-mail
[-- Attachment #1 --] +--On 12 avril 2016 18:42:10 +0000 Jason Helfman <jgh@FreeBSD.org> wrote: | 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 Thing is, now, one can't say "this goes against the COMMENT rule n°X". (Which is a thing people say, right now.) | - 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 | <sect1 xml:id="makefile-comment"> | <title><varname>COMMENT</varname></title> | | - <para>This is a one-line description of the port. Please respect | - these rules:</para> | + <para>The comment is a one-line description of a port shown by | + <command>pkg info</command>. Please follow these rules when | + composing it:</para> | | - <orderedlist> | + <itemizedlist> | <listitem> | - <para>Try to keep the COMMENT value at no longer than 70 | - characters, as this line will be used by | - <command>pkg info</command> (see &man.pkg-info.8;) to | - display a one-line summary of the port;</para> | + <para>The COMMENT string should be 70 characters or less.</para> | </listitem> | | <listitem> | - <para>Do <emphasis>not</emphasis> include the package name (or | - version number of the software);</para> | + <para>Do <emphasis>not</emphasis> include the package name or | + version number of software.</para> | </listitem> | | <listitem> | <para>The comment must begin with a capital and end without | - a period;</para> | + a period.</para> | </listitem> | | <listitem> | <para>Do not start with an indefinite article (that is, A or | - An);</para> | + An).</para> | </listitem> | | <listitem> | - <para>Names are capitalized (for example, Apache, JavaScript, | - Perl);</para> | + <para>Capitalize names such as Apache, JavaScript, or Perl.</para> | </listitem> | | <listitem> | - <para>For lists of words, use the Oxford comma (for example, | - green, red<emphasis>,</emphasis> and blue);</para> | + <para>Use a serial comma for lists of words: "green, | + red<emphasis>,</emphasis> and blue."</para> | </listitem> | | <listitem> | - <para>Spell check the text.</para> | + <para>Check for spelling errors.</para> | </listitem> | - </orderedlist> | + </itemizedlist> | | <para>Here is an example:</para> | | | -- Mathieu Arnold [-- Attachment #2 --] -----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-----help
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?CD1E78612ED5902BF4A1B350>