Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
REPORTING-BUGS: convert to ReST markup
- add a title to the document;
- use :: before verbatim blocks;
- add blank lines where required;
- use protocol for URL references;
- use a verbatim block for the bugs template;
- add cross references to SecurityBugs.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
+37
-29
+37
-29
REPORTING-BUGS
+37
-29
REPORTING-BUGS
···
1
+
.. _reportingbugs:
2
+
3
+
Reporting bugs
4
+
++++++++++++++
5
+
1
6
Background
2
7
==========
3
8
···
55
50
public mailing list(s) in the email thread.
56
51
57
52
If you know which driver is causing issues, you can pass one of the driver
58
-
files to the get_maintainer.pl script:
53
+
files to the get_maintainer.pl script::
54
+
59
55
perl scripts/get_maintainer.pl -f <filename>
60
56
61
57
If it is a security bug, please copy the Security Contact listed in the
62
58
MAINTAINERS file. They can help coordinate bugfix and disclosure. See
63
-
Documentation/SecurityBugs for more information.
59
+
:ref:`Documentation/SecurityBugs <securitybugs>` for more information.
64
60
65
61
If you can't figure out which subsystem caused the issue, you should file
66
62
a bug in kernel.org bugzilla and send email to
···
75
69
76
70
If you haven't reported a bug before, please read:
77
71
78
-
http://www.chiark.greenend.org.uk/~sgtatham/bugs.html
79
-
http://www.catb.org/esr/faqs/smart-questions.html
72
+
http://www.chiark.greenend.org.uk/~sgtatham/bugs.html
73
+
74
+
http://www.catb.org/esr/faqs/smart-questions.html
80
75
81
76
It's REALLY important to report bugs that seem unrelated as separate email
82
77
threads or separate bugzilla entries. If you report several unrelated
···
106
99
107
100
First run the ver_linux script included as scripts/ver_linux, which
108
101
reports the version of some important subsystems. Run this script with
109
-
the command "sh scripts/ver_linux".
102
+
the command ``sh scripts/ver_linux``.
110
103
111
104
Use that information to fill in all fields of the bug report form, and
112
105
post it to the mailing list with a subject of "PROBLEM: <one line
113
-
summary from [1.]>" for easy identification by the developers.
106
+
summary from [1.]>" for easy identification by the developers::
114
107
115
-
[1.] One line summary of the problem:
116
-
[2.] Full description of the problem/report:
117
-
[3.] Keywords (i.e., modules, networking, kernel):
118
-
[4.] Kernel information
119
-
[4.1.] Kernel version (from /proc/version):
120
-
[4.2.] Kernel .config file:
121
-
[5.] Most recent kernel version which did not have the bug:
122
-
[6.] Output of Oops.. message (if applicable) with symbolic information
123
-
resolved (see Documentation/oops-tracing.txt)
124
-
[7.] A small shell script or example program which triggers the
125
-
problem (if possible)
126
-
[8.] Environment
127
-
[8.1.] Software (add the output of the ver_linux script here)
128
-
[8.2.] Processor information (from /proc/cpuinfo):
129
-
[8.3.] Module information (from /proc/modules):
130
-
[8.4.] Loaded driver and hardware information (/proc/ioports, /proc/iomem)
131
-
[8.5.] PCI information ('lspci -vvv' as root)
132
-
[8.6.] SCSI information (from /proc/scsi/scsi)
133
-
[8.7.] Other information that might be relevant to the problem
134
-
(please look in /proc and include all information that you
135
-
think to be relevant):
136
-
[X.] Other notes, patches, fixes, workarounds:
108
+
[1.] One line summary of the problem:
109
+
[2.] Full description of the problem/report:
110
+
[3.] Keywords (i.e., modules, networking, kernel):
111
+
[4.] Kernel information
112
+
[4.1.] Kernel version (from /proc/version):
113
+
[4.2.] Kernel .config file:
114
+
[5.] Most recent kernel version which did not have the bug:
115
+
[6.] Output of Oops.. message (if applicable) with symbolic information
116
+
resolved (see Documentation/oops-tracing.txt)
117
+
[7.] A small shell script or example program which triggers the
118
+
problem (if possible)
119
+
[8.] Environment
120
+
[8.1.] Software (add the output of the ver_linux script here)
121
+
[8.2.] Processor information (from /proc/cpuinfo):
122
+
[8.3.] Module information (from /proc/modules):
123
+
[8.4.] Loaded driver and hardware information (/proc/ioports, /proc/iomem)
124
+
[8.5.] PCI information ('lspci -vvv' as root)
125
+
[8.6.] SCSI information (from /proc/scsi/scsi)
126
+
[8.7.] Other information that might be relevant to the problem
127
+
(please look in /proc and include all information that you
128
+
think to be relevant):
129
+
[X.] Other notes, patches, fixes, workarounds:
137
130
138
131
139
132
Follow up
···
160
153
Linux kernel maintainers are busy, overworked human beings. Some times
161
154
they may not be able to address your bug in a day, a week, or two weeks.
162
155
If they don't answer your email, they may be on vacation, or at a Linux
163
-
conference. Check the conference schedule at LWN.net for more info:
156
+
conference. Check the conference schedule at https://LWN.net for more info:
157
+
164
158
https://lwn.net/Calendar/
165
159
166
160
In general, kernel maintainers take 1 to 5 business days to respond to