Improve the description of generating the shar file based on

discussion in -ports@.

s/FreeBSD/&os;/ in the neighborhood
This commit is contained in:
Doug Barton 2010-07-19 02:03:45 +00:00
parent b507e5d52b
commit 564b75f067
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=36053

View file

@ -369,12 +369,17 @@ PLIST_DIRS= lib/X11/oneko</programlisting>
linkend="porting-dads">DOs and DON'Ts</link> section.</para>
<para>Now that you are happy with your port, the only thing remaining
is to put it in the main FreeBSD ports tree and make everybody else
is to put it in the main &os; ports tree and make everybody else
happy about it too. We do not need your <filename>work</filename>
directory or the <filename>pkgname.tgz</filename> package, so delete
them now. Next, simply include the output of <command>shar `find
port_dir`</command> in a bug report and send it with the
&man.send-pr.1; program (see <ulink url="&url.articles.contributing;/contrib-how.html#CONTRIB-GENERAL">Bug
them now. Next, assuming your port is called oneko,
<command>cd</command> to the directory above where the
<literal>oneko</literal> directory is located, and then type the
following: <command>shar `find oneko` &gt; oneko.shar</command>
<para>Include your <literal>oneko.shar</literal> file in a bug report
and send it with the &man.send-pr.1; program (see
<ulink url="&url.articles.contributing;/contrib-how.html#CONTRIB-GENERAL">Bug
Reports and General Commentary</ulink> for more information about
&man.send-pr.1;). Be sure to classify the bug report as category
<literal>ports</literal> and class
@ -382,7 +387,7 @@ PLIST_DIRS= lib/X11/oneko</programlisting>
<literal>confidential</literal>!).
Also add a short description of the program you ported
to the <quote>Description</quote> field of the PR and
the shar to the <quote>Fix</quote> field.</para>
the shar file to the <quote>Fix</quote> field.</para>
<note>
<para>You can make our work a lot easier, if you use a good
@ -402,10 +407,10 @@ PLIST_DIRS= lib/X11/oneko</programlisting>
<para>After you have submitted your port, please be patient.
Sometimes it can take a few months before a port is included
in FreeBSD, although it might only take a few days. You can
in &os;, although it might only take a few days. You can
view the list of <ulink
url="http://www.FreeBSD.org/cgi/query-pr-summary.cgi?category=ports">ports
waiting to be committed to FreeBSD</ulink>.</para>
waiting to be committed to &os;</ulink>.</para>
<para>Once we have looked at your port, we will get back to you if necessary, and put
it in the tree. Your name will also appear in the list of
@ -616,7 +621,7 @@ PLIST_DIRS= lib/X11/oneko</programlisting>
<para>Unpack a copy of the tarball in a private directory and make
whatever changes are necessary to get the port to compile properly
under the current version of FreeBSD. Keep <emphasis>careful
under the current version of &os;. Keep <emphasis>careful
track</emphasis> of everything you do, as you will be automating
the process shortly. Everything, including the deletion, addition,
or modification of files should be doable using an automated script
@ -631,7 +636,7 @@ PLIST_DIRS= lib/X11/oneko</programlisting>
<note>
<para>Unless explicitly stated, patch files, scripts, and other
files you have created and contributed to the FreeBSD ports
files you have created and contributed to the &os; ports
collection are assumed to be covered by the standard BSD copyright
conditions.</para>
</note>