Date: Fri, 14 Sep 2012 17:27:39 +0000 (UTC) From: Warren Block <wblock@FreeBSD.org> To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r39542 - head/en_US.ISO8859-1/books/porters-handbook Message-ID: <201209141727.q8EHRd1H070604@svn.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: wblock Date: Fri Sep 14 17:27:38 2012 New Revision: 39542 URL: http://svn.freebsd.org/changeset/doc/39542 Log: Whitespace-only fixes: indentation, wrapping long lines, adding blank lines. Translators, please ignore. Modified: head/en_US.ISO8859-1/books/porters-handbook/book.sgml Modified: head/en_US.ISO8859-1/books/porters-handbook/book.sgml ============================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/book.sgml Fri Sep 14 17:09:52 2012 (r39541) +++ head/en_US.ISO8859-1/books/porters-handbook/book.sgml Fri Sep 14 17:27:38 2012 (r39542) @@ -3419,38 +3419,46 @@ ALWAYS_KEEP_DISTFILES= yes <para>This is a one-line description of the port. 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> - </listitem> - <listitem> - <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> - </listitem> - <listitem> - <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> - </listitem> - <listitem> - <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> - </listitem> - </orderedlist> - <para>Here is an example:</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> + </listitem> + + <listitem> + <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> + </listitem> + + <listitem> + <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> + </listitem> + + <listitem> + <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> + </listitem> + </orderedlist> + + <para>Here is an example:</para> <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 expression which is being looked up in the <command>ldconfig -r</command> output. Values such as - <literal>intl.9</literal> and <literal>intl.[5-7]</literal> - are allowed. The first pattern, - <literal>intl.9</literal>, will match only version 9 of - intl, while - <literal>intl.[5-7]</literal>, will match any of: - <literal>intl.5</literal>, <literal>intl.6</literal> or + <literal>intl.9</literal> and + <literal>intl.[5-7]</literal> are allowed. The first + pattern, <literal>intl.9</literal>, will match only + version 9 of intl, while <literal>intl.[5-7]</literal>, + will match any of: <literal>intl.5</literal>, + <literal>intl.6</literal> or <literal>intl.7</literal>.</para> </note> @@ -3589,8 +3597,8 @@ ALWAYS_KEEP_DISTFILES= yes xmlcatmgr:${PORTSDIR}/textproc/xmlcatmgr</programlisting> <para>will check if the file or directory - <filename>/usr/local/news/bin/innd</filename> exists, and build - and install it from the <filename>news/inn</filename> + <filename>/usr/local/news/bin/innd</filename> exists, and + build and install it from the <filename>news/inn</filename> subdirectory of the ports tree if it is not found. It will also see if an executable called <command>xmlcatmgr</command> is in the search path, and @@ -3839,22 +3847,22 @@ ALWAYS_KEEP_DISTFILES= yes in <xref linkend="building"/>, while <application>autoconf</application>, <application>automake</application> and - <application>libtool</application> are described in <xref - linkend="using-autotools"/>. + <application>libtool</application> are described in + <xref linkend="using-autotools"/>. <application>Perl</application> related variables are - described in <xref linkend="using-perl"/>. X11 variables are - listed in <xref linkend="using-x11"/>. <xref - linkend="using-gnome"/> deals with GNOME and <xref - linkend="using-kde"/> with KDE related variables. <xref - linkend="using-java"/> documents Java variables, while - <xref linkend="using-php"/> contains information on + described in <xref linkend="using-perl"/>. X11 variables + are listed in <xref linkend="using-x11"/>. + <xref linkend="using-gnome"/> deals with GNOME and + <xref linkend="using-kde"/> with KDE related variables. + <xref linkend="using-java"/> documents Java variables, while + <xref linkend="using-php"/> contains information on <application>Apache</application>, <application>PHP</application> and PEAR modules. - <application>Python</application> is discussed in <xref - linkend="using-python"/>, while - <application>Ruby</application> in <xref - linkend="using-ruby"/>. <xref linkend="using-sdl"/> provides - variables used for <application>SDL</application> + <application>Python</application> is discussed in + <xref linkend="using-python"/>, while + <application>Ruby</application> in + <xref linkend="using-ruby"/>. <xref linkend="using-sdl"/> + provides variables used for <application>SDL</application> applications and finally, <xref linkend="using-xfce"/> contains information on <application>Xfce</application>.</para> @@ -4555,9 +4563,9 @@ CONFIGURE_ARGS+= --enable-foo the <literal>make config</literal> dialog. But the application's configure script detects the library present in the system and includes its support in the resulting - executable. Now when the user decides to remove libfoo from the - system, the ports system does not protest (no dependency on - libfoo was recorded) but the application breaks.</para> + executable. Now when the user decides to remove libfoo from + the system, the ports system does not protest (no dependency + on libfoo was recorded) but the application breaks.</para> <example> <title>Correct Handling of an Option</title> @@ -5594,19 +5602,26 @@ IGNORE= may not be redistributed because <tbody> <row> <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> <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> <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> <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> </tbody> </tgroup> @@ -6532,8 +6547,8 @@ do-configure: <maketarget>build</maketarget> target.</para> <para>Qt applications often are written to be cross-platform - and often X11/Unix is not the platform they are developed on, - which in turn often leads to certain loose ends, + and often X11/Unix is not the platform they are developed + on, which in turn often leads to certain loose ends, like:</para> <itemizedlist> @@ -7114,10 +7129,11 @@ QT_COMPONENTS= moc_build qmake_build rcc <literal>yes</literal> (gets any version), <literal>20</literal>, <literal>22</literal>, <literal>20-22</literal>, <literal>20+</literal>, - etc. The default APACHE version is - <literal>22</literal>. More details are available in - <filename>ports/Mk/bsd.apache.mk</filename> and at - <ulink url="http://wiki.freebsd.org/Apache/">wiki.freebsd.org/Apache/</ulink>.</entry>; + etc. The default APACHE version is + <literal>22</literal>. More details are available + in <filename>ports/Mk/bsd.apache.mk</filename> and + at <ulink + url="http://wiki.freebsd.org/Apache/">wiki.freebsd.org/Apache/</ulink>.</entry>; </row> <row> @@ -8283,7 +8299,8 @@ CONFIGURE_ARGS+= --enable-wxpython <title>Defined Variables</title> <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"> <title>Variables Defined for Ports That Use @@ -9169,8 +9186,8 @@ CFLAGS+= -DLUA_VERSION_STRING="${VER_STR role="package">databases/postgresql90-client</filename> port. An associated variable, <makevar>WANT_PGSQL_VER</makevar>, may be set to - values such as 83, 84, 90, 91 or 92. You can declare a - minimum or maximum value; + values such as 83, 84, 90, 91 or 92. You can declare + a minimum or maximum value; <makevar>WANT_PGSQL_VER</makevar>= <literal> 90+</literal> will cause the port to depend on a minimum version of 9.0.</entry> @@ -10398,8 +10415,8 @@ as .putsy.conf and edit it.</programlist <sect1 id="svn-diff"> <title>Using <literal>SVN</literal> to Make Patches</title> - <para>If you can, please submit a &man.svn.1 diff; they are easier to - handle than diffs between <quote>new and old</quote> + <para>If you can, please submit a &man.svn.1 diff; they are + easier to handle than diffs between <quote>new and old</quote> directories. Plus it is easier for you to see what you have changed and to update your diff if something is modified in the Ports Collection from when you started to work on it until @@ -10419,7 +10436,8 @@ as .putsy.conf and edit it.</programlist </callout> <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> </callout> </calloutlist> @@ -10443,8 +10461,8 @@ as .putsy.conf and edit it.</programlist <para>This will try to merge the differences between your patch and current SVN; watch the output carefully. The letter in front of each file name indicates what was done - with it. See <xref linkend="table-svn-up"/> for a complete - list.</para> + with it. See <xref linkend="table-svn-up"/> for a + complete list.</para> </callout> </calloutlist> @@ -10483,10 +10501,11 @@ as .putsy.conf and edit it.</programlist <para>If you get <literal>C</literal> as a result of <command>svn update</command> it means something changed in 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 - to inspect the changes anyway, since &man.svn.1; + local changes and those from the repository. It is always a + good idea to inspect the changes anyway, since &man.svn.1; 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; of the files against SVN:</para> @@ -15966,10 +15985,10 @@ exec %%LOCALBASE%%/bin/java -jar %%DATAD <listitem> <para><makevar>FORBIDDEN</makevar> is used for ports that - contain a security vulnerability or induce grave - concern regarding the security of a FreeBSD system with - a given port installed (e.g., a reputably insecure program - or a program that provides easily exploitable services). + contain a security vulnerability or induce grave concern + regarding the security of a FreeBSD system with a given + port installed (e.g., a reputably insecure program or a + program that provides easily exploitable services). Ports should be marked as <makevar>FORBIDDEN</makevar> as soon as a particular piece of software has a vulnerability and there is no released upgrade. Ideally @@ -16236,8 +16255,8 @@ IGNORE= POINTYHAT is not supported if it is missing.</para> <para>Check the <ulink - url="http://www.freebsd.org/cgi/man.cgi">man pages</ulink> to - see if the function used is a <acronym>POSIX</acronym> + url="http://www.freebsd.org/cgi/man.cgi">man pages</ulink> + to see if the function used is a <acronym>POSIX</acronym> interface (in the <quote>STANDARDS</quote> section of the man page).</para>
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201209141727.q8EHRd1H070604>