Sarah Sharp | d60418b | 2013-04-13 17:44:55 -0700 | [diff] [blame] | 1 | Identify the problematic subsystem |
| 2 | ---------------------------------- |
| 3 | |
| 4 | Identifying which part of the Linux kernel might be causing your issue |
| 5 | increases your chances of getting your bug fixed. Simply posting to the |
| 6 | generic linux-kernel mailing list (LKML) may cause your bug report to be |
| 7 | lost in the noise of a mailing list that gets 1000+ emails a day. |
| 8 | |
| 9 | Instead, try to figure out which kernel subsystem is causing the issue, |
| 10 | and email that subsystem's maintainer and mailing list. If the subsystem |
| 11 | maintainer doesn't answer, then expand your scope to mailing lists like |
| 12 | LKML. |
| 13 | |
| 14 | |
| 15 | Identify who to notify |
| 16 | ---------------------- |
| 17 | |
| 18 | Once you know the subsystem that is causing the issue, you should send a |
| 19 | bug report. Some maintainers prefer bugs to be reported via bugzilla |
| 20 | (https://bugzilla.kernel.org), while others prefer that bugs be reported |
| 21 | via the subsystem mailing list. |
| 22 | |
| 23 | To find out where to send an emailed bug report, find your subsystem or |
| 24 | device driver in the MAINTAINERS file. Search in the file for relevant |
| 25 | entries, and send your bug report to the person(s) listed in the "M:" |
| 26 | lines, making sure to Cc the mailing list(s) in the "L:" lines. When the |
| 27 | maintainer replies to you, make sure to 'Reply-all' in order to keep the |
| 28 | public mailing list(s) in the email thread. |
| 29 | |
| 30 | If you know which driver is causing issues, you can pass one of the driver |
| 31 | files to the get_maintainer.pl script: |
| 32 | perl scripts/get_maintainer.pl -f <filename> |
| 33 | |
| 34 | If it is a security bug, please copy the Security Contact listed in the |
| 35 | MAINTAINERS file. They can help coordinate bugfix and disclosure. See |
| 36 | Documentation/SecurityBugs for more information. |
| 37 | |
| 38 | If you can't figure out which subsystem caused the issue, you should file |
| 39 | a bug in kernel.org bugzilla and send email to |
| 40 | linux-kernel@vger.kernel.org, referencing the bugzilla URL. (For more |
| 41 | information on the linux-kernel mailing list see |
| 42 | http://www.tux.org/lkml/). |
| 43 | |
| 44 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 45 | [Some of this is taken from Frohwalt Egerer's original linux-kernel FAQ] |
| 46 | |
Sarah Sharp | 7883a25 | 2013-04-13 19:11:26 -0700 | [diff] [blame^] | 47 | Gather information |
| 48 | ------------------ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 49 | |
Sarah Sharp | 7883a25 | 2013-04-13 19:11:26 -0700 | [diff] [blame^] | 50 | The most important information in a bug report is how to reproduce the |
| 51 | bug. This includes system information, and (most importantly) |
| 52 | step-by-step instructions for how a user can trigger the bug. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 53 | |
Sarah Sharp | 7883a25 | 2013-04-13 19:11:26 -0700 | [diff] [blame^] | 54 | If the failure includes an "OOPS:", take a picture of the screen, capture |
| 55 | a netconsole trace, or type the message from your screen into the bug |
| 56 | report. Please read "Documentation/oops-tracing.txt" before posting your |
| 57 | bug report. This explains what you should do with the "Oops" information |
| 58 | to make it useful to the recipient. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 59 | |
Sarah Sharp | 7883a25 | 2013-04-13 19:11:26 -0700 | [diff] [blame^] | 60 | This is a suggested format for a bug report sent via email or bugzilla. |
| 61 | Having a standardized bug report form makes it easier for you not to |
Tobias Klauser | 9dcbb32 | 2005-09-10 00:26:58 -0700 | [diff] [blame] | 62 | overlook things, and easier for the developers to find the pieces of |
Sarah Sharp | 7883a25 | 2013-04-13 19:11:26 -0700 | [diff] [blame^] | 63 | information they're really interested in. If some information is not |
| 64 | relevant to your bug, feel free to exclude it. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 65 | |
Sarah Sharp | 3b12c21 | 2013-04-13 17:55:18 -0700 | [diff] [blame] | 66 | First run the ver_linux script included as scripts/ver_linux, which |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 67 | reports the version of some important subsystems. Run this script with |
| 68 | the command "sh scripts/ver_linux". |
| 69 | |
| 70 | Use that information to fill in all fields of the bug report form, and |
| 71 | 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] | 72 | summary from [1.]>" for easy identification by the developers. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 73 | |
Tobias Klauser | 9dcbb32 | 2005-09-10 00:26:58 -0700 | [diff] [blame] | 74 | [1.] One line summary of the problem: |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 75 | [2.] Full description of the problem/report: |
| 76 | [3.] Keywords (i.e., modules, networking, kernel): |
Randy Dunlap | 4e229be | 2006-12-06 20:39:14 -0800 | [diff] [blame] | 77 | [4.] Kernel information |
| 78 | [4.1.] Kernel version (from /proc/version): |
| 79 | [4.2.] Kernel .config file: |
Andrew Morton | 30e835e | 2005-08-05 11:59:32 -0700 | [diff] [blame] | 80 | [5.] Most recent kernel version which did not have the bug: |
| 81 | [6.] Output of Oops.. message (if applicable) with symbolic information |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 82 | resolved (see Documentation/oops-tracing.txt) |
Andrew Morton | 30e835e | 2005-08-05 11:59:32 -0700 | [diff] [blame] | 83 | [7.] A small shell script or example program which triggers the |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 84 | problem (if possible) |
Andrew Morton | 30e835e | 2005-08-05 11:59:32 -0700 | [diff] [blame] | 85 | [8.] Environment |
| 86 | [8.1.] Software (add the output of the ver_linux script here) |
| 87 | [8.2.] Processor information (from /proc/cpuinfo): |
| 88 | [8.3.] Module information (from /proc/modules): |
| 89 | [8.4.] Loaded driver and hardware information (/proc/ioports, /proc/iomem) |
| 90 | [8.5.] PCI information ('lspci -vvv' as root) |
| 91 | [8.6.] SCSI information (from /proc/scsi/scsi) |
| 92 | [8.7.] Other information that might be relevant to the problem |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 93 | (please look in /proc and include all information that you |
| 94 | think to be relevant): |
| 95 | [X.] Other notes, patches, fixes, workarounds: |
| 96 | |
| 97 | |
| 98 | Thank you |