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