[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#391023: marked as done (please document the Vcs-* field for describing package's version control system)

Your message dated Thu, 28 Feb 2008 11:47:02 +0000
with message-id <E1JUhE6-00078P-V8@ries.debian.org>
and subject line Bug#391023: fixed in developers-reference 3.3.9
has caused the Debian Bug report #391023,
regarding please document the Vcs-* field for describing package's version control system
to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
Bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact owner@bugs.debian.org
immediately.)


-- 
391023: http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=391023
Debian Bug Tracking System
Contact owner@bugs.debian.org with problems
--- Begin Message --- 
Package: developers-reference
Version: 3.3.7
Severity: wishlist
Tags: patch

The PTS web interface now support displaying of information carried in
Source packages via "XS-" fields. At the moment it supports the
rendering of the information carried by the family of fields Vcs-*,
where "*" is a tag referring to the most popular version control
systems. For a preview of this feature you can have a look at the PTS
page of vim [1]. More information are available in a blog post of mine
on planet [2].

According to some discussion on debian-devel and to the fact that
several people started adding the field, it seems that this kind of
information is appreciated by DDs and it should be properly documented
in the developers reference, which already document the other features
of the PTS.

The attached patch for the developers reference document the support for
the Vcs-* family of fields.

Could you please review it and possibly apply to the developers
reference package?

Many thanks in advance,

Cheers.

[1] http://packages.qa.debian.org/v/vim.html
[2] http://www.bononia.it/~zack/blog/posts/xs-x-vcs-XXX.html

-- System Information:
Debian Release: testing/unstable
  APT prefers unstable
  APT policy: (500, 'unstable'), (500, 'testing')
Architecture: i386 (i686)
Shell:  /bin/sh linked to /bin/bash
Kernel: Linux 2.6.18-aquarium
Locale: LANG=it_IT.UTF-8, LC_CTYPE=it_IT.UTF-8 (charmap=UTF-8)

developers-reference depends on no packages.

Versions of packages developers-reference recommends:
ii  debian-policy                 3.7.2.1    Debian Policy Manual and related d

-- no debconf information

diff -ur developers-reference-3.3.7.orig/developers-reference.sgml developers-reference-3.3.7/developers-reference.sgml
--- developers-reference-3.3.7.orig/developers-reference.sgml	2006-10-01 14:03:59.000000000 +0200
+++ developers-reference-3.3.7/developers-reference.sgml	2006-10-01 14:52:06.000000000 +0200
@@ -1535,6 +1535,47 @@
 to remove it later and you won't be able to edit it either. The only thing
 that you can do is send a second news item that will deprecate the
 information contained in the previous one.
+  
+  <sect2 id="pts-web-fields">Extra information shown in the PTS web interface
+  <p>
+  In addition to the information discussed above, the PTS web interface shows
+  information available in source packages as <em>extra source fields</em>
+  (i.e. fields starting with <tt>XS-</tt> in source package control files). The
+  following fields are currently supported:
+  <taglist>
+    <tag><tt>XS-Vcs-*</tt>
+      <item>
+      (where <em>Vcs</em> is the acronym for <em>Version Control System</em>,
+      and <tt>*</tt> stands for one of the Vcs supported by the package
+      tracking system: <tt>bzr</tt>, <tt>cvs</tt>, <tt>darcs</tt>,
+      <tt>git</tt>, <tt>hg</tt>, <tt>svn</tt>, <tt>tla</tt>)
+      <p>
+      Value of this field should be an URL pointing to where the repository of
+      the given package is available. The information is meant to be useful for
+      the final user of the package in case he is looking for the latest work
+      done on the package (e.g. for the patch fixing a bug tagged as
+      <tt>pending</tt> in the bug tracking system). The URL should be meaningful
+      for the given Vcs and should better be version agnostic. If possible, the
+      URL should point to a resource accessible to the final user and from which
+      the latest repository snapshot can be easily obtained.
+      </p>
+      <p>
+      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.
+      <example>
+  Source: vim
+  Section: editors
+  Priority: optional
+  &lt;snip&gt;
+  XS-Vcs-Svn: svn://svn.debian.org/svn/pkg-vim/trunk/packages/vim
+      </example>
+      </p>
+    </item>
+  </taglist>
+  </p>
+  </sect2>
 
     <sect id="ddpo">Developer's packages overview
 	<p>

--- End Message ---
--- Begin Message --- 
Source: developers-reference
Source-Version: 3.3.9

We believe that the bug you reported is fixed in the latest version of
developers-reference, which is due to be installed in the Debian FTP archive:

