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

Clarify and simplify the Submitting the New Port section. Remove

Browse source 
redundant wording, break up into more paragraphs, use send-pr field names
consistently, remove unnecessary informal use of "you".
This commit is contained in:
Warren Block 2014-01-12 20:13:18 +00:00
parent fb26a79f37
commit 24a1a087c7
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=43481
1 changed files with 27 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

55
en_US.ISO8859-1/books/porters-handbook/book.xml
View file

@ -447,43 +447,43 @@ PLIST_DIRS= lib/X11/oneko</programlisting>
<sect1 xml:id="porting-submitting"> <sect1 xml:id="porting-submitting">
<title>Submitting the New Port</title> <title>Submitting the New Port</title>
<para>Before you submit the new port, make sure you have read <para>Before submitting the new port, read
the <link linkend="porting-dads">DOs and DON'Ts</link> the <link linkend="porting-dads">DOs and DON'Ts</link>
section.</para> section.</para>
<para>Now that you are happy with your port, the only thing <para>Once happy with your port, the only thing
remaining is to put it in the main &os; ports tree and make remaining is to put it in the main &os; ports tree and make
everybody else happy about it too. We do not need your everybody else happy about it too. We do not need the
<filename>work</filename> directory or the <filename>work</filename> directory or the
<filename>pkgname.tgz</filename> package, so delete them now. <filename>pkgname.tgz</filename> package, so delete them now.</para>
Next, assuming your port is called oneko, <para>Next, build the &man.shar.1; file. Assuming the port is called <literal>oneko</literal>,
<command>cd</command> to the directory above where the <command>cd</command> to the directory above where the
<literal>oneko</literal> directory is located, and then type <literal>oneko</literal> directory is located, and then type:
the following:
<command>shar `find oneko` &gt; oneko.shar</command></para> <command>shar `find oneko` &gt; oneko.shar</command></para>
<para>Include your <literal>oneko.shar</literal> file in a bug <para>Include <filename>oneko.shar</filename> in a bug
report and send it with the &man.send-pr.1; program (see report and send it with &man.send-pr.1;. See
<link <link
xlink:href="&url.articles.contributing;/contrib-how.html#CONTRIB-GENERAL">Bug xlink:href="&url.articles.contributing;/contrib-how.html#CONTRIB-GENERAL">Bug
Reports and General Commentary</link> for more information Reports and General Commentary</link> for more information
about &man.send-pr.1;). Be sure to classify the bug report about &man.send-pr.1;.</para>
as category <literal>ports</literal> and class <para>Classify the bug report
<literal>change-request</literal> (Do not mark the report as Category <literal>ports</literal> and Class
<literal>confidential</literal>!). Also add a short <literal>change-request</literal>. Do <emphasis>not</emphasis> mark the report
description of the program you ported to the <literal>confidential</literal>! Add a short
<quote>Description</quote> field of the PR (e.g., perhaps a description of the program to the
Description field of the PR (perhaps a
short version of the <varname>COMMENT</varname>), and add short version of the <varname>COMMENT</varname>), and add
the shar file to the <quote>Fix</quote> field.</para> the <filename>.shar</filename> file to the Fix field.</para>
<note> <note>
<para>You can make our work a lot easier, if you use a good <para>Giving a good
description in the synopsis of the problem report. We description in the synopsis of the problem report makes the work of port committers a lot easier. We
prefer something like <quote>New port: prefer something like <quote>New port:
&lt;category&gt;/&lt;portname&gt; &lt;short description of &lt;category&gt;/&lt;portname&gt; &lt;short description of
the port&gt;</quote> for new ports. If you stick to this the port&gt;</quote> for new ports. Using this
scheme, the chance that someone will take a look at your PR scheme makes it easier and faster to begin the work of committing
soon is much better.</para> the new port.</para>
</note> </note>
<para>One more time, <emphasis>do not include the original <para>One more time, <emphasis>do not include the original
@ -492,14 +492,13 @@ PLIST_DIRS= lib/X11/oneko</programlisting>
<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>
<para>After you have submitted your port, please be patient. <para>After submitting the port, please be patient. The time needed
Sometimes it can take a few months before a port is included to include a new port in &os; can vary from a few days to a
in &os;, although it might only take a few days. You can a few months. The list
view the list of <link of pending port <acronym>PR</acronym>s can be viewed at <link
xlink:href="http://www.FreeBSD.org/cgi/query-pr-summary.cgi?category=ports">ports xlink:href="http://www.FreeBSD.org/cgi/query-pr-summary.cgi?category=ports"></link>.</para>
PRs waiting to be committed to &os;</link>.</para>
<para>Once we have looked at your port, we will get back to you <para>After looking at the new port, we will reply
if necessary, and put it in the tree. Your name will also if necessary, and put it in the tree. Your name will also
be added to the list of <link be added to the list of <link
xlink:href="&url.articles.contributors;/contrib-additional.html">Additional xlink:href="&url.articles.contributors;/contrib-additional.html">Additional