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