1
How to report a bug in Debian
3
Important things to note before sending
5
Please don't report multiple unrelated bugs -- especially ones in
6
different packages -- in a single bug report. It makes our lives much
7
easier if you send separate reports.
9
You should check if your bug report has already been filed by someone
10
else before submitting it. Lists of currently outstanding bugs are
11
available on the World Wide Web and elsewhere -- see other documents
12
for details. You can submit your comments to an existing bug report
13
#<number> by sending e-mail to <number>@bugs.debian.org
15
If you can't seem to determine which package contains the problem,
16
please send e-mail to the Debian user mailing list asking for advice.
17
If your problem doesn't relate just to one package but some general
18
Debian service, there are several pseudo-packages or even mailing
19
lists that you can use to relay your message to us instead.
21
If you'd like to send a copy of your bug report to additional
22
recipients (such as mailing lists), you shouldn't use the usual e-mail
23
headers, but a different method, described below.
25
Sending the bug report using an automatic bug report tool
27
The reportbug program can ease filing bugs by guiding you through the
28
bug reporting process step by step. The querybts tool, available from
29
the same package as reportbug, provides a convenient text-based
30
interface to the bug tracking system.
32
Emacs users can also use the debian-bug command provided by the
33
debian-el package. When called with M-x debian-bug, it will ask for
34
all necessary information in a similar way to reportbug.
36
Sending the bug report via e-mail
38
Send e-mail to submit@bugs.debian.org, as described below.
40
Of course, like any e-mail, you should include a clear, descriptive
41
Subject line in your main mail header. The subject you give will be
42
used as the initial bug title in the tracking system, so please try to
45
You need to put a pseudo-header at the start of the body of the
46
message. That means that the first line of the message body should
50
Replace <something> with the name of the package which has the bug.
52
The second line of the message should say:
55
Replace <something> with the version of the package. Please don't
56
include any text here other than the version itself, as the bug
57
tracking system relies on this field to work out which releases are
60
You need to supply a correct Package line in the pseudo-header in
61
order for the bug tracking system to deliver the message to the
62
package's maintainer. See this example for information on how to find
65
The pseudo-header fields should start at the very start of their
68
Please include in your report:
69
* The exact and complete text of any error messages printed or
70
logged. This is very important!
71
* Exactly what you typed or did to demonstrate the problem.
72
* A description of the incorrect behaviour: exactly what behaviour
73
you were expecting, and what you observed. A transcript of an
74
example session is a good way of showing this.
75
* A suggested fix, or even a patch, if you have one.
76
* Details of the configuration of the program with the problem.
77
Include the complete text of its configuration files.
78
* The versions of any packages on which the buggy package depends.
79
* What kernel version you're using (type uname -a), your shared C
80
library (type ls -l /lib/libc.so.6 or dpkg -s libc6 | grep
81
^Version), and any other details about your Debian system, if it
82
seems appropriate. For example, if you had a problem with a Perl
83
script, you would want to provide the version of the `perl' binary
84
(type perl -v or dpkg -s perl | grep ^Version:).
85
* Appropriate details of the hardware in your system. If you're
86
reporting a problem with a device driver please list all the
87
hardware in your system, as problems are often caused by IRQ and
88
I/O address conflicts.
90
Include any detail that seems relevant -- you are in very little
91
danger of making your report too long by including too much
92
information. If they are small please include in your report any files
93
you were using to reproduce the problem (uuencoding them if they may
94
contain odd characters etc.).
96
For more advice on how to help the developers solve your problem,
97
please read How to Report Bugs Effectively.
101
A bug report, with mail header, looks something like this:
102
To: submit@bugs.debian.org
103
From: diligent@testing.linux.org
104
Subject: Hello says `goodbye'
109
When I invoke `hello' without arguments from an ordinary shell
110
prompt it prints `goodbye', rather than the expected `hello, world'.
111
Here is a transcript:
119
I suggest that the output string, in hello.c, be corrected.
121
I am using Debian GNU/Linux 2.2, kernel 2.2.17-pre-patch-13
124
Sending copies of bug reports to other addresses
126
Sometimes it is necessary to send a copy of a bug report to somewhere
127
else besides debian-bugs-dist and the package maintainer, which is
128
where they are normally sent.
130
You could do this by CC'ing your bug report to the other address(es),
131
but then the other copies would not have the bug report number put in
132
the Reply-To field and the Subject line. When the recipients reply
133
they will probably preserve the submit@bugs.debian.org entry in the
134
header and have their message filed as a new bug report. This leads to
135
many duplicated reports.
137
The right way to do this is to use the X-Debbugs-CC header. Add a line
138
like this to your message's mail header:
139
X-Debbugs-CC: other-list@cosmic.edu
141
This will cause the bug tracking system to send a copy of your report
142
to the address(es) in the X-Debbugs-CC line as well as to
145
Avoid sending such copies to the addresses of other bug reports, as
146
they will be caught by the checks that prevent mail loops. There is
147
relatively little point in using X-Debbugs-CC for this anyway, as the
148
bug number added by that mechanism will just be replaced by a new one;
149
use an ordinary CC header instead.
151
This feature can often be combined usefully with mailing quiet -- see
156
If a report is of a particularly serious bug, or is merely a feature
157
request that, you can set the severity level of the bug as you report
158
it. This is not required, however, and the developers will assign an
159
appropriate severity level to your report if you do not.
161
To assign a severity level, put a line like this one in the
165
Replace <severity> with one of the available severity levels, as
166
described in the developers' documentation.
170
You can set tags on a bug as you are reporting it. For example, if you
171
are including a patch with your bug report, you may wish to set the
172
patch tag. This is not required, however, and the developers will set
173
tags on your report as and when it is appropriate.
175
To set tags, put a line like this one in the pseudo-header:
178
Replace <tags> with one or more of the available tags, as described in
179
the developers' documentation. Separate multiple tags with commas,
184
Replace <usertags> with one or more usertags. Separate multiple tags
185
with commas, spaces, or both. If you specify a <username>, that user's
186
tags will be set. Otherwise, the e-mail address of the sender will be
187
used as the username.
189
Other pseudo headers (primarily of interest to package maintainers)
191
Forwarded: foo@example.com
193
will mark the newly submitted bug as forwarded to foo@example.com. See
194
Recording that you have passed on a bug report in the developers'
195
documentation for details.
196
Owner: foo@example.com
198
will indicate that foo@example.com is now responsible for fixing this
199
bug. See Changing bug ownership in the developers' documentation for
203
the equivalent of Package: for bugs present in the source package of
204
foopackage; for most bugs in most packages you don't want to use this
207
Finally, if your MUA doesn't allow you to edit the headers, you can
208
set the various X-Debbugs- headers in the pseudo-headers.
210
Different submission addresses (minor or mass bug reports)
212
If a bug report is minor, for example, a documentation typo or a
213
trivial build problem, please adjust the severity appropriately and
214
send it to maintonly@bugs instead of submit@bugs. maintonly will
215
forward the report to the package maintainer only, it won't forward it
216
to the BTS mailing lists.
218
If you're submitting many reports at once, you should definitely use
219
maintonly@bugs so that you don't cause too much redundant traffic on
220
the BTS mailing lists. Before submitting many similar bugs you may
221
also want to post a summary on debian-bugs-dist.
223
If wish to report a bug to the bug tracking system that's already been
224
sent to the maintainer, you can use quiet@bugs. Bugs sent to
225
quiet@bugs will not be forwarded anywhere, only filed.
227
When you use different submission addresses, the bug tracking system
228
will set the Reply-To of any forwarded message so that the replies
229
will by default be processed in the same way as the original report.
230
That means that, for example, replies to maintonly will go to
231
nnn-maintonly@bugs instead of nnn@bugs, unless of course one overrides
236
Normally, the bug tracking system will return an acknowledgement to
237
you by e-mail when you report a new bug or submit additional
238
information to an existing bug. If you want to suppress this
239
acknowledgement, include an X-Debbugs-No-Ack header in your e-mail
240
(the contents of this header do not matter; however, it must be in the
241
mail header and not in the pseudo-header with the Package field). If
242
you report a new bug with this header, you will need to check the web
243
interface yourself to find the bug number.
245
Note that this header will not suppress acknowledgements from the
246
control@bugs mailserver, since those acknowledgements may contain
247
error messages which should be read and acted upon.
249
Bug reports against unknown packages
251
If the bug tracking system doesn't know who the maintainer of the
252
relevant package is it'll forward the report to debian-bugs-dist even
253
if maintonly was used.
255
When sending to maintonly@bugs or nnn-maintonly@bugs you should make
256
sure that the bug report is assigned to the right package, by putting
257
a correct Package at the top of an original submission of a report, or
258
by using the control@bugs service to (re)assign the report
259
appropriately first if it isn't correct already.
261
Using dpkg to find the package and version for the report
263
If you are reporting a bug in a command, you can find out which
264
package installed it by using dpkg --search. You can find out which
265
version of a package you have installed by using dpkg --list or dpkg
272
apt-get is /usr/bin/apt-get
273
$ dpkg --search /usr/bin/apt-get
274
apt: /usr/bin/apt-get
276
Desired=Unknown/Install/Remove/Purge/Hold
277
| Status=Not/Installed/Config-files/Unpacked/Failed-config/Half-installed
278
|/ Err?=(none)/Hold/Reinst-required/X=both-problems (Status,Err: uppercase=bad)
279
||/ Name Version Description
280
+++-==============-==============-============================================
281
ii apt 0.3.19 Advanced front-end for dpkg
284
Status: install ok installed
288
Maintainer: APT Development Team <deity@lists.debian.org>
290
Replaces: deity, libapt-pkg-doc (<< 0.3.7), libapt-pkg-dev (<< 0.3.7)
291
Provides: libapt-pkg2.7
292
Depends: libapt-pkg2.7, libc6 (>= 2.1.2), libstdc++2.10
295
Description: Advanced front-end for dpkg
296
This is Debian's next generation front-end for the dpkg package manager.
297
It provides the apt-get utility and APT dselect method that provides a
298
simpler, safer way to install and upgrade packages.
300
APT features complete installation ordering, multiple source capability
301
and several other unique features, see the Users Guide in
302
/usr/doc/apt/guide.text.gz
303
_________________________________________________________________
305
Debian BTS administrators <owner@bugs.debian.org>
307
Debian bug tracking system
308
Copyright � 1999 Darren O. Benham, 1997, 2003 nCipher Corporation Ltd,
309
1994-1997 Ian Jackson.
310
_________________________________________________________________
added
removed
includes/sid/install/doc/bug-reporting.txt
