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

Add information about the new COMMENT variable and retire the bits

Browse source 
about pkg-comment

Reviewed by:	kris
This commit is contained in:
Christian Brueffer 2003-02-24 01:04:42 +00:00
parent 502e61bbe2
commit 53894cd3f4
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=16114
1 changed files with 22 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

45
en_US.ISO8859-1/books/porters-handbook/book.sgml
View file

@ -110,6 +110,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
MAN1= oneko.1
MANCOMPRESSED= yes
@ -127,26 +128,13 @@ USE_IMAKE= yes
<sect1 id="porting-desc">
<title>Writing the description files</title>
<para>There are three description files that are required for
<para>There are two description files that are required for
any port, whether they actually package or not. They are
<filename>pkg-comment</filename>,
<filename>pkg-descr</filename>, and
<filename>pkg-plist</filename>, and their
<filename>pkg-descr</filename> and
<filename>pkg-plist</filename>. Their
<filename>pkg-</filename> prefix distinguishes them from
other files.</para>
<sect2>
<title><filename>pkg-comment</filename></title>
<para>This is the one-line description of the port.
<emphasis>Please</emphasis> 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:</para>
<programlisting>A cat chasing a mouse all over the screen</programlisting>
</sect2>
<sect2>
<title><filename>pkg-descr</filename></title>
@ -2624,6 +2612,21 @@ PATCHFILES= patch1:test</programlisting>
Makefiles</ulink> section.</para>
</sect1>
<sect1 id="makefile-comment">
<title><makevar>COMMENT</makevar></title>
<para>This is a one-line description of the port.
<emphasis>Please</emphasis> 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:</para>
<programlisting>COMMENT= A cat chasing a mouse all over the screen</programlisting>
<para>The COMMENT variable should immediately follow the MAINTAINER
variable in the <filename>Makefile</filename>.</para>
</sect1>
<sect1 id="makefile-depend">
<title>Dependencies</title>
@ -4396,11 +4399,6 @@ PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION}</programlisting>
</thead>
<tbody>
<row>
<entry><makevar>COMMENT</makevar></entry>
<entry><literal>${PKGDIR}/pkg-comment</literal></entry>
</row>
<row>
<entry><makevar>DESCR</makevar></entry>
<entry><literal>${PKGDIR}/pkg-descr</literal></entry>
@ -6073,8 +6071,8 @@ drweb:*:426:426:Dr.Web Mail Scanner:/nonexistent:/sbin/nologin</programlisting>
<sect1 id="dads-misc">
<title>Miscellanea</title>
<para>The files <filename>pkg-comment</filename>,
<filename>pkg-descr</filename>, and <filename>pkg-plist</filename>
<para>The files
<filename>pkg-descr</filename> and <filename>pkg-plist</filename>
should each be double-checked. If you are reviewing a port and feel
they can be worded better, do so.</para>
@ -6156,6 +6154,7 @@ PATCHFILES= xdvi-18.patch1.gz xdvi-18.patch2.gz
original porter reasonably promptly. If you really do not want to have
your address here, set it to "ports@FreeBSD.org".]
MAINTAINER= asami@FreeBSD.org
COMMENT= A DVI Previewer for the X Window System
[dependencies -- can be empty]
RUN_DEPENDS= gs:${PORTSDIR}/print/ghostscript