blob: f86e500bc595b7f6e9002da71dbe878be983fd61 [file] [log] [blame]
Sarah Sharpd60418b2013-04-13 17:44:55 -07001Identify the problematic subsystem
2----------------------------------
3
4Identifying which part of the Linux kernel might be causing your issue
5increases your chances of getting your bug fixed. Simply posting to the
6generic linux-kernel mailing list (LKML) may cause your bug report to be
7lost in the noise of a mailing list that gets 1000+ emails a day.
8
9Instead, try to figure out which kernel subsystem is causing the issue,
10and email that subsystem's maintainer and mailing list. If the subsystem
11maintainer doesn't answer, then expand your scope to mailing lists like
12LKML.
13
14
15Identify who to notify
16----------------------
17
18Once you know the subsystem that is causing the issue, you should send a
19bug report. Some maintainers prefer bugs to be reported via bugzilla
20(https://bugzilla.kernel.org), while others prefer that bugs be reported
21via the subsystem mailing list.
22
23To find out where to send an emailed bug report, find your subsystem or
24device driver in the MAINTAINERS file. Search in the file for relevant
25entries, and send your bug report to the person(s) listed in the "M:"
26lines, making sure to Cc the mailing list(s) in the "L:" lines. When the
27maintainer replies to you, make sure to 'Reply-all' in order to keep the
28public mailing list(s) in the email thread.
29
30If you know which driver is causing issues, you can pass one of the driver
31files to the get_maintainer.pl script:
32 perl scripts/get_maintainer.pl -f <filename>
33
34If it is a security bug, please copy the Security Contact listed in the
35MAINTAINERS file. They can help coordinate bugfix and disclosure. See
36Documentation/SecurityBugs for more information.
37
38If you can't figure out which subsystem caused the issue, you should file
39a bug in kernel.org bugzilla and send email to
40linux-kernel@vger.kernel.org, referencing the bugzilla URL. (For more
41information on the linux-kernel mailing list see
42http://www.tux.org/lkml/).
43
44
Linus Torvalds1da177e2005-04-16 15:20:36 -070045[Some of this is taken from Frohwalt Egerer's original linux-kernel FAQ]
46
Sarah Sharp7883a252013-04-13 19:11:26 -070047Gather information
48------------------
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
Sarah Sharp7883a252013-04-13 19:11:26 -070050The most important information in a bug report is how to reproduce the
51bug. This includes system information, and (most importantly)
52step-by-step instructions for how a user can trigger the bug.
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
Sarah Sharp7883a252013-04-13 19:11:26 -070054If the failure includes an "OOPS:", take a picture of the screen, capture
55a netconsole trace, or type the message from your screen into the bug
56report. Please read "Documentation/oops-tracing.txt" before posting your
57bug report. This explains what you should do with the "Oops" information
58to make it useful to the recipient.
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
Sarah Sharp7883a252013-04-13 19:11:26 -070060This is a suggested format for a bug report sent via email or bugzilla.
61Having a standardized bug report form makes it easier for you not to
Tobias Klauser9dcbb322005-09-10 00:26:58 -070062overlook things, and easier for the developers to find the pieces of
Sarah Sharp7883a252013-04-13 19:11:26 -070063information they're really interested in. If some information is not
64relevant to your bug, feel free to exclude it.
Linus Torvalds1da177e2005-04-16 15:20:36 -070065
Sarah Sharp3b12c212013-04-13 17:55:18 -070066First run the ver_linux script included as scripts/ver_linux, which
Linus Torvalds1da177e2005-04-16 15:20:36 -070067reports the version of some important subsystems. Run this script with
68the command "sh scripts/ver_linux".
69
70Use that information to fill in all fields of the bug report form, and
71post it to the mailing list with a subject of "PROBLEM: <one line
Tobias Klauser9dcbb322005-09-10 00:26:58 -070072summary from [1.]>" for easy identification by the developers.
Linus Torvalds1da177e2005-04-16 15:20:36 -070073
Tobias Klauser9dcbb322005-09-10 00:26:58 -070074[1.] One line summary of the problem:
Linus Torvalds1da177e2005-04-16 15:20:36 -070075[2.] Full description of the problem/report:
76[3.] Keywords (i.e., modules, networking, kernel):
Randy Dunlap4e229be2006-12-06 20:39:14 -080077[4.] Kernel information
78[4.1.] Kernel version (from /proc/version):
79[4.2.] Kernel .config file:
Andrew Morton30e835e2005-08-05 11:59:32 -070080[5.] Most recent kernel version which did not have the bug:
81[6.] Output of Oops.. message (if applicable) with symbolic information
Linus Torvalds1da177e2005-04-16 15:20:36 -070082 resolved (see Documentation/oops-tracing.txt)
Andrew Morton30e835e2005-08-05 11:59:32 -070083[7.] A small shell script or example program which triggers the
Linus Torvalds1da177e2005-04-16 15:20:36 -070084 problem (if possible)
Andrew Morton30e835e2005-08-05 11:59:32 -070085[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 Torvalds1da177e2005-04-16 15:20:36 -070093 (please look in /proc and include all information that you
94 think to be relevant):
95[X.] Other notes, patches, fixes, workarounds:
96
97
98Thank you