chiark / gitweb /
Proofread
[developers-reference.git] / beyond-pkging.dbk
index 9b8de929d6cef00f5f8fd8a01daa6f47e431baeb..cafbbd39f0a7f9a9318bee4a7dcceab416fe1f82 100644 (file)
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
     "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
-  <!ENTITY % commondata  SYSTEM "common.ent" > %commondata;
+  <!ENTITY % commondata SYSTEM "common.ent" > %commondata;
 ]>
 <chapter id="beyond-pkging">
 <title>Beyond Packaging</title>
@@ -64,7 +64,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
-<literal>http://&bugs-host;/from:<replaceable>&lt;your-email-addr&gt;</replaceable></literal>.
+<literal>http://&bugs-host;/from:<replaceable>your-email-addr</replaceable></literal>.
 </para>
 <section id="submit-many-bugs">
 <title>Reporting lots of bugs at once (mass bug filing)</title>
@@ -77,23 +77,58 @@ role="package">lintian</systemitem> so that an error or warning is emitted.
 </para>
 <para>
 If you report more than 10 bugs on the same topic at once, it is recommended
-that you send a message to <email>debian-devel@&lists-host;</email>
-describing your intention before submitting the report, and mentioning the fact
-in the subject of your mail.  This will allow other developers to verify that
-the bug is a real problem.  In addition, it will help prevent a situation in
-which several maintainers start filing the same bug report simultaneously.
+that you send a message to &email-debian-devel; describing
+your intention before submitting the report, and mentioning the fact in the
+subject of your mail.  This will allow other developers to verify that the bug
+is a real problem.  In addition, it will help prevent a situation in which
+several maintainers start filing the same bug report simultaneously.
 </para>
 <para>
-Please use the programms <command>dd-list</command> and if appropriate
-<command>whodepends</command> (from the package devscripts) to generate a list
+Please use the programs <command>dd-list</command> and if appropriate
+<command>whodepends</command> (from the package <systemitem role="package">devscripts</systemitem>) to generate a list
 of all affected packages, and include the output in your mail to
-<email>debian-devel@&lists-host;</email>.
+&email-debian-devel;.
 </para>
 <para>
 Note that when sending lots of bugs on the same subject, you should send the
 bug report to <email>maintonly@&bugs-host;</email> so that the bug report
 is not forwarded to the bug distribution mailing list.
 </para>
+<section id="usertags">
+<title>Usertags</title>
+<para>
+You may wish to use BTS usertags when submitting bugs across a number of
+packages. Usertags are similar to normal tags such as 'patch' and 'wishlist'
+but differ in that they are user-defined and occupy a namespace that is
+unique to a particular user. This allows multiple sets of developers to
+'usertag' the same bug in different ways without conflicting.
+</para>
+<para>
+To add usertags when filing bugs, specify the <literal>User</literal> and
+<literal>Usertags</literal> pseudo-headers:
+</para>
+<screen>
+To: submit@bugs.debian.org
+Subject: <replaceable>title-of-bug</replaceable>
+
+Package: <replaceable>pkgname</replaceable>
+<replaceable>[ ... ]</replaceable>
+User: <replaceable>email-addr</replaceable>
+Usertags: <replaceable>tag-name [ tag-name ... ]</replaceable>
+
+<replaceable>description-of-bug ...</replaceable>
+</screen>
+<para>
+Note that tags are seperated by spaces and cannot contain underscores. If you
+are filing bugs for a particular group or team it is recommended that you
+set the <literal>User</literal> to an appropriate mailing list after describing
+your intention there.
+</para>
+<para>
+To view bugs tagged with a specific usertag, visit
+<literal>http://&bugs-host;/cgi-bin/pkgreport.cgi?users=<replaceable>email-addr</replaceable>&amp;tag=<replaceable>tag-name</replaceable></literal>.
+</para>
+</section>
 </section>
 
 </section>
