html/Reporting.html.in

   1 $gReportingHtml = <<HTML_END
   2 <!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN">
   3 <html>
   4 <head>
   5   <title>$gProject $gBugs - how to report a $gBug</title>
   6   <link rev="made" href="mailto:$gMaintainerEmail">
   7 </head>
   8 <body>
   9
  10 <h1>How to report a $gBug in $gProject</h1>
  11
  12 <h2>Important things to note <strong>before</strong> sending</h2>
  13
  14 <p>Please don't report multiple unrelated $gBugs - especially ones in
  15 different packages - in a single $gBug report. It makes our lives much
  16 easier if you send separate reports.
  17
  18 <p>You should check if your $gBug report has already been filed by someone
  19 else before submitting it. Lists of currently outstanding $gBugs are
  20 available <a href="./">on the World Wide Web</a> and
  21 <a href="Access.html">elsewhere</a> - see other documents for details.
  22 You can submit your comments to an existing $gBug report
  23 #<var>&lt;number&gt;</var> by sending e-mail to
  24 <var>&lt;number&gt;</var>\@$gEmailDomain</p>
  25
  26 <p>If you can't seem to determine which package contains the problem,
  27 please send e-mail to the <a href="mailto:$gMaintainerEmail">
  28 $gMaintainerEmail</a> asking for advice.
  29 $gHTMLPseudoDesc
  30 </p>
  31
  32 <p>If you'd like to send a copy of your $gBug report to additional
  33 recipients (such as mailing lists), you shouldn't use the usual e-mail
  34 headers, but <a href="#xcc">a different method, described below</a>.</p>
  35
  36
  37 <h2>Sending the bug report using an automatic bug report tool</h2>
  38
  39 <p>There is a program that was developed in Debian to help reporting
  40 $gBug reports, it's called
  41 <code><a href="http://packages.debian.org/stable/utils/reportbug">reportbug</a></code>.
  42 It will guide you through the bug reporting process step by step,
  43 and probably ease filing bugs that way.</p>
  44
  45 <p>Emacs users can also use the debian-bug command provided by the
  46 <code><a href="http://packages.debian.org/stable/utils/debbugs-el">
  47 debbugs-el</a></code> package. When called with <kbd>M-x
  48 debian-bug</kbd>, it will ask for all necessary information in a
  49 similar way to <code>reportbug</code>.</p>
  50
  51
  52 <h2>Sending the bug report via e-mail</h2>
  53
  54 <p>Send mail to
  55 <a href="mailto:submit\@$gEmailDomain"><code>submit\@$gEmailDomain</code></a>,
  56 as described below.</p>
  57
  58 <p>Of course, like with any email, you should include a clear, descriptive
  59 <code>Subject</code> line in your main mail header.  The subject you
  60 give will be used as the initial $gBug title in the tracking system, so
  61 please try to make it informative!</p>
  62
  63 <p>You need to put a <a name="pseudoheader">pseudo-header</a> at the start
  64 of the body of the message. That means that the first line of the message
  65 body should say:</p>
  66
  67 <pre>
  68 Package: &lt;something&gt;
  69 </pre>
  70
  71 <p>Replace <code>&lt;something&gt;</code> with the name of the package which
  72 has the $gBug.</p>
  73
  74 <p>The second line of the message should say:</p>
  75
  76 <pre>
  77 Version: &lt;something&gt;
  78 </pre>
  79
  80 <p>Replace <code>&lt;something&gt;</code> with the version of the package.</p>
  81
  82 <p>You need to supply a correct <code>Package</code> line in the
  83 pseudo-header in order for the $gBug tracking system to deliver the message
  84 to the package's maintainer.</p>
  85
  86 $gHTMLFindPackage
  87
  88 <p>The pseudo-header fields should start at the very start of their lines.</p>
  89
  90 $gHTMLPseudoDesc
  91
  92 <p>Please include in your report:</p>
  93
  94 <ul>
  95   <li>The <em>exact</em> and <em>complete</em> text of any error
  96       messages printed or logged.  This is very important!
  97   <li>Exactly what you typed or did to demonstrate the problem.
  98   <li>A description of the incorrect behaviour: exactly what behaviour
  99       you were expecting, and what you observed.  A transcript of an
 100       example session is a good way of showing this.
 101   <li>A suggested fix, or even a patch, if you have one.
 102   <li>Details of the configuration of the program with the problem.
 103       Include the complete text of its configuration files.
 104
 105 $gXtraBugInfo
 106
 107 </ul>
 108
 109 <p>Include any detail that seems relevant - you are in very little danger
 110 of making your report too long by including too much information.  If
 111 they are small please include in your report any files you were using
 112 to reproduce the problem (uuencoding them if they may contain odd
 113 characters etc.).</p>
 114
 115
 116 <h2><A name="example">Example</a></h2>
 117
 118 <p>A $gBug report, with mail header, looks something like this:
 119
 120 <pre>
 121   To: submit\@$gEmailDomain
 122   From: diligent\@testing.linux.org
 123   Subject: Hello says `goodbye'
 124
 125   Package: hello
 126   Version: 1.3-16
 127
 128   When I invoke `hello' without arguments from an ordinary shell
 129   prompt it prints `goodbye', rather than the expected `hello, world'.
 130   Here is a transcript:
 131
 132   $ hello
 133   goodbye
 134   $ /usr/bin/hello
 135   goodbye
 136   $
 137
 138   I suggest that the output string, in hello.c, be corrected.
 139
 140   I am using Debian GNU/Linux 2.2, kernel 2.2.17-pre-patch-13
 141   and libc6 2.1.3-10.
 142 </pre>
 143
 144
 145 <h2><A name="xcc">Sending copies of $gBug reports to other addresses</a></h2>
 146
 147 <p>Sometimes it is necessary to send a copy of a $gBug report to somewhere
 148 else besides the mailing list and the package maintainer, which is where they
 149 are normally sent.
 150
 151 <p>You could do this by CC'ing your $gBug report to the other address(es),
 152 but then the other copies would not have the $gBug report number put in
 153 the <code>Reply-To</code> field and the <code>Subject</code> line.
 154 When the recipients reply they will probably preserve the
 155 <code>submit\@$gEmailDomain</code> entry in the header and have their
 156 message filed as a new $gBug report.  This leads to many duplicated
 157 reports.
 158
 159 <p>The <em>right</em> way to do this is to use the <code>X-Debbugs-CC</code>
 160 header.  Add a line like this to your message's mail header (<em>not</em>
 161 to the pseudo header with the <code>Package</code> field):
 162 <pre>
 163   X-Debbugs-CC: other-list\@cosmic.edu
 164 </pre>
 165 This will cause the $gBug tracking system to send a copy of your report
 166 to the address(es) in the <code>X-Debbugs-CC</code> line as well as to
 167 any mailing list.
 168
 169 <p>Avoid sending such copies to the addresses of other $gBug reports, as
 170 they will be caught by the checks that prevent mail loops. There is
 171 relatively little point in using <code>X-Debbugs-CC</code> for this
 172 anyway, as the $gBug number added by that mechanism will just be
 173 replaced by a new one; use an ordinary <code>CC</code> header instead.
 174
 175 <p>This feature can often be combined usefully with mailing
 176 <code>quiet</code> - see below.
 177
 178
 179 <h2><A name="severities">Severity levels</a></h2>
 180
 181 <p>If a report is of a particularly serious $gBug, or is merely a feature
 182 request that, you can set the severity level of the $gBug as you report
 183 it.  This is not required, however, and the developers will assign an
 184 appropriate severity level to your report if you do not.
 185
 186 <p>To assign a severity level, put a line like this one in the
 187 <a href="#pseudoheader">pseudo-header</a>:</p>
 188
 189 <pre>
 190 Severity: &lt;<var>severity</var>&gt;
 191 </pre>
 192
 193 <p>Replace &lt;<var>severity</var>&gt; with one of the available severity
 194 levels, as described in the
 195 <a href="Developer.html#severities">developers' documentation</a>.</p>
 196
 197
 198 <h2><a name="tags">Assigning tags</a></h2>
 199
 200 <p>You can set tags on a $gBug as you are reporting it. For example, if
 201 you are including a patch with your $gBug report, you may wish to set
 202 the <code>patch</code> tag.  This is not required, and the developers
 203 will set tags on your report as and when it is appropriate.
 204
 205 <p>To set tags, put a line like this one in the
 206 <a href="#pseudoheader">pseudo-header</a>:</p>
 207
 208 <pre>
 209 Tags: &lt;<var>tags</var>&gt;
 210 </pre>
 211
 212 <p>Replace &lt;<var>tags</var>&gt; with one or more of the available tags,
 213 as described in the
 214 <a href="Developer.html#tags">developers' documentation</a>.
 215 Separate multiple tags with commas, spaces, or both.
 216
 217
 218 <h2>Not forwarding to the mailing list - minor $gBug reports</h2>
 219
 220 <p>If a $gBug report is minor (for example, a documentation typo or other
 221 trivial build problem), or you're submitting many reports at once,
 222 send them to <code>maintonly\@$gEmailDomain</code> or
 223 <code>quiet\@$gEmailDomain</code>.
 224 <code>maintonly</code> will send the report on to the package
 225 maintainer (provided you supply a correct <code>Package</code> line in
 226 the pseudo-header and the maintainer is known), and <code>quiet</code>
 227 will not forward it anywhere at all but only file it as a $gBug (useful
 228 if, for example, you are submitting many similar $gBugs and want to post
 229 only a summary).
 230
 231 <p>If you do this the $gBug system will set the <code>Reply-To</code> of
 232 any forwarded message so that replies will by default be processed in
 233 the same way as the original report.
 234
 235
 236 <h2>Acknowledgements</h2>
 237
 238 <p>Normally, the $gBug system will return an acknowledgement to you by
 239 e-mail when you report a new bug or submit additional information to an
 240 existing bug. If you want to suppress this acknowledgement, include an
 241 <code>X-Debbugs-No-Ack</code> header in your e-mail (the contents of this
 242 header do not matter; however, it must be in the mail header and
 243 <em>not</em> in the pseudo-header with the <code>Package</code> field). If
 244 you report a new $gBug with this header, you will need to check the web
 245 interface yourself to find the $gBug number.</p>
 246
 247 <p>Note that this header will not suppress acknowledgements from the
 248 <code>control\@$gEmailDomain</code> mailserver, since those acknowledgements
 249 may contain error messages which should be read and acted upon.</p>
 250
 251
 252 <h3>$gBug reports against unknown packages</h3>
 253
 254 <p>If the $gBug tracking system doesn't know who the maintainer of the
 255 relevant package is it'll forward the report to
 256 the mailing list even if <code>maintonly</code> was used.
 257
 258 <p>When sending to <code>maintonly\@$gEmailDomain</code> or
 259 <var>nnn</var><code>-maintonly\@$gEmailDomain</code> you should make sure that
 260 the $gBug report is assigned to the right package, by putting a correct
 261 <code>Package</code> at the top of an original submission of a report,
 262 or by using <a href="server-control.html">the
 263 <code>control\@$gEmailDomain</code> service</a> to (re)assign the report
 264 appropriately first if it isn't correct already.
 265
 266 $gXtraReportingInfo
 267
 268 <hr>
 269
 270 <p>Other pages:
 271 <ul>
 272   <li><a href="./">Bug tracking system main contents page.</a>
 273   <li><a href="Developer.html">Developers' information regarding the $gBug processing system.</a>
 274   <li><a href="Access.html">Accessing the $gBug tracking logs other than by WWW.</a>
 275   <li><a href="db/ix/full.html">Full list of outstanding and recent $gBug reports.</a>
 276   <li><a href="db/ix/packages.html">Packages with $gBug reports.</a>
 277   <li><a href="db/ix/maintainers.html">Maintainers of packages with $gBug reports.</a>
 278 $gHTMLOtherPageList
 279 </ul>
 280
 281 $gHTMLTail
 282
 283 HTML_END