From: hertzog <hertzog@313b444b-1b9f-4f58-a734-7bb04f332e8d>
Date: Mon, 25 Feb 2008 20:38:19 +0000 (+0000)
Subject: * Document the Homepage field. Thanks, Christian Perrier. Closes:
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=commitdiff_plain;h=80ade71891d72895a7c65775abd8e6cc5567af4a;p=developers-reference.git

* Document the Homepage field. Thanks, Christian Perrier. Closes:
  #445642

git-svn-id: svn://anonscm.debian.org/ddp/developers-reference/trunk@4945 313b444b-1b9f-4f58-a734-7bb04f332e8d
---

diff --git a/best-pkging-practices.dbk b/best-pkging-practices.dbk
index 659d0b9..ffddc4f 100644
--- 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>
 
@@ -408,7 +388,8 @@ 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>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
@@ -417,6 +398,7 @@ the URL is in the <literal>svn://</literal> scheme (instead of
   &lt;snip&gt;
   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>
 
diff --git a/debian/changelog b/debian/changelog
index 04b61d6..be148b4 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -41,6 +41,8 @@ developers-reference (3.3.9) unstable; urgency=low
   * Mention Alioth as the main resource for VCS repositories and deprecate
     cvs.debian.org.
   * Remove XS- prefix for Vcs-* fields since dpkg now supports them.
+  * Document the Homepage field. Thanks, Christian Perrier. Closes:
+    #445642
 
  -- Andreas Barth <aba@not.so.argh.org>  Sat, 16 Jun 2007 11:41:41 -0600