Trivial: docs: Remove six-space indentation in REPORTING-BUGS.
[linux-2.6-block.git] / REPORTING-BUGS
CommitLineData
1da177e4
LT
1[Some of this is taken from Frohwalt Egerer's original linux-kernel FAQ]
2
3b12c21a
SS
3What follows is a suggested procedure for reporting Linux bugs. You aren't
4obliged to use the bug reporting format, it is provided as a guide to the
5kind of information that can be useful to developers - no more.
6
7If the failure includes an "OOPS:" type message in your log or on screen
8please read "Documentation/oops-tracing.txt" before posting your bug
9report. This explains what you should do with the "Oops" information to
10make it useful to the recipient.
11
12Send the output to the maintainer of the kernel area that seems to be
13involved with the problem, and cc the relevant mailing list. Don't worry
14too much about getting the wrong person. If you are unsure send it to the
15person responsible for the code relevant to what you were doing. If it
16occurs repeatably try and describe how to recreate it. That is worth even
17more than the oops itself. The list of maintainers and mailing lists is
18in the MAINTAINERS file in this directory. If you know the file name that
19causes the problem you can use the following command in this directory to
20find some of the maintainers of that file:
21
503f7944 22 perl scripts/get_maintainer.pl -f <filename>
1da177e4 23
3b12c21a
SS
24If it is a security bug, please copy the Security Contact listed in the
25MAINTAINERS file. They can help coordinate bugfix and disclosure. See
26Documentation/SecurityBugs for more information.
1da177e4 27
3b12c21a 28If you are totally stumped as to whom to send the report, send it to
1da177e4
LT
29linux-kernel@vger.kernel.org. (For more information on the linux-kernel
30mailing list see http://www.tux.org/lkml/).
31
9dcbb32f
TK
32This is a suggested format for a bug report sent to the Linux kernel mailing
33list. Having a standardized bug report form makes it easier for you not to
34overlook things, and easier for the developers to find the pieces of
1da177e4
LT
35information they're really interested in. Don't feel you have to follow it.
36
3b12c21a 37First run the ver_linux script included as scripts/ver_linux, which
1da177e4
LT
38reports the version of some important subsystems. Run this script with
39the command "sh scripts/ver_linux".
40
41Use that information to fill in all fields of the bug report form, and
42post it to the mailing list with a subject of "PROBLEM: <one line
9dcbb32f 43summary from [1.]>" for easy identification by the developers.
1da177e4 44
9dcbb32f 45[1.] One line summary of the problem:
1da177e4
LT
46[2.] Full description of the problem/report:
47[3.] Keywords (i.e., modules, networking, kernel):
4e229bef
RD
48[4.] Kernel information
49[4.1.] Kernel version (from /proc/version):
50[4.2.] Kernel .config file:
30e835e3
AM
51[5.] Most recent kernel version which did not have the bug:
52[6.] Output of Oops.. message (if applicable) with symbolic information
1da177e4 53 resolved (see Documentation/oops-tracing.txt)
30e835e3 54[7.] A small shell script or example program which triggers the
1da177e4 55 problem (if possible)
30e835e3
AM
56[8.] Environment
57[8.1.] Software (add the output of the ver_linux script here)
58[8.2.] Processor information (from /proc/cpuinfo):
59[8.3.] Module information (from /proc/modules):
60[8.4.] Loaded driver and hardware information (/proc/ioports, /proc/iomem)
61[8.5.] PCI information ('lspci -vvv' as root)
62[8.6.] SCSI information (from /proc/scsi/scsi)
63[8.7.] Other information that might be relevant to the problem
1da177e4
LT
64 (please look in /proc and include all information that you
65 think to be relevant):
66[X.] Other notes, patches, fixes, workarounds:
67
68
69Thank you