diff options
author | Carlo Strub <cs@FreeBSD.org> | 2012-09-02 12:21:36 +0000 |
---|---|---|
committer | Carlo Strub <cs@FreeBSD.org> | 2012-09-02 12:21:36 +0000 |
commit | cc239ad8bc31ebd86a6c7159cc1d97aa244e93a1 (patch) | |
tree | 02a79b84ed618c019e820080ef62ba0db7d79bd0 | |
parent | 000ef04a07e15f723da694b7868b22b6c3c1c04c (diff) |
Notes
-rw-r--r-- | en_US.ISO8859-1/books/porters-handbook/book.sgml | 27 |
1 files changed, 15 insertions, 12 deletions
diff --git a/en_US.ISO8859-1/books/porters-handbook/book.sgml b/en_US.ISO8859-1/books/porters-handbook/book.sgml index 468054a095..4b3a4c03eb 100644 --- a/en_US.ISO8859-1/books/porters-handbook/book.sgml +++ b/en_US.ISO8859-1/books/porters-handbook/book.sgml @@ -3414,30 +3414,33 @@ ALWAYS_KEEP_DISTFILES= yes <title><makevar>COMMENT</makevar></title> <para>This is a one-line description of the port. - Please respect the following rules:</para> - <orderedlist> + Please respect the following rules:</para> + <orderedlist> <listitem> <para>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;</para> + characters, as this line will be used by the + &man.pkg.info.1; utility to display a one-line summary + of the port;</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 the software);</para> </listitem> <listitem> - <para>The comment should begin with a capital and end without a - period;</para> + <para>The comment should begin with a capital and end + without a period;</para> </listitem> <listitem> - <para>Do not start with an indefinite article (i.e. A or An);</para> + <para>Do not start with an indefinite article (i.e. + A or An);</para> </listitem> <listitem> - <para>Names are capitalized (e.g. Apache, JavaScript, Perl);</para> + <para>Names are capitalized (e.g. Apache, JavaScript, + Perl);</para> </listitem> <listitem> - <para>For lists of words use the Oxford comma (e.g. green, - red<emphasis>,</emphasis> and blue);</para> + <para>For lists of words use the Oxford comma (e.g. + green, red<emphasis>,</emphasis> and blue);</para> </listitem> <listitem> <para>Spell check the text.</para> |