developers-reference-fr_3.3.9_all.deb
  to pool/main/d/developers-reference/developers-reference-fr_3.3.9_all.deb
developers-reference_3.3.9.dsc
  to pool/main/d/developers-reference/developers-reference_3.3.9.dsc
developers-reference_3.3.9.tar.gz
  to pool/main/d/developers-reference/developers-reference_3.3.9.tar.gz
developers-reference_3.3.9_all.deb
  to pool/main/d/developers-reference/developers-reference_3.3.9_all.deb



A summary of the changes between this version and the previous one is
attached.

Thank you for reporting the bug, which will now be closed.  If you
have further comments please address them to 391023@bugs.debian.org,
and the maintainer will reopen the bug report if appropriate.

Debian distribution maintenance software
pp.
W. Martin Borgert <debacle@debian.org> (supplier of updated developers-reference package)

(This message was generated automatically at their request; if you
believe that there is a problem with it please contact the archive
administrators by mailing ftpmaster@debian.org)


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Format: 1.7
Date: Thu, 28 Feb 2008 10:16:40 +0000
Source: developers-reference
Binary: developers-reference developers-reference-fr
Architecture: source all
Version: 3.3.9
Distribution: unstable
Urgency: low
Maintainer: Debian Documentation Project <debian-doc@lists.debian.org>
Changed-By: W. Martin Borgert <debacle@debian.org>
Description: 
 developers-reference - guidelines and information for Debian developers
 developers-reference-fr - guidelines and information for Debian developers, in French
Closes: 356720 373816 374220 384178 391023 401415 405453 405818 410159 412757 413320 414291 419507 420540 422750 427832 428846 445642
Changes: 
 developers-reference (3.3.9) unstable; urgency=low
 .
   [ Andreas Barth ]
   * Packaging changes:
     - bump standards-version to 3.7.3 (no change)
     - fix debian/copyright
     - move debhelper to Build-Depends.
     - add pdf for French version.
   * Document changes to stable release management. Closes: #414291
   * Debconf error templates no longer discouraged. Thanks,
     Christian Perrier. Closes: #427832
   * Keyring now uses RT. Closes: #428846
   * Document -dbg-packages within BPs. Thanks, Joey Hess. Closes: #420540
   * NMUs now also close bugs. Thanks, Lucas Nussbaum. Closes: #419507
   * Fix documentation about gender neutral. Closes: #384178
   * Fix typo. Closes: #405453
   * More details on how to write documentation. Thanks, Josh Triplett.
     Closes: #422750
   * Add XS-Vcs-*. Thanks to Stefano Zacchiroli. Closes: #391023
   * Small brushup to debconf description. Thanks, Thomas Huriaux.
     Closes: #401415
   * Document Team-Maintainence better. Thanks, Lucas Nussbaum.
     Closes: #410159
   * Add link to more removal ressources. Thanks, Adam D. Barratt,
     Justin Pryzby. Closes: #412757, #356720
   * Repacking source packages need to be documented in copyright.
     Thanks, Russ Allbery. Closes: #413320
   * Better describe version of debian native packages NMUs. Closes: #405818
   * Source, HTML and text are now encoded in UTF-8. Thanks, Jörg Sommer.
     Closes: #373816
   * Source is now DocBook XML instead of debiandoc. Closes: #374220
 .
   [ Raphael Hertzog ]
   * Add a link to enrico's excellent Debian Community Guidelines.
   * Recommend the use of DSA's request tracker instead of mailing them.
   * Remove reference to #debian-sf, #debian-bsd which don't exist anymore. Put
     a reference to #debian-dpkg instead.
   * Remove all stuff concerning non-US.
   * Update information concerning Alioth.
   * Update information concerning the Package Tracking System.
   * 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
   * Add Vcs-Svn and Vcs-Browser fields pointing to the new SVN
     repository.
Files: 
 f3b140613997b6255f00cff2e0652485 866 doc optional developers-reference_3.3.9.dsc
 feb746b3608063b4994472866f39709e 871922 doc optional developers-reference_3.3.9.tar.gz
 4f4292fe8246f1338115266a7ff61349 660596 doc optional developers-reference_3.3.9_all.deb
 72e49ae1cd934ebaaf411beb7852214d 663386 doc optional developers-reference-fr_3.3.9_all.deb

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.6 (GNU/Linux)

iD8DBQFHxpwF+xM0OFfj6IgRAqdfAJwNNiihs+QYn2KuGIFWNz4UbU0rYACZATqP
VNJKCAzzbxObVoiWSiSsPDY=
=9TZe
-----END PGP SIGNATURE-----

--- End Message ---
Reply to: