svn commit: r45113 - head/en_US.ISO8859-1/books/porters-handbook/quick-porting
Warren Block
wblock at FreeBSD.org
Tue Jun 24 14:18:21 UTC 2014
Author: wblock
Date: Tue Jun 24 14:18:20 2014
New Revision: 45113
URL: http://svnweb.freebsd.org/changeset/doc/45113
Log:
Clarify language in quick-porting chapter. Remove "you" and "your"
where possible.
Modified:
head/en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml
Modified: head/en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml Tue Jun 24 13:52:01 2014 (r45112)
+++ head/en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml Tue Jun 24 14:18:20 2014 (r45113)
@@ -10,20 +10,20 @@
<title>Quick Porting</title>
- <para>This section tells you how to quickly create a new port. In
- many cases, it is not sufficient, so you will have to read
- further on into the document.</para>
+ <para>This section describes how to quickly create a new port. For
+ applications where this quick method is not adequate, the full
+ <quote>Slow Porting</quote> process is described in
+ <xref linkend="slow-porting"/>.</para>
<para>First, get the original tarball and put it into
<varname>DISTDIR</varname>, which defaults to
<filename>/usr/ports/distfiles</filename>.</para>
<note>
- <para>The following assumes that the software compiled
- out-of-the-box, i.e., there was absolutely no change required
- for the port to work on your &os; box. If you needed to
- change something, you will have to refer to the next section
- too.</para>
+ <para>The following steps assume that the software compiled
+ out-of-the-box. In other words, absolutely no changes were required
+ for the application to work on a &os; system. If anything had to be
+ changed, refer to <xref linkend="slow-porting"/>.</para>
</note>
<note>
@@ -64,12 +64,12 @@ COMMENT= Cat chasing a mouse all over th
is being phased out.</para>
</note>
- <para>See if you can figure it out. Do not worry about the
+ <para>Try to figure it out. Do not worry about the
contents of the <literal>$FreeBSD$</literal>
line, it will be filled in automatically by
<application>Subversion</application> when the port is
- imported to our main ports tree. You can find a more detailed
- example in the
+ imported to our main ports tree. A more detailed
+ example is shown in the
<link linkend="porting-samplem">sample Makefile</link>
section.</para>
</sect1>
@@ -94,7 +94,7 @@ COMMENT= Cat chasing a mouse all over th
<note>
<para>This is <emphasis>not</emphasis> a manual or an
in-depth description on how to use or compile the port!
- <emphasis>Please be careful if you are copying from the
+ <emphasis>Please be careful when copying from the
<filename>README</filename> or manpage</emphasis>; too
often they are not a concise description of the port or
are in an awkward format (e.g., manpages have justified
@@ -124,7 +124,7 @@ COMMENT= Cat chasing a mouse all over th
moved, was renamed, or is hosted elsewhere.</para>
</note>
- <para>The following example shows how your
+ <para>The following example shows how the
<filename>pkg-descr</filename> should look:</para>
<programlisting>This is a port of oneko, in which a cat chases a poor mouse all over
@@ -161,9 +161,9 @@ lib/X11/oneko/mouse.xpm
on the packing list.</para>
<note>
- <para>It is recommended that you keep all the filenames in
+ <para>It is recommended to keep all the filenames in
this file sorted alphabetically. It will make verifying
- the changes when you upgrade the port much easier.</para>
+ changes when upgrading the port much easier.</para>
</note>
<note>
@@ -207,13 +207,13 @@ PLIST_DIRS= lib/X11/oneko</programlistin
<xref linkend="plist-dir-cleaning"/>.</para>
</note>
- <para>The price for this way of listing port's files and
- directories is that you cannot use command sequences
- described in &man.pkg-create.8;. Therefore, it is suitable
+ <para>The price for this way of listing a port's files and
+ directories is that then command sequences
+ described in &man.pkg-create.8; cannot be used. Therefore, it is suitable
only for simple ports and makes them even simpler. At the
same time, it has the advantage of reducing the number of
files in the ports collection. Please consider using this
- technique before you resort to
+ technique before resorting to
<filename>pkg-plist</filename>.</para>
<para>Later we will see how <filename>pkg-plist</filename>
@@ -234,9 +234,9 @@ PLIST_DIRS= lib/X11/oneko</programlistin
<sect1 xml:id="porting-testing">
<title>Testing the Port</title>
- <para>You should make sure that the port rules do exactly what
- you want them to do, including packaging up the port. These
- are the important points you need to verify.</para>
+ <para>Make sure that the port rules do exactly what
+ is desired, including packaging up the port. These
+ are the important points to verify:</para>
<itemizedlist>
<listitem>
@@ -315,14 +315,14 @@ PLIST_DIRS= lib/X11/oneko</programlistin
</sect1>
<sect1 xml:id="porting-portlint">
- <title>Checking Your Port with
+ <title>Checking the Port with
<command>portlint</command></title>
- <para>Please use <command>portlint</command> to see if your port
+ <para>Please use <command>portlint</command> to see if the port
conforms to our guidelines. The
<package role="port">ports-mgmt/portlint</package>
- program is part of the ports collection. In particular, you
- may want to check if the
+ program is part of the ports collection. In particular,
+ check that the
<link linkend="porting-samplem">Makefile</link> is in the
right shape and the
<link linkend="porting-pkgname">package</link> is named
@@ -336,7 +336,7 @@ PLIST_DIRS= lib/X11/oneko</programlistin
<link linkend="porting-dads">DOs and DON'Ts</link>
section.</para>
- <para>Once happy with your port, the only thing remaining is to
+ <para>Once happy with the port, the only thing remaining is to
put it in the main &os; ports tree and make everybody else
happy about it too. We do not need the
<filename>work</filename> directory or the
@@ -375,7 +375,7 @@ PLIST_DIRS= lib/X11/oneko</programlistin
<para>One more time, <emphasis>do not include the original
source distfile, the <filename>work</filename> directory, or
- the package you built with
+ the package built with
<command>make package</command></emphasis>; and, do use
&man.shar.1; for new ports, not &man.diff.1;.</para>
More information about the svn-doc-head
mailing list