Replace abused <emphasis> tags with <literal> tags.

[developers-reference.git] / best-pkging-practices.dbk

diff --git a/best-pkging-practices.dbk b/best-pkging-practices.dbk
index ca1bfb38ffe1ee40eb9538d01e66b17c364f11ab..0376b3aa9d189a38e00bd80d56d2751f65125733 100644 (file)
--- a/best-pkging-practices.dbk
+++ b/best-pkging-practices.dbk
@@ -331,30 +331,10 @@ this about this particular package, if you have information related to both).
 <section id="bpp-upstream-info">
 <title>Upstream home page</title>
 <para>
-We recommend that you add the URL for the package's home page to the package
-description in <filename>debian/control</filename>.  This information should be
-added at the end of description, using the following format:
-</para>
-<screen>
- .
-  Homepage: http://some-project.some-place.org/
-</screen>
-<para>
-Note the spaces prepending the line, which serves to break the lines correctly.
-To see an example of how this displays, see <ulink
-url="&url-eg-desc-upstream-info;"></ulink>.
-</para>
-<para>
-If there is no home page for the software, this should naturally be left out.
-</para>
-<para>
-Note that we expect this field will eventually be replaced by a proper
-<filename>debian/control</filename> field understood by <command>dpkg</command>
-and <literal>&packages-host;</literal>.  If you don't want to bother
-migrating the home page from the description to this field, you should probably
-wait until that is available.  Please make sure that this line matches the
-regular expression <literal>/^ Homepage: [^ ]*$/</literal>, as this allows
-<filename>&packages-host;</filename> to parse it correctly.
+We recommend that you add the URL for the package's home page in the
+<literal>Homepage</literal> field of the <literal>Source</literal> section
+in <filename>debian/control</filename>.  Adding this information in the
+package description itself is considered deprecated.
 </para>
 </section>
 
@@ -365,7 +345,7 @@ There are additional fields for the location of the Version Control System in
 <filename>debian/control</filename>.
 </para>
 <section id="s6.2.5.1">
-<title>XS-Vcs-Browser</title>
+<title>Vcs-Browser</title>
 <para>
 Value of this field should be a <literal>http://</literal> URL pointing to a
 web-browsable copy of the Version Control System repository used to maintain
@@ -379,7 +359,7 @@ tagged as <literal>pending</literal> in the bug tracking system).
 </section>
 
 <section id="s6.2.5.2">
-<title>XS-Vcs-*</title>
+<title>Vcs-*</title>
 <para>
 Value of this field should be a string identifying unequivocally the location
 of the Version Control System repository used to maintain the given package, if
@@ -408,15 +388,17 @@ of the <systemitem role="package">vim</systemitem> package is shown.  Note how
 the URL is in the <literal>svn://</literal> scheme (instead of
 <literal>svn+ssh://</literal>) and how it points to the
 <filename>trunk/</filename> branch.  The use of the
-<literal>XS-Vcs-Browser</literal> field described above is also shown.
+<literal>Vcs-Browser</literal> and <literal>Homepage</literal> fields
+described above is also shown.
 </para>
 <screen>
   Source: vim
   Section: editors
   Priority: optional
   &lt;snip&gt;
-  XS-Vcs-Svn: svn://svn.debian.org/svn/pkg-vim/trunk/packages/vim
-  XS-Vcs-Browser: http://svn.debian.org/wsvn/pkg-vim/trunk/packages/vim
+  Vcs-Svn: svn://svn.debian.org/svn/pkg-vim/trunk/packages/vim
+  Vcs-Browser: http://svn.debian.org/wsvn/pkg-vim/trunk/packages/vim
+  Homepage: http://www.vim.org
 </screen>
 </section>
 
@@ -807,7 +789,7 @@ If you don't do so, the whole template will not be translated as long as a
 translator will send you an update.
 </para>
 <para>
-To <emphasis role="strong">unfuzzy</emphasis> translations, you can proceed the
+To <literal>unfuzzy</literal> translations, you can proceed the
 following way:
 </para>
 <orderedlist numeration="arabic">
@@ -1464,7 +1446,7 @@ you avoid needless duplication of the same data into eleven or more .debs, one
 per each architecture.  While this adds some extra overhead into the
 <filename>Packages</filename> files, it saves a lot of disk space on Debian
 mirrors.  Separating out architecture-independent data also reduces processing
-time of <command>lintian</command> or <command>linda</command> (see <xref
+time of <command>lintian</command> (see <xref
 linkend="tools-lint"/> ) when run over the entire Debian archive.
 </para>
 </section>
@@ -1734,8 +1716,8 @@ Some debug packages may contain an entire special debugging build of a library
 or other binary, but most of them can save space and build time by instead
 containing separated debugging symbols that gdb can find and load on the fly
 when debugging a program or library.  The convention in Debian is to keep these
-symbols in <filename>/usr/lib/debug/path</filename>, where
-<emphasis>path</emphasis> is the path to the executable or library.  For
+symbols in <filename>/usr/lib/debug/<replaceable>path</replaceable></filename>, where
+<replaceable>path</replaceable> is the path to the executable or library.  For
 example, debugging symbols for <filename>/usr/bin/foo</filename> go in
 <filename>/usr/lib/debug/usr/bin/foo</filename>, and debugging symbols for
 <filename>/usr/lib/libfoo.so.1</filename> go in