Clarify language in quick-porting chapter. Remove "you" and "your"

where possible.
This commit is contained in:
Warren Block 2014-06-24 14:18:20 +00:00
parent 4963c4ca05
commit 22ed8ca125
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=45113

View file

@ -10,20 +10,20 @@
<title>Quick Porting</title> <title>Quick Porting</title>
<para>This section tells you how to quickly create a new port. In <para>This section describes how to quickly create a new port. For
many cases, it is not sufficient, so you will have to read applications where this quick method is not adequate, the full
further on into the document.</para> <quote>Slow Porting</quote> process is described in
<xref linkend="slow-porting"/>.</para>
<para>First, get the original tarball and put it into <para>First, get the original tarball and put it into
<varname>DISTDIR</varname>, which defaults to <varname>DISTDIR</varname>, which defaults to
<filename>/usr/ports/distfiles</filename>.</para> <filename>/usr/ports/distfiles</filename>.</para>
<note> <note>
<para>The following assumes that the software compiled <para>The following steps assume that the software compiled
out-of-the-box, i.e., there was absolutely no change required out-of-the-box. In other words, absolutely no changes were required
for the port to work on your &os; box. If you needed to for the application to work on a &os; system. If anything had to be
change something, you will have to refer to the next section changed, refer to <xref linkend="slow-porting"/>.</para>
too.</para>
</note> </note>
<note> <note>
@ -64,12 +64,12 @@ COMMENT= Cat chasing a mouse all over the screen
is being phased out.</para> is being phased out.</para>
</note> </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>&dollar;FreeBSD&dollar;</literal> contents of the <literal>&dollar;FreeBSD&dollar;</literal>
line, it will be filled in automatically by line, it will be filled in automatically by
<application>Subversion</application> when the port is <application>Subversion</application> when the port is
imported to our main ports tree. You can find a more detailed imported to our main ports tree. A more detailed
example in the example is shown in the
<link linkend="porting-samplem">sample Makefile</link> <link linkend="porting-samplem">sample Makefile</link>
section.</para> section.</para>
</sect1> </sect1>
@ -94,7 +94,7 @@ COMMENT= Cat chasing a mouse all over the screen
<note> <note>
<para>This is <emphasis>not</emphasis> a manual or an <para>This is <emphasis>not</emphasis> a manual or an
in-depth description on how to use or compile the port! 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 <filename>README</filename> or manpage</emphasis>; too
often they are not a concise description of the port or often they are not a concise description of the port or
are in an awkward format (e.g., manpages have justified are in an awkward format (e.g., manpages have justified
@ -124,7 +124,7 @@ COMMENT= Cat chasing a mouse all over the screen
moved, was renamed, or is hosted elsewhere.</para> moved, was renamed, or is hosted elsewhere.</para>
</note> </note>
<para>The following example shows how your <para>The following example shows how the
<filename>pkg-descr</filename> should look:</para> <filename>pkg-descr</filename> should look:</para>
<programlisting>This is a port of oneko, in which a cat chases a poor mouse all over <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> on the packing list.</para>
<note> <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 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>
<note> <note>
@ -207,13 +207,13 @@ PLIST_DIRS= lib/X11/oneko</programlisting>
<xref linkend="plist-dir-cleaning"/>.</para> <xref linkend="plist-dir-cleaning"/>.</para>
</note> </note>
<para>The price for this way of listing port's files and <para>The price for this way of listing a port's files and
directories is that you cannot use command sequences directories is that then command sequences
described in &man.pkg-create.8;. Therefore, it is suitable described in &man.pkg-create.8; cannot be used. Therefore, it is suitable
only for simple ports and makes them even simpler. At the only for simple ports and makes them even simpler. At the
same time, it has the advantage of reducing the number of same time, it has the advantage of reducing the number of
files in the ports collection. Please consider using this files in the ports collection. Please consider using this
technique before you resort to technique before resorting to
<filename>pkg-plist</filename>.</para> <filename>pkg-plist</filename>.</para>
<para>Later we will see how <filename>pkg-plist</filename> <para>Later we will see how <filename>pkg-plist</filename>
@ -234,9 +234,9 @@ PLIST_DIRS= lib/X11/oneko</programlisting>
<sect1 xml:id="porting-testing"> <sect1 xml:id="porting-testing">
<title>Testing the Port</title> <title>Testing the Port</title>
<para>You should make sure that the port rules do exactly what <para>Make sure that the port rules do exactly what
you want them to do, including packaging up the port. These is desired, including packaging up the port. These
are the important points you need to verify.</para> are the important points to verify:</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
@ -315,14 +315,14 @@ PLIST_DIRS= lib/X11/oneko</programlisting>
</sect1> </sect1>
<sect1 xml:id="porting-portlint"> <sect1 xml:id="porting-portlint">
<title>Checking Your Port with <title>Checking the Port with
<command>portlint</command></title> <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 conforms to our guidelines. The
<package role="port">ports-mgmt/portlint</package> <package role="port">ports-mgmt/portlint</package>
program is part of the ports collection. In particular, you program is part of the ports collection. In particular,
may want to check if the check that the
<link linkend="porting-samplem">Makefile</link> is in the <link linkend="porting-samplem">Makefile</link> is in the
right shape and the right shape and the
<link linkend="porting-pkgname">package</link> is named <link linkend="porting-pkgname">package</link> is named
@ -336,7 +336,7 @@ PLIST_DIRS= lib/X11/oneko</programlisting>
<link linkend="porting-dads">DOs and DON'Ts</link> <link linkend="porting-dads">DOs and DON'Ts</link>
section.</para> 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 put it in the main &os; ports tree and make everybody else
happy about it too. We do not need the happy about it too. We do not need the
<filename>work</filename> directory or the <filename>work</filename> directory or the
@ -375,7 +375,7 @@ PLIST_DIRS= lib/X11/oneko</programlisting>
<para>One more time, <emphasis>do not include the original <para>One more time, <emphasis>do not include the original
source distfile, the <filename>work</filename> directory, or 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 <command>make package</command></emphasis>; and, do use
&man.shar.1; for new ports, not &man.diff.1;.</para> &man.shar.1; for new ports, not &man.diff.1;.</para>