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

Whitespace, indentation, translators can ignore.

Browse source 
Noticed by:	igor
Sponsored by:	Absolight
This commit is contained in:
Mathieu Arnold 2015-10-28 13:40:40 +00:00
parent 0a4ab32374
commit 2b932a83b6
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=47693
1 changed files with 74 additions and 71 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

145
en_US.ISO8859-1/books/porters-handbook/upgrading/chapter.xml
View file

@ -13,7 +13,7 @@
<para>When a port is not the most recent version available from the <para>When a port is not the most recent version available from the
authors, update the local working copy of authors, update the local working copy of
<filename>/usr/ports</filename>. The port might have already been <filename>/usr/ports</filename>. The port might have already been
updated to the new version.</para> updated to the new version.</para>
<para>When working with more than a few ports, it will probably be <para>When working with more than a few ports, it will probably be
@ -24,13 +24,13 @@
dependencies.</para> dependencies.</para>
<para>The next step is to see if there is an update already pending. <para>The next step is to see if there is an update already pending.
To do this, there are two options. There is a searchable interface To do this, there are two options. There is a searchable
to the <link interface to the <link
xlink:href="https://bugs.freebsd.org/search/">FreeBSD xlink:href="https://bugs.freebsd.org/search/">FreeBSD Problem
Problem Report (PR) or bug database</link>. Report (PR) or bug database</link>. Select <literal>Ports
Select <literal>Ports Tree</literal> in Tree</literal> in the <literal>Product</literal> dropdown, and
the <literal>Product</literal> dropdown, and enter the name of the port in the enter the name of the port in the <literal>Summary</literal>
<literal>Summary</literal> field.</para> field.</para>
<para>However, sometimes people forget to put the name of the port <para>However, sometimes people forget to put the name of the port
into the Summary field in an unambiguous fashion. In that into the Summary field in an unambiguous fashion. In that
@ -62,9 +62,10 @@
<para>To create a suitable <command>diff</command> for a single <para>To create a suitable <command>diff</command> for a single
patch, copy the file that needs patching to patch, copy the file that needs patching to
<filename><replaceable>something</replaceable>.orig</filename>, save the changes to <filename><replaceable>something</replaceable>.orig</filename>,
<filename><replaceable>something</replaceable></filename> and then create the save the changes to
patch:</para> <filename><replaceable>something</replaceable></filename> and then
create the patch:</para>
<informalexample> <informalexample>
<screen>&prompt.user; <userinput>diff -u <replaceable>something</replaceable>.orig <replaceable>something</replaceable> &gt; something.diff</userinput></screen> <screen>&prompt.user; <userinput>diff -u <replaceable>something</replaceable>.orig <replaceable>something</replaceable> &gt; something.diff</userinput></screen>
@ -187,8 +188,8 @@
<callout arearefs="svn-FreeBSD-org"> <callout arearefs="svn-FreeBSD-org">
<para><link <para><link
xlink:href="https://svn.FreeBSD.org/">svn.FreeBSD.org</link> xlink:href="https://svn.FreeBSD.org/">svn.FreeBSD.org</link>
is the &os; public <application>Subversion</application> server. is the &os; public <application>Subversion</application>
See <link server. See <link
xlink:href="&url.books.handbook;/svn.html#svn-mirrors">Subversion xlink:href="&url.books.handbook;/svn.html#svn-mirrors">Subversion
mirror sites</link> for more information.</para> mirror sites</link> for more information.</para>
</callout> </callout>
@ -297,87 +298,89 @@
<sect2 xml:id="moved-and-updating-updating"> <sect2 xml:id="moved-and-updating-updating">
<title><filename>/usr/ports/UPDATING</filename></title> <title><filename>/usr/ports/UPDATING</filename></title>
<para>If upgrading the port requires special steps like <para>If upgrading the port requires special steps like
changing configuration files or running a specific program, changing configuration files or running a specific program,
it must be documented in this file. The format of it must be documented in this file. The format of
an entry in this file is as follows:</para> an entry in this file is as follows:</para>
<programlisting>YYYYMMDD: <programlisting>YYYYMMDD:
AFFECTS: users of portcategory/portname AFFECTS: users of portcategory/portname
AUTHOR: Your name &lt;Your email address&gt; AUTHOR: Your name &lt;Your email address&gt;
Special instructions</programlisting> Special instructions</programlisting>
<tip> <tip>
<para>When including exact <para>When including exact
<application>portmaster</application>, <application>portmaster</application>,
<application>portupgrade</application>, and/or <application>portupgrade</application>, and/or
<application>pkg</application> instructions, please make sure <application>pkg</application> instructions, please make
to get the shell escaping right. For example, do sure
<emphasis>not</emphasis> use:</para> to get the shell escaping right. For example, do
<emphasis>not</emphasis> use:</para>
<screen>&prompt.root; <userinput>pkg delete -g -f docbook-xml* docbook-sk* docbook[2345]??-* docbook-4*</userinput></screen> <screen>&prompt.root; <userinput>pkg delete -g -f docbook-xml* docbook-sk* docbook[2345]??-* docbook-4*</userinput></screen>
<para>As shown, the command will only work with <para>As shown, the command will only work with
<application>bourne shells</application>. Instead, use the <application>bourne shells</application>. Instead, use the
form shown below, which will work with both form shown below, which will work with both
<application>bourne shell</application> and <application>bourne shell</application> and
<application>c-shell</application>:</para> <application>c-shell</application>:</para>
<screen>&prompt.root; <userinput>pkg delete -g -f docbook-xml\* docbook-sk\* docbook\[2345\]\?\?-\* docbook-4\*</userinput></screen> <screen>&prompt.root; <userinput>pkg delete -g -f docbook-xml\* docbook-sk\* docbook\[2345\]\?\?-\* docbook-4\*</userinput></screen>
</tip> </tip>
<note> <note>
<para>It is recommended that the AFFECTS line contains a glob <para>It is recommended that the AFFECTS line contains a glob
matching all the ports affected by the entry so that automated matching all the ports affected by the entry so that
tools can parse it as easily as possible. If an update automated tools can parse it as easily as possible. If an
concerns all the existing <application>BIND 9</application> update concerns all the existing <application>BIND
versions the <literal>AFFECTS</literal> content must be 9</application> versions the <literal>AFFECTS</literal>
<literal>users of dns/bind9*</literal>, it must content must be <literal>users of dns/bind9*</literal>, it
<emphasis>not</emphasis> be <literal>users of BIND must <emphasis>not</emphasis> be <literal>users of BIND
9</literal></para> 9</literal></para>
</note> </note>
</sect2> </sect2>
<sect2 xml:id="moved-and-updating-moved"> <sect2 xml:id="moved-and-updating-moved">
<title><filename>/usr/ports/MOVED</filename></title> <title><filename>/usr/ports/MOVED</filename></title>
<para>This file is used to <para>This file is used to
list moved or removed ports. Each line in the file is made list moved or removed ports. Each line in the file is made
up of the name of the port, where the port was moved, when, up of the name of the port, where the port was moved, when,
and why. If the port was removed, the section detailing where and why. If the port was removed, the section detailing where
it was moved can be left blank. Each section must be it was moved can be left blank. Each section must be
separated by the <literal>|</literal> (pipe) character, like separated by the <literal>|</literal> (pipe) character, like
so:</para> so:</para>
<programlisting>old name|new name (blank for deleted)|date of move|reason</programlisting> <programlisting>old name|new name (blank for deleted)|date of move|reason</programlisting>
<para>The date must be entered in the form <para>The date must be entered in the form
<literal>YYYY-MM-DD</literal>. New entries are added to <literal>YYYY-MM-DD</literal>. New entries are added to
the top of the file to keep it in reverse chronological order, the top of the file to keep it in reverse chronological order,
with the last entry first.</para> with the last entry first.</para>
<para>If a port was removed but has since been restored, <para>If a port was removed but has since been restored,
delete the line in this file that states that it was delete the line in this file that states that it was
removed.</para> removed.</para>
<para>If a port was renamed and then renamed back to its original <para>If a port was renamed and then renamed back to its
name, add a new one with the intermediate name to the original name, add a new one with the intermediate name to the
old name, and remove the old entry as to not create a old name, and remove the old entry as to not create a
loop.</para> loop.</para>
<note> <note>
<para>Any changes must be validated with <para>Any changes must be validated with
<command>Tools/scripts/MOVEDlint.awk</command>.</para> <command>Tools/scripts/MOVEDlint.awk</command>.</para>
<para>If using a ports directory other than <filename>/usr/ports</filename>, use:</para> <para>If using a ports directory other than
<filename>/usr/ports</filename>, use:</para>
<informalexample> <informalexample>
<screen>&prompt.user; <userinput>cd <replaceable>/home/user/ports</replaceable></userinput> <screen>&prompt.user; <userinput>cd <replaceable>/home/user/ports</replaceable></userinput>
&prompt.user; <userinput>env PORTSDIR=$PWD Tools/scripts/MOVEDlint.awk</userinput></screen> &prompt.user; <userinput>env PORTSDIR=$PWD Tools/scripts/MOVEDlint.awk</userinput></screen>
</informalexample> </informalexample>
</note> </note>
</sect2> </sect2>
</sect1> </sect1>
</chapter> </chapter>