svn commit: r47693 - head/en_US.ISO8859-1/books/porters-handbook/upgrading
Mathieu Arnold <[email protected]>
| Newsgroups | gmane.os.freebsd.devel.cvs.doc |
|---|---|
| Message-ID | <[email protected]> |
Author: mat
Date: Wed Oct 28 13:40:40 2015
New Revision: 47693
URL: https://svnweb.freebsd.org/changeset/doc/47693
Log:
Whitespace, indentation, translators can ignore.
Noticed by: igor
Sponsored by: Absolight
Modified:
head/en_US.ISO8859-1/books/porters-handbook/upgrading/chapter.xml
Modified: head/en_US.ISO8859-1/books/porters-handbook/upgrading/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/porters-handbook/upgrading/chapter.xml Wed Oct 28 00:53:13 2015 (r47692)
+++ head/en_US.ISO8859-1/books/porters-handbook/upgrading/chapter.xml Wed Oct 28 13:40:40 2015 (r47693)
@@ -13,7 +13,7 @@
<para>When a port is not the most recent version available from the
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>
<para>When working with more than a few ports, it will probably be
@@ -24,13 +24,13 @@
dependencies.</para>
<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 the <link
- xlink:href="https://bugs.freebsd.org/search/">FreeBSD
- Problem Report (PR) or bug database</link>.
- Select <literal>Ports Tree</literal> in
- the <literal>Product</literal> dropdown, and enter the name of the port in the
- <literal>Summary</literal> field.</para>
+ To do this, there are two options. There is a searchable
+ interface to the <link
+ xlink:href="https://bugs.freebsd.org/search/">FreeBSD Problem
+ Report (PR) or bug database</link>. Select <literal>Ports
+ Tree</literal> in the <literal>Product</literal> dropdown, and
+ enter the name of the port in the <literal>Summary</literal>
+ field.</para>
<para>However, sometimes people forget to put the name of the port
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
patch, copy the file that needs patching to
- <filename><replaceable>something</replaceable>.orig</filename>, save the changes to
- <filename><replaceable>something</replaceable></filename> and then create the
- patch:</para>
+ <filename><replaceable>something</replaceable>.orig</filename>,
+ save the changes to
+ <filename><replaceable>something</replaceable></filename> and then
+ create the patch:</para>
<informalexample>
<screen>&prompt.user; <userinput>diff -u <replaceable>something</replaceable>.orig <replaceable>something</replaceable> > something.diff</userinput></screen>
@@ -187,8 +188,8 @@
<callout arearefs="svn-FreeBSD-org">
<para><link
xlink:href="https://svn.FreeBSD.org/">svn.FreeBSD.org</link>
- is the &os; public <application>Subversion</application> server.
- See <link
+ is the &os; public <application>Subversion</application>
+ server. See <link
xlink:href="&url.books.handbook;/svn.html#svn-mirrors">Subversion
mirror sites</link> for more information.</para>
</callout>
@@ -297,87 +298,89 @@
<sect2 xml:id="moved-and-updating-updating">
<title><filename>/usr/ports/UPDATING</filename></title>
- <para>If upgrading the port requires special steps like
- changing configuration files or running a specific program,
- it must be documented in this file. The format of
- an entry in this file is as follows:</para>
+ <para>If upgrading the port requires special steps like
+ changing configuration files or running a specific program,
+ it must be documented in this file. The format of
+ an entry in this file is as follows:</para>
- <programlisting>YYYYMMDD:
+ <programlisting>YYYYMMDD:
AFFECTS: users of portcategory/portname
AUTHOR: Your name <Your email address>
Special instructions</programlisting>
- <tip>
- <para>When including exact
- <application>portmaster</application>,
- <application>portupgrade</application>, and/or
- <application>pkg</application> instructions, please make sure
- 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>
-
- <para>As shown, the command will only work with
- <application>bourne shells</application>. Instead, use the
- form shown below, which will work with both
- <application>bourne shell</application> and
- <application>c-shell</application>:</para>
-
- <screen>&prompt.root; <userinput>pkg delete -g -f docbook-xml\* docbook-sk\* docbook\[2345\]\?\?-\* docbook-4\*</userinput></screen>
- </tip>
-
- <note>
- <para>It is recommended that the AFFECTS line contains a glob
- matching all the ports affected by the entry so that automated
- tools can parse it as easily as possible. If an update
- concerns all the existing <application>BIND 9</application>
- versions the <literal>AFFECTS</literal> content must be
- <literal>users of dns/bind9*</literal>, it must
- <emphasis>not</emphasis> be <literal>users of BIND
- 9</literal></para>
- </note>
+ <tip>
+ <para>When including exact
+ <application>portmaster</application>,
+ <application>portupgrade</application>, and/or
+ <application>pkg</application> instructions, please make
+ sure
+ 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>
+
+ <para>As shown, the command will only work with
+ <application>bourne shells</application>. Instead, use the
+ form shown below, which will work with both
+ <application>bourne shell</application> and
+ <application>c-shell</application>:</para>
+
+ <screen>&prompt.root; <userinput>pkg delete -g -f docbook-xml\* docbook-sk\* docbook\[2345\]\?\?-\* docbook-4\*</userinput></screen>
+ </tip>
+
+ <note>
+ <para>It is recommended that the AFFECTS line contains a glob
+ matching all the ports affected by the entry so that
+ automated tools can parse it as easily as possible. If an
+ update concerns all the existing <application>BIND
+ 9</application> versions the <literal>AFFECTS</literal>
+ content must be <literal>users of dns/bind9*</literal>, it
+ must <emphasis>not</emphasis> be <literal>users of BIND
+ 9</literal></para>
+ </note>
</sect2>
<sect2 xml:id="moved-and-updating-moved">
<title><filename>/usr/ports/MOVED</filename></title>
- <para>This file is used to
- 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,
- and why. If the port was removed, the section detailing where
- it was moved can be left blank. Each section must be
- separated by the <literal>|</literal> (pipe) character, like
- so:</para>
-
- <programlisting>old name|new name (blank for deleted)|date of move|reason</programlisting>
-
- <para>The date must be entered in the form
- <literal>YYYY-MM-DD</literal>. New entries are added to
- the top of the file to keep it in reverse chronological order,
- with the last entry first.</para>
-
- <para>If a port was removed but has since been restored,
- delete the line in this file that states that it was
- removed.</para>
-
- <para>If a port was renamed and then renamed back to its original
- name, add a new one with the intermediate name to the
- old name, and remove the old entry as to not create a
- loop.</para>
-
- <note>
- <para>Any changes must be validated with
- <command>Tools/scripts/MOVEDlint.awk</command>.</para>
-
- <para>If using a ports directory other than <filename>/usr/ports</filename>, use:</para>
-
- <informalexample>
- <screen>&prompt.user; <userinput>cd <replaceable>/home/user/ports</replaceable></userinput>
-&prompt.user; <userinput>env PORTSDIR=$PWD Tools/scripts/MOVEDlint.awk</userinput></screen>
- </informalexample>
- </note>
+ <para>This file is used to
+ 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,
+ and why. If the port was removed, the section detailing where
+ it was moved can be left blank. Each section must be
+ separated by the <literal>|</literal> (pipe) character, like
+ so:</para>
+
+ <programlisting>old name|new name (blank for deleted)|date of move|reason</programlisting>
+
+ <para>The date must be entered in the form
+ <literal>YYYY-MM-DD</literal>. New entries are added to
+ the top of the file to keep it in reverse chronological order,
+ with the last entry first.</para>
+
+ <para>If a port was removed but has since been restored,
+ delete the line in this file that states that it was
+ removed.</para>
+
+ <para>If a port was renamed and then renamed back to its
+ original name, add a new one with the intermediate name to the
+ old name, and remove the old entry as to not create a
+ loop.</para>
+
+ <note>
+ <para>Any changes must be validated with
+ <command>Tools/scripts/MOVEDlint.awk</command>.</para>
+
+ <para>If using a ports directory other than
+ <filename>/usr/ports</filename>, use:</para>
+
+ <informalexample>
+ <screen>&prompt.user; <userinput>cd <replaceable>/home/user/ports</replaceable></userinput>
+ &prompt.user; <userinput>env PORTSDIR=$PWD Tools/scripts/MOVEDlint.awk</userinput></screen>
+ </informalexample>
+ </note>
</sect2>
</sect1>
</chapter>
_______________________________________________
[email protected] mailing list
https://lists.freebsd.org/mailman/listinfo/svn-doc-all
To unsubscribe, send any mail to "[email protected]"