chiark / gitweb /
more version-tracking
[developers-reference.git] / developers-reference.sgml
index fc33f2834581a25c1fedfbda399e7703e170d95f..678e02b4c2e2a8cbf3742822326108463ed5ae4c 100644 (file)
@@ -7,7 +7,7 @@
   <!ENTITY % dynamicdata  SYSTEM "dynamic.ent" > %dynamicdata;
 
   <!-- CVS revision of this document -->
-  <!ENTITY cvs-rev "$Revision: 1.289 $">
+  <!ENTITY cvs-rev "$Revision: 1.298 $">
 
   <!-- if you are translating this document, please notate the CVS
        revision of the original developer's reference in cvs-en-rev -->
@@ -31,7 +31,7 @@
 
       <copyright>
        <copyrightsummary>
-copyright &copy; 2004&mdash;2005 Andreas Barth</copyrightsummary>
+copyright &copy; 2004&mdash;2006 Andreas Barth</copyrightsummary>
        <copyrightsummary>
 copyright &copy; 1998&mdash;2003 Adam Di Carlo</copyrightsummary>
        <copyrightsummary>
@@ -158,7 +158,7 @@ post to that list and an experienced developer will volunteer to help.
 In addition, if you have some packages ready for inclusion in Debian,
 but are waiting for your new maintainer application to go through, you
 might be able find a sponsor to upload your package for you.  Sponsors
-are people who are official Debian maintainers, and who are willing to
+are people who are official Debian Developers, and who are willing to
 criticize and upload your packages for you.
 <!-- FIXME - out of order
 Those who are seeking a
@@ -199,7 +199,8 @@ Before you actually register you should have shown that you can do
 competent work and will be a good contributor.
 You show this by submitting patches through the Bug Tracking System
 and having a package
-sponsored by an existing maintainer for a while.  Also, we expect that
+sponsored by an existing Debian Developer for a while.
+Also, we expect that
 contributors are interested in the whole project and not just in
 maintaining their own packages.  If you can help other maintainers by
 providing further information on a bug or even a patch, then do so!
@@ -207,11 +208,11 @@ providing further information on a bug or even a patch, then do so!
 Registration requires that you are familiar with Debian's philosophy
 and technical documentation.  Furthermore, you need a GnuPG key which
 has been signed by an existing Debian maintainer.  If your GnuPG key
-is not signed yet, you should try to meet a Debian maintainer in
+is not signed yet, you should try to meet a Debian Developer in
 person to get your key signed.  There's a <url id="&url-gpg-coord;"
 name="GnuPG Key Signing Coordination page"> which should help you find
