Bug#445642: developers-reference: Please document the use of "Homepage:" in debian/control
Package: developers-reference
Version: 3.3.8
Severity: normal
Tags: patch
Recent discussions in debian-devel (See
http://lists.debian.org/debian-devel/2007/09/msg00628.html and the following
thread) have concluded that promoting the use of "Homepage:" in
debian/control should happen.
Amongst the listed actions, updating The DevRef has been identified.
Please find attached a proposed patch that replaces the current
recommendation of using a pseudo-field in the package descriptions by this
"new" field.
Proposed patch attached.
-- System Information:
Debian Release: lenny/sid
APT prefers unstable
APT policy: (500, 'unstable'), (1, 'experimental')
Architecture: i386 (i686)
Kernel: Linux 2.6.22-2-686 (SMP w/1 CPU core)
Locale: LANG=fr_FR.UTF-8, LC_CTYPE=fr_FR.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash
developers-reference depends on no packages.
Versions of packages developers-reference recommends:
ii debian-policy 3.7.2.2 Debian Policy Manual and related d
-- no debconf information
--- developers-reference.sgml 2007-10-07 15:00:28.060363454 +0200
+++ developers-reference-new.sgml 2007-10-07 15:54:21.744640619 +0200
@@ -3983,29 +3983,10 @@
<sect1 id="bpp-upstream-info">
<heading>Upstream home page</heading>
<p>
-We recommend that you add the URL for the package's home page to the
-package description in <file>debian/control</file>. This information
-should be added at the
-end of description, using the following format:
-
-<example> .
- Homepage: http://some-project.some-place.org/</example>
-
-Note the spaces prepending the line, which serves to break the lines
-correctly. To see an example of how this displays, see <url
-id="&url-eg-desc-upstream-info;">.
- <p>
-If there is no home page for the software, this should naturally be
-left out.
- <p>
-Note that we expect this field will eventually be replaced by a proper
-<file>debian/control</file> field understood by <prgn>dpkg</prgn> and
-<tt>&packages-host;</tt>. 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
- <tt>/^ Homepage: [^ ]*$/</tt>,
- as this allows <file>packages.debian.org</file> to parse it correctly.</p>
+We recommend that you add the URL for the package's home page in the
+<tt>Homepage</tt> field of the <tt>Source</tt> section in
+<file>debian/control</file>. Adding this information in the package
+description itself is considered deprecated.
</sect1>
<sect1 id="bpp-vcs">
@@ -4050,7 +4031,7 @@
repository of the <package>vim</package> package is shown. Note how the
URL is in the <tt>svn://</tt> scheme (instead of <tt>svn+ssh://</tt>) and
how it points to the <file>trunk/</file> branch. The use of the
-<tt>XS-Vcs-Browser</tt> field described above is also shown.
+<tt>XS-Vcs-Browser</tt> and <tt>Homepage</tt> fields described above is also shown.
<example>
Source: vim
Section: editors
@@ -4058,6 +4039,7 @@
<snip>
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
+ Homepage: http://www.vim.org
</example>
</sect1>
</sect>
Reply to: