/[webwml]/webwml/english/Bugs/Reporting.wml
ViewVC logotype

Diff of /webwml/english/Bugs/Reporting.wml

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.18 by joy, Mon Jul 23 13:56:25 2001 UTC revision 1.19 by joy, Mon Jul 23 14:26:51 2001 UTC
# Line 2  Line 2 
2    
3  <h1>How to report a bug in Debian</h1>  <h1>How to report a bug in Debian</h1>
4    
5  <P>Send mail to  <h2>Important things to note <strong>before</strong> sending</h2>
 <A href="mailto:submit@bugs.debian.org"><code>submit@bugs.debian.org</code></A>,  
 as described below.</P>  
6    
7  <p>Please don't report several unrelated bugs - especially ones in  <p>Please don't report several unrelated bugs - especially ones in
8  different packages - in one message.  Also, please don't mail your bug  different packages - in one message.  Also, please don't mail your bug
# Line 12  report to any mailing lists or recipient Line 10  report to any mailing lists or recipient
10  <code>submit@bugs</code> (for details of how to do this right, see  <code>submit@bugs</code> (for details of how to do this right, see
11  <A href="#xcc">below</A>).</P>  <A href="#xcc">below</A>).</P>
12    
13  <P>Lists of currently-outstanding bugs are available <A href="./">on  <p>You should check if your bug report has already been filed before
14  the World Wide Web</A> and <A href="Access">elsewhere</A> - see  submitting it. Lists of currently outstanding bugs are available
15  other documents for details.</P>  <a href="./">on the World Wide Web</a> and <a href="Access">elsewhere</a>
16    - see other documents for details.</p>
17    
18    <p>If you can't seem to figure out which package contains the bug report,
19    please send e-mail to the <a href="mailto:debian-user@lists.debian.org">
20    Debian user mailing list</a> asking for advice. If your problem doesn't
21    relate just to one package but some general Debian service, there are
22    several <a href="pseudo-packages">pseudo-packages</a> or even
23    <a href="../MailingLists/subscribe">mailing lists</a> that you can use
24    to relay your message to us instead.
25    
26  <P>You need to put a pseudo-header at the start of the body of the  <h2>Sending the bug report via e-mail</h2>
 message, with the <code>Package:</code> and <code>Version:</code>  
 lines giving the name and version of the package which has the bug.  
 (The pseudo-header fields should start at the very start of their lines.  
 The bug system does not currently understand MIME or PGP mail properly  
 and may fail to recognise the pseudo-headers in such mail.)  
 (You can get these using  
 <code>dpkg --search</code> and <code>dpkg --list</code>; see  
 <code>dpkg --help</code>.  
   
 <em>See below for <A href="#details">further requirements</A></em>.</P>  
   
 <P>There are some pseudo-packages available for putting in the  
 <code>Package</code> line when reporting a bug in something other than  
 an actual Debian software package.  
 There is <A HREF="pseudo-packages">a list of these</A> on the bugs WWW  
 pages.</P>  
27    
28    <P>Send email to
29    <A href="mailto:submit@bugs.debian.org"><code>submit@bugs.debian.org</code></A>,
30    as described below.</P>
31    
32  <h2><A name="example">Example</A></h2>  <P>Of course, like any email, you should include a clear, descriptive
33    <code>Subject</code> line in your main mail header.  The subject you
34    give will be used as the initial bug title in the tracking system, so
35    please try to make it informative!</P>
36    
37  <P>A bug report, with mail header, looks something like this:  <P>You need to put a pseudo-header at the start of the body of the
38  <PRE>  message. That means that the first lines of the message body should say:
   To: submit@bugs.debian.org  
   From: diligent@testing.linux.org  
   Subject: Hello says `goodbye'  
39    
40    <A name="pseudoheader">Package: hello</A>  <pre>
41    Version: 1.3-16  Package: &lt;something&gt;
42    </pre>
43    
44    When I invoke `hello' without arguments from an ordinary shell  <p>Replace <code>&lt;something&gt;</code> with the name of the package which
45    prompt it prints `goodbye', rather than the expected `hello, world'.  has the bug.
   Here is a transcript:  
46    
47    $ hello  <p>The second line of the message should say:
   goodbye  
   $ /usr/bin/hello  
   goodbye  
   $  
48    
49    I suggest that the output string, in hello.c, be corrected.  <pre>
50    Version: &lt;something&gt;
51    </pre>
52    
53    I am using Debian GNU/Linux 2.2, kernel 2.2.17-pre-patch-13  <p>Replace <code>&lt;something&gt;</code> with the version of the package.
   and libc6 2.1.3-10.  
 </PRE>  
54    
55  <h2><A name="details">Please include in your report:</A></h2>  <p>See <a href="#findpkgver">this example</a> for information on how to find
56    this information.
57    
58    <p>The pseudo-header fields should start at the very start of their lines.
59    The bug system does not currently understand MIME or PGP mail properly
60    and may fail to recognise the pseudo-headers in such mail.
61    
62    <p>Please include in your report:
63    
64  <ul>  <ul>
65  <li>The <em>exact</em> and <em>complete</em> text of any error  <li>The <em>exact</em> and <em>complete</em> text of any error
# Line 94  they are small please include in your re Line 91  they are small please include in your re
91  to reproduce the problem (uuencoding them if they may contain odd  to reproduce the problem (uuencoding them if they may contain odd
92  characters etc.).</P>  characters etc.).</P>
93    
94  <P>Of course, like any email, you should include a clear, descriptive  
95  <code>Subject</code> line in your main mail header.  The subject you  <h2><A name="example">Example</A></h2>
96  give will be used as the initial bug title in the tracking system, so  
97  please try to make it informative!</P>  <P>A bug report, with mail header, looks something like this:
98    <PRE>
99      To: submit@bugs.debian.org
100      From: diligent@testing.linux.org
101      Subject: Hello says `goodbye'
102    
103      <A name="pseudoheader">Package: hello</A>
104      Version: 1.3-16
105    
106      When I invoke `hello' without arguments from an ordinary shell
107      prompt it prints `goodbye', rather than the expected `hello, world'.
108      Here is a transcript:
109    
110      $ hello
111      goodbye
112      $ /usr/bin/hello
113      goodbye
114      $
115    
116      I suggest that the output string, in hello.c, be corrected.
117    
118      I am using Debian GNU/Linux 2.2, kernel 2.2.17-pre-patch-13
119      and libc6 2.1.3-10.
120    </PRE>
121    
122  <h2><A name="xcc">Sending copies of bug reports to other addresses</A></h2>  <h2><A name="xcc">Sending copies of bug reports to other addresses</A></h2>
123    
# Line 158  only a summary).</P> Line 178  only a summary).</P>
178  any forwarded message so that replies will by default be processed in  any forwarded message so that replies will by default be processed in
179  the same way as the original report.</P>  the same way as the original report.</P>
180    
181    
182  <h2>Bug reports against unknown packages</h2>  <h2>Bug reports against unknown packages</h2>
183    
184  <P>If the bug tracking system doesn't know who the maintainer of the  <P>If the bug tracking system doesn't know who the maintainer of the
# Line 172  or by using <A href="server-control">the Line 193  or by using <A href="server-control">the
193  <code>control@bugs</code> service</A> to (re)assign the report  <code>control@bugs</code> service</A> to (re)assign the report
194  appropriately first if it isn't correct already.</P>  appropriately first if it isn't correct already.</P>
195    
196  <h2>Using <code>dpkg</code> to find the package and version for the report</h2>  
197    <h2><a name="findpkgver">Using <code>dpkg</code> to find the package and
198    version for the report</a></h2>
199    
200  <P>If you are reporting a bug in a command, you can find out which  <P>If you are reporting a bug in a command, you can find out which
201  package installed it by using <code>dpkg --search</code>.  You can  package installed it by using <code>dpkg --search</code>.  You can

Legend:
Removed from v.1.18  
changed lines
  Added in v.1.19

  ViewVC Help
Powered by ViewVC 1.1.5