-a maintainer close to you. 
-(If there is no Debian maintainer close to you,
+a Debian Developer close to you. 
+(If there is no Debian Developer close to you,
 alternative ways to pass the ID check may be permitted
 as an absolute exception on a case-by-case-basis.
 See the <url id="&url-newmaint-id;" name="identification page">
@@ -245,7 +246,7 @@ pgp 2.6.x compatible v3 keys (also called "legacy RSA" by PGP).
 Version 4 (primary) keys can either use the RSA or the DSA algorithms,
 so this has nothing to do with GnuPG's question about "which kind
 of key do you want: (1) DSA and Elgamal, (2) DSA (sign only), (5)
-RSA (sign only).  If you don't have any special requirements just pick
+RSA (sign only)".  If you don't have any special requirements just pick
 the defailt.
 <p>
 The easiest way to tell whether an existing key is a v4 key or a v3
@@ -267,7 +268,8 @@ have an older key you may have to manually add those signatures.
 </footnote>
        <p>
 If your public key isn't on public key servers such as &pgp-keyserv;,
-please read the documentation available locally in &file-keyservs;.
+please read the documentation available at
+<url id="&url-newmaint-id;" name="NM Step 2: Identification">.
 That document contains instructions on how to put your key on the
 public key servers.  The New Maintainer Group will put your public key
 on the servers if it isn't already there.
@@ -280,8 +282,8 @@ If you live in a country where use of
 cryptography even for authentication is forbidden
 then please contact us so we can make special arrangements.
        <p>
-To apply as a new maintainer, you need an existing Debian maintainer
-to verify your application (an <em>advocate</em>).  After you have
+To apply as a new maintainer, you need an existing Debian Developer
+to support your application (an <em>advocate</em>).  After you have
 contributed to Debian for a while, and you want to apply to become a
 registered developer, an existing developer with whom you
 have worked over the past months has to express their belief that you
@@ -560,10 +562,9 @@ id="&url-debian-lists-new;">.
       <sect id="irc-channels">IRC channels
        <p>
 Several IRC channels are dedicated to Debian's development. They are mainly
-hosted on the <url id="&url-openprojects;" name="freenode"> network
-(previously known as Open Projects Network).
-The <tt>irc.debian.org</tt> DNS entry is an alias to
-<tt>irc.freenode.net</tt>.
+hosted on the <url id="&url-oftc;" name="Open and free technology community
+(OFTC)"> network.  The <tt>irc.debian.org</tt> DNS entry is an alias to
+<tt>irc.oftc.net</tt>.
        <p>
 The main channel for Debian in general is <em>#debian</em>. This is a large,
 general-purpose channel where users can find recent news in the topic and
@@ -603,8 +604,8 @@ Some non-English developers' channels exist as well, for example
 French speaking people interested in Debian's development.
        <p>
 Channels dedicated to Debian also exist on other IRC networks, notably on
-the <url name="Open and free technology community (OFTC)"
-id="http://www.oftc.net/"> IRC network.
+the <url id="&url-openprojects;" name="freenode"> IRC network, which was 
+pointed at by the <tt>irc.debian.org</tt> alias until 4th June 2006.
        <p>
 To get a cloak on freenode, you send J&ouml;rg Jaspert &lt;joerg@debian.org&gt;
 a signed mail where you tell what your nick is.
@@ -1357,7 +1358,6 @@ maintainer has set up forwarding commit notifications to the PTS.
     <item>
 Translations of descriptions or debconf templates
 submitted to the Debian Description Translation Project.
-</taglist>
 
     <tag><tt>derivatives</tt>
     <item>
@@ -1368,7 +1368,7 @@ Information about changes made to the package in derivative distributions
        <sect1 id="pts-commands">The PTS email interface
        <p>
 You can control your subscription(s) to the PTS by sending
-various commands to <email>pts@qa.debian.org</email>.
+various commands to <email>pts@qa.debian.org</email>. 
 
 <taglist>
 
@@ -1424,7 +1424,14 @@ various commands to <email>pts@qa.debian.org</email>.
 <tag><tt>keyword [&lt;email&gt;] {+|-|=} &lt;list of keywords&gt;</tt>
 <item>
   Accept (+) or refuse (-) mails classified under the given keyword(s).
-  Define the list (=) of accepted keywords.
+  Define the list (=) of accepted keywords. This changes the default set
+  of keywords accepted by a user.
+
+<tag><tt>keywordall [&lt;email&gt;] {+|-|=} &lt;list of keywords&gt;</tt>
+<item>
+  Accept (+) or refuse (-) mails classified under the given keyword(s).
+  Define the list (=) of accepted keywords. This changes the set of
+  accepted keywords of all the currently active subscriptions of a user.
 
 <tag><tt>keyword &lt;sourcepackage&gt; [&lt;email&gt;] {+|-|=} &lt;list of keywords&gt;</tt>
 <item>
@@ -1437,6 +1444,12 @@ various commands to <email>pts@qa.debian.org</email>.
   the bot.
 </taglist>
 
+       <p>
+The <prgn>pts-subscribe</prgn> command-line utility (from the
+<package>devscripts</package> package) can be handy to temporarily
+subscribe to some packages, for example after having made an
+non-maintainer upload.
+
        <sect1 id="pts-mail-filtering">Filtering PTS mails
        <p>
 Once you are subscribed to a package, you will get the mails sent to
@@ -2168,16 +2181,11 @@ We prefer the <tt>closes: #<var>XXX</var></tt> syntax, as it is the
 most concise entry and the easiest to integrate with the text of the
 <file>changelog</file>.
        <p>
-If an upload is identified as <qref id="nmu">Non-maintainer upload (NMU)</qref>
-(and that is the case if the name of the person who commits this change
-is not exactly the same as any one of Maintainer or Uploader,
-except if the maintainer is the qa group),
-than the bug is only tagged <tt>fixed</tt> instead of being closed.
-If a maintainer upload is targetted to experimental,
-than the tag <tt>fixed-in-experimental</tt> is added to the bug;
-for NMUs, the tag <tt>fixed</tt> is used.
-(The special rule for experimental is expected to change
-as soon as version-tracking is added to the bug tracking system.)
+Historically, uploads identified as
+<qref id="nmu">Non-maintainer upload (NMU)</qref>
+were tagged <tt>fixed</tt> instead of being closed,
+but that practice was ceased with the advent of version-tracking.
+The same applied to the tag <tt>fixed-in-experimental</tt>.
        <p>
 If you happen to mistype a bug number or forget a bug in the changelog
 entries, don't hesitate to undo any damage the error caused. To reopen
@@ -2185,7 +2193,9 @@ wrongly closed bugs, send an <tt>reopen <var>XXX</var></tt> command to
 the bug tracking system's control address, &email-bts-control;.  To
 close any remaining bugs that were fixed by your upload, email the
 <file>.changes</file> file to <email>XXX-done@&bugs-host;</email>,
-where <var>XXX</var> is your bug number.
+where <var>XXX</var> is your bug number, and write "Version: XXX"
+in the first line of the body of the email to mark the first version
+where this bug has been closed.
        <p>
 Bear in mind that it is not obligatory to close bugs using the
 changelog as described above.  If you simply want to close bugs that
@@ -3210,18 +3220,6 @@ rather than doing an NMU, they should just submit worthwhile patches
 to the Bug Tracking System.  Maintainers almost always appreciate
 quality patches and bug reports.
 
-      <sect1 id="nmu-katie">How dak detects NMUs
-       <p>
-Whether an upload is treated as an NMU or as a maintainer upload by
-the archive scripts and the bugtracking system (see <ref
-id="nmu-patch">) is <em>not</em> decided by looking at the version
-number (see <ref id="nmu-version">). Instead, an upload is handled as
-an NMU if the maintainer address in the <tt>.changes</tt> file is not
-binary the same as the address in the <tt>Maintainer</tt> field, or
-any of the addresses the <tt>Uploaders</tt> field, of the <tt>dsc</tt>
-file, and also if the maintainer address is not special (i.e. it is
-not set to the QA Group address).
-
       <sect1 id="nmu-terms">Terminology
        <p>
 There are two new terms used throughout this section: ``binary-only NMU''
@@ -3956,8 +3954,9 @@ tracking system.
           <p>
 It is an old tradition to acknowledge bugs fixed in non-maintainer
 uploads in the first changelog entry of the proper maintainer upload.
-Please use the option <tt>-v</tt> to <prgn>dpkg-buildpackage</prgn>
-to close the relevant bug report.
+As we have version tracking now,
+it is enough to keep the NMUed changelog entries and
+just mention this fact in your own changelog entry.
         </sect1>
 
        <sect1 id="bpp-changelog-errors">
@@ -5109,11 +5108,9 @@ maintainers who are deemed Missing In Action are recorded.  When a member of the
 QA group contacts an inactive maintainer or finds more information about
 one, this is recorded in the MIA database.  This system is available
 in /org/qa.debian.org/mia on the host qa.debian.org, and can be queried
-with a tool known as <prgn>mia-history</prgn>.  By default,
-<prgn>mia-history</prgn> shows information about every person it knows
-about, but it accepts regular expressions as arguments which it uses to
-match user names.  <example>mia-history --help</example> shows which
-arguments are accepted.  If you find that no information has been recorded
+with a tool known as <prgn>mia-query</prgn>.
+Use <example>mia-query --help</example> to see how to query the database.
+If you find that no information has been recorded
 about an inactive maintainer already, or that you can add more information,
 you should generally proceed as follows.
       <p>
@@ -5148,15 +5145,16 @@ about the maintainer in question as possible. This includes:
               non-Debian mailing lists or news groups.
       </list>
       <p>
-One big problem are packages which were sponsored &mdash; the maintainer is not
+A bit of a problem are packages which were sponsored &mdash; the maintainer is not
 an official Debian developer. The echelon information is not available for
 sponsored people, for example, so you need to find and contact the Debian
 developer who has actually uploaded the package. Given that they signed the
-package, they're responsible for the upload anyhow, and should know what
+package, they're responsible for the upload anyhow, and are likely to know what
 happened to the person they sponsored.
       <p>
 It is also allowed to post a query to &email-debian-devel;, asking if anyone
 is aware of the whereabouts of the missing maintainer.
+Please Cc: the person in question.
       <p>
 Once you have gathered all of this, you can contact &email-mia;.
 People on this alias will use the information you provided in order to
@@ -5170,12 +5168,16 @@ cannot dedicate all of our time to Debian. Also, you are not aware of the
 circumstances of the person who is involved. Perhaps they might be
 seriously ill or might even had died &mdash; you do not know who may be on the
 receiving side. Imagine how a relative will feel if they read the e-mail
-of the deceased and find a very impolite, angry and accusing message!)
+of the deceased and find a very impolite, angry and accusing message!
       <p>
 On the other hand, although we are volunteers, we do have a responsibility. 
 So you can stress the importance of the greater good &mdash; if a maintainer does
 not have the time or interest anymore, they should "let go" and give the
 package to someone with more time.
+      <p>
+If you are interested in working in the MIA team, please have a look at the
+README file in /org/qa.debian.org/mia on qa.debian.org where the technical
+details and the MIA procedures are documented and contact &email-mia;.
 
 
     <sect id="newmaint">