chiark / gitweb /
- Updated PTS documentation.
[developers-reference.git] / developers-reference.sgml
index fec32b9fc67e980fdbc8e64bd35d08c58fd71a5e..a89556f668a8265d8dba7b26fd8c29558cf54f62 100644 (file)
@@ -6,7 +6,7 @@
   <!entity % commondata  SYSTEM "common.ent" > %commondata;
 
   <!-- CVS revision of this document -->
-  <!entity cvs-rev "$Revision: 1.194 $">
+  <!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
@@ -1839,13 +1859,23 @@ according to their licensing, e.g. <em>main</em>, <em>contrib</em> and
 <em>non-free</em>. This is described in another section, <ref id="archive">.
 
 
-    <sect id="bug-handling">Handling package bugs
+    <sect id="bug-handling">Handling bugs
+       <p>
+Every developer has to be able to work with the Debian <url name="bug
+tracking system" id="&url-bts;">. This includes knowing how to file bug
+reports properly (see <ref id="submit-bug">), how to update them and
+reorder them, and how to process and close them.
        <p>
-Often as a package maintainer, you find bugs in other packages or else
-have bugs reported to your packages which need to be reassigned.  The
-<url id="&url-bts-control;" name="BTS instructions"> can tell you how
-to do this.  Some information on filing bugs can be found in <ref
-id="submit-bug">.
+The bug tracking system's features interesting to developers are described
+in the <url id="&url-bts-devel;" name="BTS documentation for developers">.
+This includes closing bugs, sending followup messages, assigning severities,
+tags, marking bugs as forwarded and other issues.
+       <p>
+Operations such as reassigning bugs to other packages, merging separate
+bug reports about the same issue, or reopening bugs when they are
+prematurely closed, are handled using the so-called control mail server.
+All of the commands available in this server are described in the
+<url id="&url-bts-control;" name="BTS control server documentation">.
 
       <sect1 id="bug-monitoring">Monitoring bugs
        <p>
@@ -3076,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
@@ -3673,21 +3703,39 @@ members in choosing what they want to work on and in choosing
 the most critical thing to spend their time on.
 
     <sect id="submit-bug">
-        <heading>Bug reporting</heading>
+      <heading>Bug reporting</heading>
         <p>
 We encourage you to file bugs as you find them in Debian packages.  In
 fact, Debian developers are often the first line testers.  Finding and
-reporting bugs in other developer's packages improves the quality of
+reporting bugs in other developers' packages improves the quality of
 Debian.
        <p>
+Read the <url name="instructions for reporting bugs"
+id="&url-bts-report;"> in the Debian <url name="bug tracking system"
+id="&url-bts;">.
+       <p>
 Try to submit the bug from a normal user account at which you are
-likely to receive mail.  Do not submit bugs as root.
+likely to receive mail, so that people can reach you if they need
+further information about the bug.  Do not submit bugs as root.
+       <p>
+You can use a tool like <manref name="reportbug" section="1"> to
+submit bugs. It can automate and generally ease the process.
+       <p>
+Make sure the bug is not already filed against a package.
+Each package has a bug list easily reachable at
+<tt>http://&bugs-host;/<var>packagename</var></tt>
+Utilities like <manref name="querybts" section="1"> can also
+provide you with this information (and <prgn>reportbug</prgn>
+will usually invoke <prgn>querybts</prgn> before sending, too).
+       <p>
+Try to direct your bugs to the proper location. When for example
+your bug is about a package that overwrites files from another package,
+check the bug lists for <em>both</em> of those packages in order to
+avoid filing duplicate bug reports.
        <p>
-Make sure the bug is not already filed against a package.  Try to do a
-good job reporting a bug and redirecting it to the proper location.
 For extra credit, you can go through other packages, merging bugs
-which are reported more than once, or setting bug severities to
-`fixed' when they have already been fixed.  Note that when you are
+which are reported more than once, or tagging bugs `fixed'
+when they have already been fixed.  Note that when you are
 neither the bug submitter nor the package maintainer, you should
 not actually close the bug (unless you secure permission from the
 maintainer).
@@ -3696,7 +3744,7 @@ From time to time you may want to check what has been going on
 with the bug reports that you submitted. Take this opportunity to
 close those that you can't reproduce anymore. To find
 out all the bugs you submitted, you just have to visit
-<tt>http://&bugs-host;/from:&lt;your-email-addr&gt;</tt>.
+<tt>http://&bugs-host;/from:<var>&lt;your-email-addr&gt;</var></tt>.
 
       <sect1 id="submit-many-bugs">Reporting lots of bugs at once
        <p>
@@ -4406,6 +4454,7 @@ it.</p>
 questionable:
   dbs (referred to above)
   dpatch (referred to above)
+  debarchiver
   ucf
   dpkg-awk
   grep-dctrl