]> git.donarmstrong.com Git - debbugs.git/blobdiff - html/Reporting.html.in
Load bugs.css file in documentation html pages.
[debbugs.git] / html / Reporting.html.in
index 4e31b8b067fd826714bade38b3735a999d5d75ab..caf81ef9a7d1351d859839d47c5b92ae414407f0 100644 (file)
@@ -4,6 +4,7 @@ $gReportingHtml = <<HTML_END
 <head>
   <title>$gProject $gBugs - how to report a $gBug</title>
   <link rev="made" href="mailto:$gMaintainerEmail">
+  <link rel="stylesheet" href="$gWebHostBugDir/css/bugs.css" type="text/css">
 </head>
 <body>
 
@@ -11,8 +12,9 @@ $gReportingHtml = <<HTML_END
 
 <h2>Important things to note <strong>before</strong> sending</h2>
 
-<p>Please don't report several unrelated $gBugs - especially ones in
-different packages - in a single $gBug report.
+<p>Please don't report multiple unrelated $gBugs - especially ones in
+different packages - in a single $gBug report. It makes our lives much
+easier if you send separate reports.
 
 <p>You should check if your $gBug report has already been filed by someone
 else before submitting it. Lists of currently outstanding $gBugs are
@@ -37,10 +39,16 @@ headers, but <a href="#xcc">a different method, described below</a>.</p>
 
 <p>There is a program that was developed in Debian to help reporting
 $gBug reports, it's called
-<code><a href="http://packages.debian.org/stable/utils/reportbug.html">reportbug</a></code>.
+<code><a href="http://packages.debian.org/stable/utils/reportbug">reportbug</a></code>.
 It will guide you through the bug reporting process step by step,
 and probably ease filing bugs that way.</p>
 
+<p>Emacs users can also use the debian-bug command provided by the
+<code><a href="http://packages.debian.org/stable/utils/debbugs-el">
+debbugs-el</a></code> package. When called with <kbd>M-x
+debian-bug</kbd>, it will ask for all necessary information in a
+similar way to <code>reportbug</code>.</p>
+
 
 <h2>Sending the bug report via e-mail</h2>
 
@@ -70,7 +78,10 @@ has the $gBug.</p>
 Version: &lt;something&gt;
 </pre>
 
-<p>Replace <code>&lt;something&gt;</code> with the version of the package.</p>
+<p>Replace <code>&lt;something&gt;</code> with the version of the package.
+Please don't include any text here other than the version itself, as the
+$gBug tracking system relies on this field to work out which releases are
+affected by the bug.</p>
 
 <p>You need to supply a correct <code>Package</code> line in the
 pseudo-header in order for the $gBug tracking system to deliver the message
@@ -159,6 +170,12 @@ This will cause the $gBug tracking system to send a copy of your report
 to the address(es) in the <code>X-Debbugs-CC</code> line as well as to
 any mailing list.
 
+<p>Avoid sending such copies to the addresses of other $gBug reports, as
+they will be caught by the checks that prevent mail loops. There is
+relatively little point in using <code>X-Debbugs-CC</code> for this
+anyway, as the $gBug number added by that mechanism will just be
+replaced by a new one; use an ordinary <code>CC</code> header instead.
+
 <p>This feature can often be combined usefully with mailing
 <code>quiet</code> - see below.
 
@@ -199,6 +216,17 @@ Tags: &lt;<var>tags</var>&gt;
 <p>Replace &lt;<var>tags</var>&gt; with one or more of the available tags,
 as described in the
 <a href="Developer.html#tags">developers' documentation</a>.
+Separate multiple tags with commas, spaces, or both.
+
+<pre>
+User: &lt;<var>username</var>&gt;
+Usertags: &lt;<var>usertags</var>&gt;
+</pre>
+
+<p>Replace &lt;<var>usertags</var>&gt; with one or more usertags.
+Separate multiple tags with commas, spaces, or both. If you specify a
+username, that users tags will be set. Otherwise, the email address of
+the sender will be used as the username</p>
 
 
 <h2>Not forwarding to the mailing list - minor $gBug reports</h2>
@@ -218,6 +246,23 @@ only a summary).
 any forwarded message so that replies will by default be processed in
 the same way as the original report.
 
+
+<h2>Acknowledgements</h2>
+
+<p>Normally, the $gBug system will return an acknowledgement to you by
+e-mail when you report a new bug or submit additional information to an
+existing bug. If you want to suppress this acknowledgement, include an
+<code>X-Debbugs-No-Ack</code> header in your e-mail (the contents of this
+header do not matter; however, it must be in the mail header and
+<em>not</em> in the pseudo-header with the <code>Package</code> field). If
+you report a new $gBug with this header, you will need to check the web
+interface yourself to find the $gBug number.</p>
+
+<p>Note that this header will not suppress acknowledgements from the
+<code>control\@$gEmailDomain</code> mailserver, since those acknowledgements
+may contain error messages which should be read and acted upon.</p>
+
+
 <h3>$gBug reports against unknown packages</h3>
 
 <p>If the $gBug tracking system doesn't know who the maintainer of the