Document usertags (#367876)

git-svn-id: svn://anonscm.debian.org/ddp/manuals/trunk/developers-reference@5796 313b444b-1b9f-4f58-a734-7bb04f332e8d

diff --git a/beyond-pkging.dbk b/beyond-pkging.dbk
index 77a973947cfcc112422e07f2a00f22e2337108fc..6cc5d63decdaec34ddaedbc803e69e059809d3c6 100644 (file)
--- a/beyond-pkging.dbk
+++ b/beyond-pkging.dbk
@@ -94,6 +94,41 @@ 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>&lt;title-of-bug&gt;</replaceable>
+
+Package: <replaceable>&lt;pkgname&gt;</replaceable>
+<replaceable>[ ... ]</replaceable>
+User: <replaceable>&lt;email-addr&gt;</replaceable>
+Usertags: <replaceable>&lt;tag-name&gt; [ &lt;tag-name&gt; ... ]</replaceable>
+
+<replaceable>&lt;description-of-bug ...&gt;</replaceable>
+</screen>
+<para>
+Note that tags are seperated by spaces and cannot contain underscores. If you
+are filing bugs for 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>&lt;email-addr&gt;</replaceable>&amp;tag=<replaceable>&lt;tag-name&gt;</replaceable></literal>.
+</para>
+</section>
 </section>
 
 </section>

diff --git a/debian/changelog b/debian/changelog
index f3023436034bf0cc5a5a050f28411f54dec2121d..b8f439ef36533d4ce0baec60553754f944779ec3 100644 (file)
--- a/debian/changelog
+++ b/debian/changelog
@@ -31,8 +31,10 @@ developers-reference (3.4.1) UNRELEASED; urgency=low
   * Improved README.contrib. Mention command to checkout the SVN
     version. Thanks to Christine Spang for the patch.
     Closes: #500371.
+  * Document usertags. Thanks to Chris Lamb for the patch.
+    Closes: #367876.
 
- -- Lucas Nussbaum <lucas@lucas-nussbaum.net>  Fri, 23 Jan 2009 00:20:12 +0100
+ -- Lucas Nussbaum <lucas@lucas-nussbaum.net>  Fri, 23 Jan 2009 00:25:45 +0100
 
 developers-reference (3.4.0) unstable; urgency=low