Commit 503f7944fac68f4fdf71f8ebd06907f51eb64515
Committed by
Linus Torvalds
1 parent
28d7a6ae92
Exists in
master
and in
4 other branches
REPORTING-BUGS: add get_maintainer.pl blurb
Signed-off-by: Joe Perches <joe@perches.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Showing 1 changed file with 4 additions and 1 deletions Inline Diff
REPORTING-BUGS
1 | [Some of this is taken from Frohwalt Egerer's original linux-kernel FAQ] | 1 | [Some of this is taken from Frohwalt Egerer's original linux-kernel FAQ] |
2 | 2 | ||
3 | What follows is a suggested procedure for reporting Linux bugs. You | 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 | 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. | 5 | to the kind of information that can be useful to developers - no more. |
6 | 6 | ||
7 | If the failure includes an "OOPS:" type message in your log or on | 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 | 8 | screen please read "Documentation/oops-tracing.txt" before posting your |
9 | bug report. This explains what you should do with the "Oops" information | 9 | bug report. This explains what you should do with the "Oops" information |
10 | to make it useful to the recipient. | 10 | to make it useful to the recipient. |
11 | 11 | ||
12 | Send the output to the maintainer of the kernel area that seems to | 12 | Send the output to the maintainer of the kernel area that seems to |
13 | be involved with the problem, and cc the relevant mailing list. Don't | 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 | 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. | 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 | 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 | 17 | worth even more than the oops itself. The list of maintainers and |
18 | mailing lists is in the MAINTAINERS file in this directory. | 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> | ||
19 | 22 | ||
20 | If it is a security bug, please copy the Security Contact listed | 23 | If it is a security bug, please copy the Security Contact listed |
21 | in the MAINTAINERS file. They can help coordinate bugfix and disclosure. | 24 | in the MAINTAINERS file. They can help coordinate bugfix and disclosure. |
22 | See Documentation/SecurityBugs for more information. | 25 | See Documentation/SecurityBugs for more information. |
23 | 26 | ||
24 | If you are totally stumped as to whom to send the report, send it to | 27 | If you are totally stumped as to whom to send the report, send it to |
25 | linux-kernel@vger.kernel.org. (For more information on the linux-kernel | 28 | linux-kernel@vger.kernel.org. (For more information on the linux-kernel |
26 | mailing list see http://www.tux.org/lkml/). | 29 | mailing list see http://www.tux.org/lkml/). |
27 | 30 | ||
28 | This is a suggested format for a bug report sent to the Linux kernel mailing | 31 | This is a suggested format for a bug report sent to the Linux kernel mailing |
29 | list. Having a standardized bug report form makes it easier for you not to | 32 | list. Having a standardized bug report form makes it easier for you not to |
30 | overlook things, and easier for the developers to find the pieces of | 33 | overlook things, and easier for the developers to find the pieces of |
31 | information they're really interested in. Don't feel you have to follow it. | 34 | information they're really interested in. Don't feel you have to follow it. |
32 | 35 | ||
33 | First run the ver_linux script included as scripts/ver_linux, which | 36 | First run the ver_linux script included as scripts/ver_linux, which |
34 | reports the version of some important subsystems. Run this script with | 37 | reports the version of some important subsystems. Run this script with |
35 | the command "sh scripts/ver_linux". | 38 | the command "sh scripts/ver_linux". |
36 | 39 | ||
37 | Use that information to fill in all fields of the bug report form, and | 40 | Use that information to fill in all fields of the bug report form, and |
38 | post it to the mailing list with a subject of "PROBLEM: <one line | 41 | post it to the mailing list with a subject of "PROBLEM: <one line |
39 | summary from [1.]>" for easy identification by the developers. | 42 | summary from [1.]>" for easy identification by the developers. |
40 | 43 | ||
41 | [1.] One line summary of the problem: | 44 | [1.] One line summary of the problem: |
42 | [2.] Full description of the problem/report: | 45 | [2.] Full description of the problem/report: |
43 | [3.] Keywords (i.e., modules, networking, kernel): | 46 | [3.] Keywords (i.e., modules, networking, kernel): |
44 | [4.] Kernel information | 47 | [4.] Kernel information |
45 | [4.1.] Kernel version (from /proc/version): | 48 | [4.1.] Kernel version (from /proc/version): |
46 | [4.2.] Kernel .config file: | 49 | [4.2.] Kernel .config file: |
47 | [5.] Most recent kernel version which did not have the bug: | 50 | [5.] Most recent kernel version which did not have the bug: |
48 | [6.] Output of Oops.. message (if applicable) with symbolic information | 51 | [6.] Output of Oops.. message (if applicable) with symbolic information |
49 | resolved (see Documentation/oops-tracing.txt) | 52 | resolved (see Documentation/oops-tracing.txt) |
50 | [7.] A small shell script or example program which triggers the | 53 | [7.] A small shell script or example program which triggers the |
51 | problem (if possible) | 54 | problem (if possible) |
52 | [8.] Environment | 55 | [8.] Environment |
53 | [8.1.] Software (add the output of the ver_linux script here) | 56 | [8.1.] Software (add the output of the ver_linux script here) |
54 | [8.2.] Processor information (from /proc/cpuinfo): | 57 | [8.2.] Processor information (from /proc/cpuinfo): |
55 | [8.3.] Module information (from /proc/modules): | 58 | [8.3.] Module information (from /proc/modules): |
56 | [8.4.] Loaded driver and hardware information (/proc/ioports, /proc/iomem) | 59 | [8.4.] Loaded driver and hardware information (/proc/ioports, /proc/iomem) |
57 | [8.5.] PCI information ('lspci -vvv' as root) | 60 | [8.5.] PCI information ('lspci -vvv' as root) |
58 | [8.6.] SCSI information (from /proc/scsi/scsi) | 61 | [8.6.] SCSI information (from /proc/scsi/scsi) |
59 | [8.7.] Other information that might be relevant to the problem | 62 | [8.7.] Other information that might be relevant to the problem |
60 | (please look in /proc and include all information that you | 63 | (please look in /proc and include all information that you |
61 | think to be relevant): | 64 | think to be relevant): |
62 | [X.] Other notes, patches, fixes, workarounds: | 65 | [X.] Other notes, patches, fixes, workarounds: |
63 | 66 | ||
64 | 67 | ||
65 | Thank you | 68 | Thank you |
66 | 69 |