Date: Sun, 12 Jan 2014 20:13:18 +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: r43481 - head/en_US.ISO8859-1/books/porters-handbook Message-ID: <201401122013.s0CKDIsT092144@svn.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: wblock Date: Sun Jan 12 20:13:18 2014 New Revision: 43481 URL: http://svnweb.freebsd.org/changeset/doc/43481 Log: Clarify and simplify the Submitting the New Port section. Remove redundant wording, break up into more paragraphs, use send-pr field names consistently, remove unnecessary informal use of "you". Modified: head/en_US.ISO8859-1/books/porters-handbook/book.xml Modified: head/en_US.ISO8859-1/books/porters-handbook/book.xml ============================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/book.xml Sun Jan 12 19:43:30 2014 (r43480) +++ head/en_US.ISO8859-1/books/porters-handbook/book.xml Sun Jan 12 20:13:18 2014 (r43481) @@ -447,43 +447,43 @@ PLIST_DIRS= lib/X11/oneko</programlistin <sect1 xml:id="porting-submitting"> <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> 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 - 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>pkgname.tgz</filename> package, so delete them now. - Next, assuming your port is called oneko, + <filename>pkgname.tgz</filename> package, so delete them now.</para> + <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 - <literal>oneko</literal> directory is located, and then type - the following: + <literal>oneko</literal> directory is located, and then type: <command>shar `find oneko` > oneko.shar</command></para> - <para>Include your <literal>oneko.shar</literal> file in a bug - report and send it with the &man.send-pr.1; program (see + <para>Include <filename>oneko.shar</filename> in a bug + report and send it with &man.send-pr.1;. See <link xlink:href="&url.articles.contributing;/contrib-how.html#CONTRIB-GENERAL">Bug Reports and General Commentary</link> for more information - about &man.send-pr.1;). Be sure to classify the bug report - as category <literal>ports</literal> and class - <literal>change-request</literal> (Do not mark the report - <literal>confidential</literal>!). Also add a short - description of the program you ported to the - <quote>Description</quote> field of the PR (e.g., perhaps a + about &man.send-pr.1;.</para> + <para>Classify the bug report + as Category <literal>ports</literal> and Class + <literal>change-request</literal>. Do <emphasis>not</emphasis> mark the report + <literal>confidential</literal>! Add a short + description of the program to the + Description field of the PR (perhaps a 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> - <para>You can make our work a lot easier, if you use a good - description in the synopsis of the problem report. We + <para>Giving a good + description in the synopsis of the problem report makes the work of port committers a lot easier. We prefer something like <quote>New port: <category>/<portname> <short description of - the port></quote> for new ports. If you stick to this - scheme, the chance that someone will take a look at your PR - soon is much better.</para> + the port></quote> for new ports. Using this + scheme makes it easier and faster to begin the work of committing + the new port.</para> </note> <para>One more time, <emphasis>do not include the original @@ -492,14 +492,13 @@ PLIST_DIRS= lib/X11/oneko</programlistin <command>make package</command></emphasis>; and, do use &man.shar.1; for new ports, not &man.diff.1;.</para> - <para>After you have submitted your port, please be patient. - Sometimes it can take a few months before a port is included - in &os;, although it might only take a few days. You can - view the list of <link - xlink:href="http://www.FreeBSD.org/cgi/query-pr-summary.cgi?category=ports">ports - PRs waiting to be committed to &os;</link>.</para> + <para>After submitting the port, please be patient. The time needed + to include a new port in &os; can vary from a few days to a + a few months. The list + 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"></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 be added to the list of <link xlink:href="&url.articles.contributors;/contrib-additional.html">Additional
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201401122013.s0CKDIsT092144>