Whitespace-only fixes: indentation, wrapping long lines, adding blank

lines.  Translators, please ignore.
This commit is contained in:
Warren Block 2012-09-14 17:27:38 +00:00
parent 2e9319a593
commit 3baf59ab03
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=39542

View file

@ -3419,6 +3419,7 @@ ALWAYS_KEEP_DISTFILES= yes
<para>This is a one-line description of the port. <para>This is a one-line description of the port.
Please respect the following rules:</para> Please respect the following rules:</para>
<orderedlist> <orderedlist>
<listitem> <listitem>
<para>Try to keep the COMMENT value at no longer than 70 <para>Try to keep the COMMENT value at no longer than 70
@ -3426,30 +3427,37 @@ ALWAYS_KEEP_DISTFILES= yes
&man.pkg.info.1; utility to display a one-line summary &man.pkg.info.1; utility to display a one-line summary
of the port;</para> of the port;</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Do <emphasis>not</emphasis> include the package <para>Do <emphasis>not</emphasis> include the package
name (or version number of the software);</para> name (or version number of the software);</para>
</listitem> </listitem>
<listitem> <listitem>
<para>The comment should begin with a capital and end <para>The comment should begin with a capital and end
without a period;</para> without a period;</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Do not start with an indefinite article (i.e. <para>Do not start with an indefinite article (i.e.
A or An);</para> A or An);</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Names are capitalized (e.g. Apache, JavaScript, <para>Names are capitalized (e.g. Apache, JavaScript,
Perl);</para> Perl);</para>
</listitem> </listitem>
<listitem> <listitem>
<para>For lists of words use the Oxford comma (e.g. <para>For lists of words use the Oxford comma (e.g.
green, red<emphasis>,</emphasis> and blue);</para> green, red<emphasis>,</emphasis> and blue);</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Spell check the text.</para> <para>Spell check the text.</para>
</listitem> </listitem>
</orderedlist> </orderedlist>
<para>Here is an example:</para> <para>Here is an example:</para>
<programlisting>COMMENT= Cat chasing a mouse all over the screen</programlisting> <programlisting>COMMENT= Cat chasing a mouse all over the screen</programlisting>
@ -3548,12 +3556,12 @@ ALWAYS_KEEP_DISTFILES= yes
<para>The <replaceable>lib</replaceable> part is a regular <para>The <replaceable>lib</replaceable> part is a regular
expression which is being looked up in the expression which is being looked up in the
<command>ldconfig -r</command> output. Values such as <command>ldconfig -r</command> output. Values such as
<literal>intl.9</literal> and <literal>intl.[5-7]</literal> <literal>intl.9</literal> and
are allowed. The first pattern, <literal>intl.[5-7]</literal> are allowed. The first
<literal>intl.9</literal>, will match only version 9 of pattern, <literal>intl.9</literal>, will match only
intl, while version 9 of intl, while <literal>intl.[5-7]</literal>,
<literal>intl.[5-7]</literal>, will match any of: will match any of: <literal>intl.5</literal>,
<literal>intl.5</literal>, <literal>intl.6</literal> or <literal>intl.6</literal> or
<literal>intl.7</literal>.</para> <literal>intl.7</literal>.</para>
</note> </note>
@ -3589,8 +3597,8 @@ ALWAYS_KEEP_DISTFILES= yes
xmlcatmgr:${PORTSDIR}/textproc/xmlcatmgr</programlisting> xmlcatmgr:${PORTSDIR}/textproc/xmlcatmgr</programlisting>
<para>will check if the file or directory <para>will check if the file or directory
<filename>/usr/local/news/bin/innd</filename> exists, and build <filename>/usr/local/news/bin/innd</filename> exists, and
and install it from the <filename>news/inn</filename> build and install it from the <filename>news/inn</filename>
subdirectory of the ports tree if it is not found. It will subdirectory of the ports tree if it is not found. It will
also see if an executable called also see if an executable called
<command>xmlcatmgr</command> is in the search path, and <command>xmlcatmgr</command> is in the search path, and
@ -3839,22 +3847,22 @@ ALWAYS_KEEP_DISTFILES= yes
in <xref linkend="building"/>, while in <xref linkend="building"/>, while
<application>autoconf</application>, <application>autoconf</application>,
<application>automake</application> and <application>automake</application> and
<application>libtool</application> are described in <xref <application>libtool</application> are described in
linkend="using-autotools"/>. <xref linkend="using-autotools"/>.
<application>Perl</application> related variables are <application>Perl</application> related variables are
described in <xref linkend="using-perl"/>. X11 variables are described in <xref linkend="using-perl"/>. X11 variables
listed in <xref linkend="using-x11"/>. <xref are listed in <xref linkend="using-x11"/>.
linkend="using-gnome"/> deals with GNOME and <xref <xref linkend="using-gnome"/> deals with GNOME and
linkend="using-kde"/> with KDE related variables. <xref <xref linkend="using-kde"/> with KDE related variables.
linkend="using-java"/> documents Java variables, while <xref linkend="using-java"/> documents Java variables, while
<xref linkend="using-php"/> contains information on <xref linkend="using-php"/> contains information on
<application>Apache</application>, <application>Apache</application>,
<application>PHP</application> and PEAR modules. <application>PHP</application> and PEAR modules.
<application>Python</application> is discussed in <xref <application>Python</application> is discussed in
linkend="using-python"/>, while <xref linkend="using-python"/>, while
<application>Ruby</application> in <xref <application>Ruby</application> in
linkend="using-ruby"/>. <xref linkend="using-sdl"/> provides <xref linkend="using-ruby"/>. <xref linkend="using-sdl"/>
variables used for <application>SDL</application> provides variables used for <application>SDL</application>
applications and finally, <xref linkend="using-xfce"/> applications and finally, <xref linkend="using-xfce"/>
contains information on contains information on
<application>Xfce</application>.</para> <application>Xfce</application>.</para>
@ -4555,9 +4563,9 @@ CONFIGURE_ARGS+= --enable-foo
the <literal>make config</literal> dialog. But the the <literal>make config</literal> dialog. But the
application's configure script detects the library present application's configure script detects the library present
in the system and includes its support in the resulting in the system and includes its support in the resulting
executable. Now when the user decides to remove libfoo from the executable. Now when the user decides to remove libfoo from
system, the ports system does not protest (no dependency on the system, the ports system does not protest (no dependency
libfoo was recorded) but the application breaks.</para> on libfoo was recorded) but the application breaks.</para>
<example> <example>
<title>Correct Handling of an Option</title> <title>Correct Handling of an Option</title>
@ -5594,19 +5602,26 @@ IGNORE= may not be redistributed because of licensing reasons. Please visit <rep
<tbody> <tbody>
<row> <row>
<entry><makevar>USE_PKGCONFIG= yes</makevar></entry> <entry><makevar>USE_PKGCONFIG= yes</makevar></entry>
<entry>The ports uses pkg-config only at build time</entry> <entry>The ports uses pkg-config only at build
time</entry>
</row> </row>
<row> <row>
<entry><makevar>USE_PKGCONFIG= build</makevar></entry> <entry><makevar>USE_PKGCONFIG= build</makevar></entry>
<entry>The ports uses pkg-config only at build time</entry> <entry>The ports uses pkg-config only at build
time</entry>
</row> </row>
<row> <row>
<entry><makevar>USE_PKGCONFIG= run</makevar></entry> <entry><makevar>USE_PKGCONFIG= run</makevar></entry>
<entry>The ports uses pkg-config only at run time</entry> <entry>The ports uses pkg-config only at run
time</entry>
</row> </row>
<row> <row>
<entry><makevar>USE_PKGCONFIG= both</makevar></entry> <entry><makevar>USE_PKGCONFIG= both</makevar></entry>
<entry>The ports uses pkg-config both at build and run time</entry> <entry>The ports uses pkg-config both at build and run
time</entry>
</row> </row>
</tbody> </tbody>
</tgroup> </tgroup>
@ -6532,8 +6547,8 @@ do-configure:
<maketarget>build</maketarget> target.</para> <maketarget>build</maketarget> target.</para>
<para>Qt applications often are written to be cross-platform <para>Qt applications often are written to be cross-platform
and often X11/Unix is not the platform they are developed on, and often X11/Unix is not the platform they are developed
which in turn often leads to certain loose ends, on, which in turn often leads to certain loose ends,
like:</para> like:</para>
<itemizedlist> <itemizedlist>
@ -7115,9 +7130,10 @@ QT_COMPONENTS= moc_build qmake_build rcc_build uic_build</programlisting>
<literal>20</literal>, <literal>22</literal>, <literal>20</literal>, <literal>22</literal>,
<literal>20-22</literal>, <literal>20+</literal>, <literal>20-22</literal>, <literal>20+</literal>,
etc. The default APACHE version is etc. The default APACHE version is
<literal>22</literal>. More details are available in <literal>22</literal>. More details are available
<filename>ports/Mk/bsd.apache.mk</filename> and at in <filename>ports/Mk/bsd.apache.mk</filename> and
<ulink url="http://wiki.freebsd.org/Apache/">wiki.freebsd.org/Apache/</ulink>.</entry> at <ulink
url="http://wiki.freebsd.org/Apache/">wiki.freebsd.org/Apache/</ulink>.</entry>
</row> </row>
<row> <row>
@ -8283,7 +8299,8 @@ CONFIGURE_ARGS+= --enable-wxpython
<title>Defined Variables</title> <title>Defined Variables</title>
<para>The following variables are available in the port (after <para>The following variables are available in the port (after
defining one from <xref linkend="wx-ver-sel-table"/>).</para> defining one from
<xref linkend="wx-ver-sel-table"/>).</para>
<table frame="none"> <table frame="none">
<title>Variables Defined for Ports That Use <title>Variables Defined for Ports That Use
@ -9169,8 +9186,8 @@ CFLAGS+= -DLUA_VERSION_STRING="${VER_STR}"
role="package">databases/postgresql90-client</filename> role="package">databases/postgresql90-client</filename>
port. An associated variable, port. An associated variable,
<makevar>WANT_PGSQL_VER</makevar>, may be set to <makevar>WANT_PGSQL_VER</makevar>, may be set to
values such as 83, 84, 90, 91 or 92. You can declare a values such as 83, 84, 90, 91 or 92. You can declare
minimum or maximum value; a minimum or maximum value;
<makevar>WANT_PGSQL_VER</makevar>= <makevar>WANT_PGSQL_VER</makevar>=
<literal> 90+</literal> will cause the <literal> 90+</literal> will cause the
port to depend on a minimum version of 9.0.</entry> port to depend on a minimum version of 9.0.</entry>
@ -10398,8 +10415,8 @@ as .putsy.conf and edit it.</programlisting>
<sect1 id="svn-diff"> <sect1 id="svn-diff">
<title>Using <literal>SVN</literal> to Make Patches</title> <title>Using <literal>SVN</literal> to Make Patches</title>
<para>If you can, please submit a &man.svn.1 diff; they are easier to <para>If you can, please submit a &man.svn.1 diff; they are
handle than diffs between <quote>new and old</quote> easier to handle than diffs between <quote>new and old</quote>
directories. Plus it is easier for you to see what you have directories. Plus it is easier for you to see what you have
changed and to update your diff if something is modified in changed and to update your diff if something is modified in
the Ports Collection from when you started to work on it until the Ports Collection from when you started to work on it until
@ -10419,7 +10436,8 @@ as .putsy.conf and edit it.</programlisting>
</callout> </callout>
<callout arearefs="svn-FreeBSD-org"> <callout arearefs="svn-FreeBSD-org">
<para><ulink url="http://svn.FreeBSD.org/">svn.FreeBSD.org</ulink> <para><ulink
url="http://svn.FreeBSD.org/">svn.FreeBSD.org</ulink>
is a public <literal>SVN</literal> server.</para> is a public <literal>SVN</literal> server.</para>
</callout> </callout>
</calloutlist> </calloutlist>
@ -10443,8 +10461,8 @@ as .putsy.conf and edit it.</programlisting>
<para>This will try to merge the differences between your <para>This will try to merge the differences between your
patch and current SVN; watch the output carefully. The patch and current SVN; watch the output carefully. The
letter in front of each file name indicates what was done letter in front of each file name indicates what was done
with it. See <xref linkend="table-svn-up"/> for a complete with it. See <xref linkend="table-svn-up"/> for a
list.</para> complete list.</para>
</callout> </callout>
</calloutlist> </calloutlist>
@ -10483,10 +10501,11 @@ as .putsy.conf and edit it.</programlisting>
<para>If you get <literal>C</literal> as a result of <para>If you get <literal>C</literal> as a result of
<command>svn update</command> it means something changed in <command>svn update</command> it means something changed in
the SVN repository and &man.svn.1; was not able to merge your the SVN repository and &man.svn.1; was not able to merge your
local changes and those from the repository. It is always a good idea local changes and those from the repository. It is always a
to inspect the changes anyway, since &man.svn.1; good idea to inspect the changes anyway, since &man.svn.1;
does not know anything about how a port should be, so it might does not know anything about how a port should be, so it might
(and probably will) merge things that do not make sense.</para> (and probably will) merge things that do not make
sense.</para>
<para>The last step is to make a unified &man.diff.1; <para>The last step is to make a unified &man.diff.1;
of the files against SVN:</para> of the files against SVN:</para>
@ -15966,10 +15985,10 @@ exec %%LOCALBASE%%/bin/java -jar %%DATADIR%%/foo.jar "$@"</programlisting>
<listitem> <listitem>
<para><makevar>FORBIDDEN</makevar> is used for ports that <para><makevar>FORBIDDEN</makevar> is used for ports that
contain a security vulnerability or induce grave contain a security vulnerability or induce grave concern
concern regarding the security of a FreeBSD system with regarding the security of a FreeBSD system with a given
a given port installed (e.g., a reputably insecure program port installed (e.g., a reputably insecure program or a
or a program that provides easily exploitable services). program that provides easily exploitable services).
Ports should be marked as <makevar>FORBIDDEN</makevar> Ports should be marked as <makevar>FORBIDDEN</makevar>
as soon as a particular piece of software has a as soon as a particular piece of software has a
vulnerability and there is no released upgrade. Ideally vulnerability and there is no released upgrade. Ideally
@ -16236,8 +16255,8 @@ IGNORE= POINTYHAT is not supported
if it is missing.</para> if it is missing.</para>
<para>Check the <ulink <para>Check the <ulink
url="http://www.freebsd.org/cgi/man.cgi">man pages</ulink> to url="http://www.freebsd.org/cgi/man.cgi">man pages</ulink>
see if the function used is a <acronym>POSIX</acronym> to see if the function used is a <acronym>POSIX</acronym>
interface (in the <quote>STANDARDS</quote> section of the man interface (in the <quote>STANDARDS</quote> section of the man
page).</para> page).</para>