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

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

diff --git a/debian/changelog b/debian/changelog
index 5097a9d843f25ea71bcef587f4376af65efa94f2..a366ede04e2c2ae841fa1bdf6d261ba647f8847c 100644 (file)
--- a/debian/changelog
+++ b/debian/changelog
@@ -41,6 +41,7 @@ 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
 
  -- Raphael Hertzog <hertzog@debian.org>  Sat, 04 Aug 2007 17:51:06 +0200
 

diff --git a/developers-reference.sgml b/developers-reference.sgml
index dedfb10d28161eaa19330e902ab2c8c88af823ee..4c33b9e5033274da9be832e16d37017248c87631 100644 (file)
--- a/developers-reference.sgml
+++ b/developers-reference.sgml
@@ -7,7 +7,7 @@
   <!ENTITY % dynamicdata  SYSTEM "dynamic.ent" > %dynamicdata;
 
   <!-- CVS revision of this document -->
-  <!ENTITY cvs-rev "$Revision: 1.335 $">
+  <!ENTITY cvs-rev "$Revision: 1.336 $">
 
   <!-- if you are translating this document, please notate the CVS
        revision of the original developer's reference in cvs-en-rev -->
@@ -3983,29 +3983,10 @@ this about this particular package, if you have information related to both).
         <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,8 @@ In the following example, an instance of the field for a Subversion
 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>Vcs-Browser</tt> field described above is also shown.
+<tt>Vcs-Browser</tt> and <tt>Homepage</tt> fields described above is
+also shown.
 <example>
   Source: vim
   Section: editors
@@ -4058,6 +4040,7 @@ how it points to the <file>trunk/</file> branch. The use of the
   &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
 </example>
         </sect1>
       </sect>