home *** CD-ROM | disk | FTP | other *** search
/ Boot Disc 15 / boot-disc-1997-11.iso / Debian / Docs / bug-reporting.txt < prev    next >
Text File  |  1997-09-15  |  8KB  |  182 lines
  1.  
  2.                          How to report a bug in Debian
  3.                                        
  4.    Send mail to submit@bugs.debian.org, as described below.
  5.    
  6.    Please don't report several unrelated bugs - especially ones in
  7.    different packages - in one message. Also, please don't mail your bug
  8.    report to any mailing lists or recipients other than submit@bugs (for
  9.    details of how to do this right, see below).
  10.    
  11.    Lists of currently-outstanding bugs are available on the World Wide
  12.    Web and elsewhere - see other documents for details.
  13.    
  14.    You should put a pseudo-header at the start of the body of the
  15.    message, with the Package: and Version: lines giving the name and
  16.    version of the Debian package which has the buggy program. (You can
  17.    get these using dpkg --search and dpkg --list; see dpkg --help.) _See
  18.    below for further requirements_.
  19.    
  20.    There are some pseudo-packages available for putting in the Package
  21.    line when reporting a bug in something other than an actual Debian
  22.    software package. There is a list of these on the bugs WWW pages.
  23.    
  24. Example
  25.  
  26.    A bug report, with mail header, looks something like this:
  27.  
  28.   To: submit@bugs.debian.org
  29.   From: diligent@testing.linux.org
  30.   Subject: Hello says `goodbye'
  31.  
  32.   Package: hello
  33.   Version: 1.3-2
  34.  
  35.   When I invoke `hello' without arguments from an ordinary shell
  36.   prompt it prints `goodbye', rather than the expected `hello, world'.
  37.   Here is a transcript:
  38.  
  39.   $ hello
  40.   goodbye
  41.   $ /usr/bin/hello
  42.   goodbye
  43.   $
  44.  
  45.   I suggest that the output string, in hello.c, be corrected.
  46.  
  47.   I am using Debian 1.1, kernel version 1.3.99.15z
  48.   and libc 5.2.18.3.2.1.3-beta.
  49.  
  50. Please include in your report:
  51.  
  52.      * The _exact_ and _complete_ text of any error messages printed or
  53.        logged. This is very important!
  54.      * Exactly what you typed or did to demonstrate the problem.
  55.      * A description of the incorrect behaviour: exactly what behaviour
  56.        you were expecting, and what you observed. A transcript of an
  57.        example session is a good way of showing this.
  58.      * A suggested fix, or even a patch, if you have one.
  59.      * Details of the configuration of the program with the problem.
  60.        Include the complete text of its configuration files.
  61.      * The version of the whole Debian system you are using.
  62.      * What kernel version you're using (type uname -a).
  63.      * What shared C library you're using (type ls -l /lib/libc.so.5).
  64.      * Any other details of your Linux system, if it seems appropriate.
  65.        For example, if you had a problem with a Debian Perl script, you
  66.        would want to provide the version of the `perl' binary (perl -v).
  67.      * Appropriate details of the hardware in your system. If you're
  68.        reporting a problem with a device driver please list _all_ the
  69.        hardware in your system, as problems are often caused by IRQ and
  70.        I/O address conflicts.
  71.        
  72.    Include any detail that seems relevant - you are in very little danger
  73.    of making your report too long by including too much information. If
  74.    they are small please include in your report any files you were using
  75.    to reproduce the problem (uuencoding them if they may contain odd
  76.    characters etc.).
  77.    
  78. Sending copies of bug reports to other addresses
  79.  
  80.    Sometimes it is necessary to send a copy of a bug report to somewhere
  81.    else besides debian-devel and the package maintainer, which is where
  82.    they are normally sent.
  83.    
  84.    You could do this by CC'ing your bug report to the other address(es),
  85.    but then the other copies would not have the bug report number put in
  86.    the Reply-To field and the Subject line. When the recipients reply
  87.    they will probably preserve the submit@bugs.debian.org entry in the
  88.    header and have their message filed as a new bug report. This leads to
  89.    many duplicated reports.
  90.    
  91.    The _right_ way to do this is to use the X-Debian-CC header. Add a
  92.    line like this to your message's mail header (not to the psuedo header
  93.    with the Package field):
  94.  
  95.  X-Debian-CC: other-list@cosmic.edu
  96.  
  97.    This will cause the bug tracking system to send a copy of your report
  98.    to the address(es) in the X-Debian-CC line as well as to debian-devel.
  99.    
  100.    This feature can often be combined usefully with mailing quiet@bugs -
  101.    see below.
  102.    
  103. Not forwarding to the mailing list - minor bug reports
  104.  
  105.    If a bug report is minor (for example, a documentation typo or other
  106.    trivial build problem), or you're submitting many reports at once,
  107.    send them to maintonly@bugs or quiet@bugs. maintonly will send the
  108.    report on to the package maintainer (provided you supply a correct
  109.    Package line in the pseudo-header and the maintainer is known), and
  110.    quiet will not forward it anywhere at all but only file it as a bug
  111.    (useful if, for example, you are submitting many similar bugs and want
  112.    to post only a summary).
  113.    
  114.    If you do this the bug system will set the Reply-To of any forwarded
  115.    message so that replies will by default be processed in the same way
  116.    as the original report.
  117.    
  118.   Unknown packages or bugs with no Package key
  119.   
  120.    If the bug tracking system doesn't know who the maintainer of the
  121.    relevant package is it'll forward the report to debian-devel even if
  122.    maintonly was used.
  123.    
  124.    When sending to maintonly@bugs or nnn-maintonly@bugs you should make
  125.    sure that the bug report is assigned to the right package, by putting
  126.    a correct Package at the top of an original submission of a report, or
  127.    by using the control@bugs service to (re)assign the report
  128.    appropriately first if it isn't correct already.
  129.    
  130. Using dpkg to find the package and version for the report
  131.  
  132.    If you are reporting a bug in a command, you can find out which
  133.    package installed it by using dpkg --search. You can find out which
  134.    version of a package you have installed by using dpkg --list or dpkg
  135.    --status.
  136.    
  137.    For example:
  138.  
  139. $ which dpkg
  140. /usr/bin/dpkg
  141. $ type dpkg
  142. dpkg is hashed (/usr/bin/dpkg)
  143. $ dpkg --search /usr/bin/dpkg
  144. dpkg: /usr/bin/dpkg
  145. $ dpkg --search '*/dpkg'
  146. dpkg: /usr/doc/copyright/dpkg
  147. dpkg: /var/lib/dpkg
  148. dpkg: /usr/bin/dpkg
  149. dpkg: /usr/lib/dpkg
  150. dpkg: /usr/doc/dpkg
  151. $ dpkg --list dpkg
  152. Desired=Unknown/Install/Remove/Purge
  153. | Status=Not/Installed/Config-files/Unpacked/Failed-config/Half-installed
  154. |/ Err?=(none)/Hold/Reinst-required/X=both-problems (Status,Err: uppercase=bad)
  155. ||/ Name            Version        Description
  156. +++-===============-==============-============================================
  157. ii  dpkg            1.2.9elf       Package maintenance system for Debian Linux
  158. $ dpkg --status dpkg
  159. Package: dpkg
  160. Essential: yes
  161. Status: install ok installed
  162. Priority: required
  163. Section: base
  164. Maintainer: Ian Jackson <ian@chiark.chu.cam.ac.uk>
  165. Version: 1.2.9elf
  166. Replaces: dpkgname
  167. Pre-Depends: libc5 (>= 5.2.18-2), ncurses3.0
  168. Conflicts: dpkgname
  169. Description: Package maintenance system for Debian Linux
  170.  This package contains the programs which handle the installation and
  171.  removal of packages on your system.
  172.  .
  173.  The primary interface for the dpkg suite is the `dselect' program;
  174.  a more low-level and less user-friendly interface is available in
  175.  the form of the `dpkg' command.
  176.  
  177. $
  178.  
  179.      _________________________________________________________________
  180.                                       
  181.     Ian Jackson / owner@bugs.debian.org. 3rd July 1996.
  182.