@@ -106,13 +141,13 @@ is not forwarded to the bug distribution mailing list.
 Even though there is a dedicated group of people for Quality Assurance, QA
 duties are not reserved solely for them.  You can participate in this effort by
 keeping your packages as bug-free as possible, and as lintian-clean (see <xref
-linkend="lintian"/> ) as possible.  If you do not find that possible, then you
+linkend="lintian"/>) as possible.  If you do not find that possible, then you
 should consider orphaning some of your packages (see <xref
-linkend="orphaning"/> ).  Alternatively, you may ask the help of other people
+linkend="orphaning"/>).  Alternatively, you may ask the help of other people
 in order to catch up with the backlog of bugs that you have (you can ask for
-help on <email>debian-qa@&lists-host;</email> or
-<email>debian-devel@&lists-host;</email>).  At the same time, you can look
-for co-maintainers (see <xref linkend="collaborative-maint"/> ).
+help on &email-debian-qa; or
+&email-debian-devel;).  At the same time, you can look for
+co-maintainers (see <xref linkend="collaborative-maint"/>).
 </para>
 </section>
 
@@ -121,11 +156,11 @@ for co-maintainers (see <xref linkend="collaborative-maint"/> ).
 <para>
 From time to time the QA group organizes bug squashing parties to get rid of as
 many problems as possible.  They are announced on
-<email>debian-devel-announce@&lists-host;</email> and the announcement
-explains which area will be the focus of the party: usually they focus on
-release critical bugs but it may happen that they decide to help finish a major
-upgrade (like a new perl version which requires recompilation of all the binary
-modules).
+&email-debian-devel-announce; and the announcement explains
+which area will be the focus of the party: usually they focus on release
+critical bugs but it may happen that they decide to help finish a major upgrade
+(like a new <command>perl</command> version which requires recompilation of all
+the binary modules).
 </para>
 <para>
 The rules for non-maintainer uploads differ during the parties because the
@@ -162,15 +197,15 @@ version is available and that you need it.
 <para>
 Looking up the email address of the maintainer for the package can be
 distracting.  Fortunately, there is a simple email alias,
-<literal>&lt;package&gt;@&packages-host;</literal>, which provides a way to
+<literal><replaceable>package</replaceable>@&packages-host;</literal>, which provides a way to
 email the maintainer, whatever their individual email address (or addresses)
-may be.  Replace <literal>&lt;package&gt;</literal> with the name of a source
+may be.  Replace <replaceable>package</replaceable> with the name of a source
 or a binary package.
 </para>
 <para>
 You may also be interested in contacting the persons who are subscribed to a
-given source package via <xref linkend="pkg-tracking-system"/> .  You can do so
-by using the <literal>&lt;package&gt;@&pts-host;</literal> email
+given source package via <xref linkend="pkg-tracking-system"/>.  You can do so
+by using the <literal><replaceable>package</replaceable>@&pts-host;</literal> email
 address.
 </para>
 <!-- FIXME: moo@packages.d.o is easily confused with moo@packages.qa.d.o -->
@@ -190,11 +225,11 @@ There is a simple system (the MIA database) in which information about
 maintainers who are deemed Missing In Action is 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 <command>mia-query</command>.  Use <command>mia-query --help</command>
-to see how to query the database.  If you find that no information has been
-recorded about an inactive maintainer yet, or that you can add more
-information, you should generally proceed as follows.
+<filename>/org/qa.debian.org/mia</filename> on the host <literal>qa.debian.org</literal>,
+and can be queried with the <command>mia-query</command> tool.
+Use <command>mia-query --help</command> to see how to query the database.
+If you find that no information has been recorded about an inactive maintainer yet,
+or that you can add more information, you should generally proceed as follows.
 </para>
 <para>
 The first step is to politely contact the maintainer, and wait a reasonable
@@ -211,11 +246,12 @@ maintainer in question as possible.  This includes:
 <itemizedlist>
 <listitem>
 <para>
