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

Turn the diff/shar creation into examples.

Browse source 
Sponsored by:	Absolight
This commit is contained in:
Mathieu Arnold 2017-06-20 11:29:58 +00:00
parent e998d669a3
commit 4134284c42
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=50386
1 changed files with 37 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml
View file

@ -357,21 +357,45 @@ lib/X11/oneko/mouse.xpm</programlisting>
now.</para>
</important>
<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:
<command>shar `find oneko` &gt; oneko.shar</command></para>
<para>Next, either create a &man.patch.1;, or a &man.shar.1; file.
Assuming the port is called <literal>oneko</literal> and is in
the <literal>games</literal> category.</para>
<para>A diff created from a <application>Subversion</application>
checkout of the ports tree is also acceptable. Add all the
files with <command>svn add</command>. <command>cd</command> to
the base of the ports tree so full paths to the changed files
are included in the diff, then generate the diff with
<command>svn diff</command>. For example, <command>svn diff
games/oneko &gt; oneko.diff</command>.</para>
<example xml:id="porting-submitting-diff">
<title>Creating a <filename>.diff</filename> for a New
Port</title>
<para>Submit <filename>oneko.shar</filename> or
<para>Add all the files with <command>svn add</command>.
<command>cd</command> to the base of the ports tree so full
paths to the changed files are included in the diff, then
generate the diff with <command>svn diff</command>. For
example:</para>
<screen>&prompt.user; <userinput>svn add .</userinput>
&prompt.user; <userinput>cd ../..</userinput>
&prompt.user; <userinput>svn diff <replaceable>games/oneko</replaceable> &gt; <replaceable>oneko.diff</replaceable></userinput></screen>
<important>
<para>To make it easier for committers to apply the patch on
their working copy of the ports tree, please generate the
<filename>.diff</filename> from the base of your ports
tree.</para>
</important>
</example>
<example xml:id="porting-submitting-shar">
<title>Creating a <filename>.shar</filename> for a New
Port</title>
<para><command>cd</command> to the directory above where the
port directory is located, and use <command>shar</command> to
create the archive:</para>
<screen>&prompt.user; <userinput>cd ..</userinput>
&prompt.user; <userinput>shar `find <replaceable>oneko</replaceable>` &gt; <replaceable>oneko</replaceable>.shar</userinput></screen>
</example>
<para>Submit one of <filename>oneko.shar</filename> or
<filename>oneko.diff</filename> with the <link
xlink:href="https://bugs.freebsd.org/submit/">bug submission
form</link>. Use product <quote>Ports &amp;