[DRE-commits] r1322 - website/src/ruby-pkg-tools

[Vincent Fourmond]

Author: fourmond
Date: 2007-03-20 08:42:50 +0000 (Tue, 20 Mar 2007)
New Revision: 1322

Modified:
   website/src/ruby-pkg-tools/50.sources.en.page
Log:
website: Clarification on debian watch files

Modified: website/src/ruby-pkg-tools/50.sources.en.page
===================================================================
--- website/src/ruby-pkg-tools/50.sources.en.page	2007-03-19 22:58:44 UTC (rev 1321)
+++ website/src/ruby-pkg-tools/50.sources.en.page	2007-03-20 08:42:50 UTC (rev 1322)
@@ -7,7 +7,8 @@
 Since after much discussion it was decided _not_ to put all the upstream
 sources of every package into the Subversion repository, a tool was added
 to this package to help retrieving it.  This tool, @pkg-ruby-get-sources@ is
-described below.
+described below; it can use either the @pkg-ruby-extras.sources@ information 
+file or (preferably) the package's @debian/watch@ file.
 
 h3. Basic usage
 
@@ -36,6 +37,25 @@
 # Using the package's watch file. This is the preferred method.
 # Using the @pkg-ruby-extras.sources@ file, described below. This should only be used for packages where watch files are not a solution.
 
+h3. @debian/watch@ files
+
+This is by far the best way to do, as other tools from debian also use the information
+stored in this file (see for instance 'QA pages for developers':http://qa.debian.org/developer.php).
+
+The principle is simple: if the software you package provides a web page with a link to source tarballs,
+all you need to do is provide the location of this page along with a regular expression matching
+the *link* to the tarball. For a standard 'Rubyforge':http://rubyforge.org package, the watchfile
+would look like
+
+<pre><code>version=3
+http://rubyforge.org/frs/?group_id=701 .*tioga-([\d.-]*)\.t.*</code></pre>
+
+To check the contents of this file, run
+
+<pre><code>  uscan --report </code></pre>
+
+Look at the +uscan+ manual page for more information.
+
 h3. Registering sources using the @pkg-ruby-extras.sources@ file
 
 Retrieve from Subversion: