- Updated PTS documentation.

[developers-reference.git] / developers-reference.sgml

diff --git a/developers-reference.sgml b/developers-reference.sgml
index 01a10be930d4ed4c1dc98b464d0b2eee0d42d6d3..a89556f668a8265d8dba7b26fd8c29558cf54f62 100644 (file)
--- a/developers-reference.sgml
+++ b/developers-reference.sgml
@@ -6,7 +6,7 @@
   <!entity % commondata  SYSTEM "common.ent" > %commondata;
 
   <!-- CVS revision of this document -->
-  <!entity cvs-rev "$Revision: 1.196 $">
+  <!entity cvs-rev "$Revision: 1.198 $">
   <!-- if you are translating this document, please notate the CVS
        revision of the developers reference here -->
   <!--
@@ -1249,7 +1249,11 @@ override disparity for the section or priority field).
     <tag><tt>default</tt>
     <item>
 Any non-automatic mail sent to the PTS by people who wanted to
-contact the subscribers of the package.
+contact the subscribers of the package. This can be done by sending mail
+to <tt><var>srcpackage</var>@&pts-host;</tt>. In order to prevent spam,
+mails sent to these addresses must contain the header "X-PTS-Approved"
+with a non-empty string.
+
 
     <tag><tt>summary</tt>
     <item>
@@ -1374,6 +1378,22 @@ notifications, you just have to make sure it sends a copy of those mails
 to <tt><var>srcpackage</var>_cvs@&pts-host;</tt>. Only people who
 accepts the <em>cvs</em> keyword will receive the notifications.
 
+       <sect1 id="pts-web">The PTS web interface
+       <p>
+The PTS has been extended with a web interface that puts together
+many information about each source package. It features many useful
+links (BTS, QA stats, contact information, DDTP translation status,
+buildd logs) and gathers many more information from various places
+(30 latest changelog entries, testing status, ...). It's a very useful
+tool if you want to know what's going on with a specific source
+package. Furthermore there's a form that let you easily subscribe to
+the mail service offered by the PTS.
+       <p>
+You can jump directly to the web page concerning a specific source package
+with an url like <tt>http://&pts-host;/<var>srcpackage</var></tt>. Otherwise
+you can go through the <url id="http://&pts-host;" name="main page">.
+
+
     <sect id="ddpo">Developer's packages overview
        <p>
 A QA (quality assurance) web portal is available at <url
@@ -3086,22 +3106,22 @@ documentation and examples (in <file>/usr/share/doc/dpatch</file>).
        <sect1 id="multiple-binary">Multiple binary packages
        <p>
 A single source package will often build several binary packages,
-either to provide several flavors of the same software (examples are
-the <package>vim-*</package> packages) or to make several small
+either to provide several flavors of the same software (e.g.,
+the <package>vim</package> source package) or to make several small
 packages instead of a big one (e.g., if the user can install only the
 subset she needs, and thus save some disk space).
        <p>
 The second case can be easily managed in <file>debian/rules</file>.
 You just need to move the appropriate files from the build directory
 into the package's temporary trees.  You can do this using
-<prgn>install</prgn> (vanilla approach) or <prgn>dh_install</prgn>
-(from <package>debhelper</package>).  Be sure to check the different
+<prgn>install</prgn> or <prgn>dh_install</prgn>
+from <package>debhelper</package>.  Be sure to check the different
 permutations of the various packages, ensuring that you have the
 inter-package dependencies set right in <file>debian/control</file>.
        <p>
 The first case is a bit more difficult since it involves multiple
-recompiles of the same software but with different configure
-options. The <package>vim</package> is an example of how to manage
+recompiles of the same software but with different configuration
+options. The <package>vim</package> source package is an example of how to manage
 this using an hand-crafted <file>debian/rules</file> file.
 
 <!-- &FIXME; Find a good debhelper example with multiple configure/make
@@ -4434,6 +4454,7 @@ it.</p>
 questionable:
   dbs (referred to above)
   dpatch (referred to above)
+  debarchiver
   ucf
   dpkg-awk
   grep-dctrl