os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

- convert ordered list to unordered list

Browse source 
- address rules verbiage and grammar

Reviewed with: wblock@
This commit is contained in:
Jason Helfman 2016-04-12 18:42:10 +00:00
parent dbc1bcaeac
commit 879fa2e78e
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=48574
1 changed files with 14 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml
View file

@ -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>