-The echelon information available through the <ulink
+The <literal>echelon</literal> information available through the <ulink
 url="&url-debian-db;">developers' LDAP database</ulink>, which indicates
 when the developer last posted to a Debian mailing list.  (This includes
-uploads via debian-*-changes lists.) Also, remember to check whether the
-maintainer is marked as on vacation in the database.
+mails about uploads distributed via the &email-debian-devel-changes; list.)
+Also, remember to check whether the maintainer is marked as on vacation in
+the database.
 </para>
 </listitem>
 <listitem>
@@ -237,20 +273,20 @@ groups.
 </itemizedlist>
 <para>
 A bit of a problem are packages which were sponsored — 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 are likely to know what
-happened to the person they sponsored.
+an official Debian developer.  The <literal>echelon</literal> 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 are likely to know
+what happened to the person they sponsored.
 </para>
 <para>
-It is also allowed to post a query to
-<email>debian-devel@&lists-host;</email>, asking if anyone is aware of the
-whereabouts of the missing maintainer.  Please Cc: the person in question.
+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.
 </para>
 <para>
 Once you have gathered all of this, you can contact
-<email>mia@qa.debian.org</email>.  People on this alias will use the
+&email-mia;.  People on this alias will use the
 information you provide in order to decide how to proceed.  For example, they
 might orphan one or all of the packages of the maintainer.  If a package has
 been NMUed, they might prefer to contact the NMUer before orphaning the package
@@ -272,9 +308,9 @@ someone with more time.
 </para>
 <para>
 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@qa.debian.org</email>.
+<filename>README</filename> file in <filename>/org/qa.debian.org/mia</filename> on
+<literal>qa.debian.org</literal> where the technical details and the MIA procedures are
+documented and contact &email-mia;.
 </para>
 </section>
 
@@ -333,7 +369,7 @@ In theory, you should only ask for the diff file and the location of the
 original source tarball, and then you should download the source and apply the
 diff yourself.  In practice, you may want to use the source package built by
 your sponsoree.  In that case, you have to check that they haven't altered the
-upstream files in the <filename>.orig.tar.gz</filename> file that they're
+upstream files in the <filename>.orig.tar.{gz,bz2,lzma}</filename> file that they're
 providing.
 </para>
 <para>
@@ -353,7 +389,7 @@ part of your <replaceable>KEY-ID</replaceable>, as long as it's unique in your
 secret keyring.
 </para>
 <para>
-The Maintainer field of the <filename>control</filename> file and the
+The <literal>Maintainer</literal> field of the <filename>control</filename> file and the
 <filename>changelog</filename> should list the person who did the packaging,
 i.e., the sponsoree.  The sponsoree will therefore get all the BTS mail about
 the package.
@@ -364,7 +400,7 @@ add a line stating it in the most recent changelog entry.
 </para>
 <para>
 You are encouraged to keep tabs on the package you sponsor using <xref
-linkend="pkg-tracking-system"/> .
+linkend="pkg-tracking-system"/>.
 </para>
 </section>
 
@@ -372,7 +408,7 @@ linkend="pkg-tracking-system"/> .
 <title>Advocating new developers</title>
 <para>
 See the page about <ulink
-url="&url-devel-docs;join/nm-advocate">advocating a prospective
+url="&url-newmaint-advocate;">advocating a prospective
 developer</ulink> at the Debian web site.
 </para>
 </section>
@@ -380,9 +416,8 @@ developer</ulink> at the Debian web site.
 <section id="s7.5.4">
 <title>Handling new maintainer applications</title>
 <para>
-Please see <ulink
-url="&url-devel-docs;join/nm-amchecklist">Checklist for Application
-Managers</ulink> at the Debian web site.
+Please see <ulink url="&url-newmaint-amchecklist;">Checklist
+for Application Managers</ulink> at the Debian web site.
 </para>
 </section>