[project @ 2000-10-30 16:24:22 by joy]

added documentation on bug tags

diff --git a/html/Developer.html.in b/html/Developer.html.in
index 3262927876b07cb3b0ccd416c1fdd52e14ed0272..d7687c7311d092d8b18445022b9a3beb354bcd3d 100644 (file)
--- a/html/Developer.html.in
+++ b/html/Developer.html.in
@@ -91,6 +91,24 @@ or by using the <code>severity</code> command with the
 $gHTMLSeverityDesc
 </dl>
 
+<H2><a name="tags">Tags for $gBug reports</a></H2>
+
+<p>Each $gBug can have zero or more of a set of given tags. These tags are
+displayed in the list of $gBugs when you look at a package's page, and when
+you look at the full $gBug log.
+
+<p>Tags can be set by supplying a <code>Tags</code> line in the
+pseudo-header when the $gBug is submitted (see the
+<a href="Reporting.html#pseudoheader">instructions for reporting $gBugs</a>),
+or by using the <code>tags</code> command with the
+<a href="#requestserv">control request server</a>.
+
+<p>The current $gBug tags are:
+
+<dl>
+$gHTMLTagDesc
+</dl>
+
 <h2><A name="forward">Recording that you have passed on a $gBug report</a></h2>
 
 <p>When a developer forwards a $gBug report to the developer of the

diff --git a/html/server-control.html.in b/html/server-control.html.in
index 69fb0661964d290c24e745d5c6e416aa5dafe1bd..b7e45b46e009b58e5336730cfce10a0571342cd6 100644 (file)
--- a/html/server-control.html.in
+++ b/html/server-control.html.in
@@ -155,6 +155,21 @@ mailservers is available via the WWW, in
   command; if you want to disconnect more than one $gBug simply include
   several <code>unmerge</code> commands in your message.
 
+<dt><code>tags</code> <var>bugnumber</var> [ <code>+</code> | <code>-</code> | <code>=</code> ] <var>tag</var>
+
+  <dd>Sets a particular tag for the $gBug report #<var>bugnumber</var> to
+  <var>tag</var>. No notification is sent to the user who reported the $gBug.
+  <code>+</code> means adding, <code>-</code> means subtracting, and
+  <code>=</code> means ignoring the current tags and setting them afresh.
+  The default action is adding.
+
+  <p>Available tags currently include <code>patch</code>, <code>wontfix</code>,
+  <code>moreinfo</code>, <code>unreproducible</code>, <code>fixed</code>,
+  and <code>stable</code>.
+
+  <p>For <a href="Developer.html#tags">their meanings</a> please consult the
+  general developers' documentation for the $gBug system.
+
 </dl>
 
 <hr>

diff --git a/scripts/text.in b/scripts/text.in
index 52c15d27c7da37049178884405db4c77243677ad..e91c39bf48bd3234b82f5a1aa22336893be3fa96 100644 (file)
--- a/scripts/text.in
+++ b/scripts/text.in
@@ -1,4 +1,4 @@
-# $Id: text.in,v 1.10 2000/10/08 15:21:36 joy Exp $
+# $Id: text.in,v 1.11 2000/10/30 16:24:22 joy Exp $
 
 ############################################################################
 #  Here is a blurb to point people to ftp archive of directions.  It is
@@ -129,6 +129,43 @@ $gHTMLSeverityDesc = "<DT><CODE>critical</CODE>
        <DD>fixed in the current version in the unstable archive but the fix has
        not been fixed by the person responsible.";
 
+############################################################################
+# Description of the tags
+############################################################################
+$gHTMLTagDesc = "
+<dt><code>patch</code>
+  <dd>A patch or some other easy procedure for fixing the $gBug is included in
+  the $gBug logs. If there\'s a patch, but it doesn\'t resolve the $gBug
+  adequately or causes some other problems, this tag should not be used.
+
+<dt><code>wontfix</code>
+  <dd>This $gBug won\'t be fixed. Possibly because this is a choice between two
+  arbitrary ways of doing things and the maintainer and submitter prefer
+  different ways of doing things, possibly because changing the behaviour
+  will cause other, worse, problems for others, or possibly for other
+  reasons.
+
+<dt><code>moreinfo</code>
+  <dd>This $gBug can\'t be addressed until more information is provided by the
+  submitter. The $gBug will be closed if the submitter doesn\'t provide ore
+  information in a reasonable (few months) timeframe. This is for $gBugs like
+  \"It doesn\'t work\". What doesn\'t work?
+
+<dt><code>unreproducible</code>
+  <dd>This $gBug can\'t be reproduced on the maintainer\'s system.  Assistance
+  from third parties is needed in diagnosing the cause of the problem.
+
+<dt><code>fixed</code>
+  <dd>This $gBug is fixed or worked around, but there\'s still an issue that
+  needs to be resolved. (This will eventually replace the \"fixed\" severity)
+
+<dt><code>stable</code>
+  <dd>This $gBug affects the stable distribution in particular.  This is only
+  intended to be used for ease in identifying release critical $gBugs that
+  affect the stable distribution.  It\'ll be replaced eventually with
+  something a little more flexible, probably.
+";
+
 ############################################################################
 # shows up at the start of (most) html pages.
 ############################################################################