aboutsummaryrefslogtreecommitdiffstats
path: root/REPORTING-BUGS
diff options
context:
space:
mode:
authorSarah Sharp <sarah.a.sharp@linux.intel.com>2013-04-13 20:44:55 -0400
committerSarah Sharp <sarah.a.sharp@linux.intel.com>2013-04-15 13:10:20 -0400
commitd60418bce5a2afe4ea838cda6a59c74ba8837c3f (patch)
treeb6cd991f6d6969ca6da612f0c8b360a406e62c6a /REPORTING-BUGS
parent3b12c21ab34c1057aa7f1cf73139215e12e89b6c (diff)
Docs: Step-by-step directions for reporting bugs.
REPORTING-BUGS is pretty disorganized. Bug reporters are likely to be in a frustrated, stressed frame of mind, so introduce methodical step-by-step directions for how to report bugs. Use titles so people can skim it if necessary. Slight changes in procedures: 1. Encourage people to report bugs to maintainers and sub-system mailing lists, not LKML at first. I've seen way too many people get lost in the noise because they didn't Cc the maintainer or proper mailing list. 2. Link to bugzilla.kernel.org, and let people know that some maintainers prefer bugs filed there vs. the mailing lists. (Perhaps we need an entry in MAINTAINERS for which is preferred?) 3. If someone doesn't know where to report a bug, encourage them to both file a bugzilla entry and email LKML. Their report is less likely to get lost if there's a bugzilla entry. Preserve text about reporting security bugs, and get_maintainer.pl. More will be added/modified in upcoming patches. Signed-off-by: Sarah Sharp <sarah.a.sharp@linux.intel.com>
Diffstat (limited to 'REPORTING-BUGS')
-rw-r--r--REPORTING-BUGS65
1 files changed, 46 insertions, 19 deletions
diff --git a/REPORTING-BUGS b/REPORTING-BUGS
index ad709e4ccb7c..6ed518b6f715 100644
--- a/REPORTING-BUGS
+++ b/REPORTING-BUGS
@@ -1,3 +1,47 @@
1Identify 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
1[Some of this is taken from Frohwalt Egerer's original linux-kernel FAQ] 45[Some of this is taken from Frohwalt Egerer's original linux-kernel FAQ]
2 46
3What follows is a suggested procedure for reporting Linux bugs. You aren't 47What follows is a suggested procedure for reporting Linux bugs. You aren't
@@ -9,25 +53,8 @@ please read "Documentation/oops-tracing.txt" before posting your bug
9report. This explains what you should do with the "Oops" information to 53report. This explains what you should do with the "Oops" information to
10make it useful to the recipient. 54make it useful to the recipient.
11 55
12Send the output to the maintainer of the kernel area that seems to be 56If it occurs repeatably try and describe how to recreate it. That is worth
13involved with the problem, and cc the relevant mailing list. Don't worry 57even more than the oops itself.
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
22 perl scripts/get_maintainer.pl -f <filename>
23
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.
27
28If you are totally stumped as to whom to send the report, send it to
29linux-kernel@vger.kernel.org. (For more information on the linux-kernel
30mailing list see http://www.tux.org/lkml/).
31 58
32This is a suggested format for a bug report sent to the Linux kernel mailing 59This 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 60list. Having a standardized bug report form makes it easier for you not to