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