annotate REPORTING-BUGS @ 647:a5bb490065f6

Fix the build after public header sync.
Signed-off-by: Keir Fraser <keir.fraser@citrix.com>
author Keir Fraser <keir.fraser@citrix.com>
date Wed Aug 13 14:01:49 2008 +0100 (2008-08-13)
parents 831230e53067
rev   line source
ian@0 1 [Some of this is taken from Frohwalt Egerer's original linux-kernel FAQ]
ian@0 2
ian@0 3 What follows is a suggested procedure for reporting Linux bugs. You
ian@0 4 aren't obliged to use the bug reporting format, it is provided as a guide
ian@0 5 to the kind of information that can be useful to developers - no more.
ian@0 6
ian@0 7 If the failure includes an "OOPS:" type message in your log or on
ian@0 8 screen please read "Documentation/oops-tracing.txt" before posting your
ian@0 9 bug report. This explains what you should do with the "Oops" information
ian@0 10 to make it useful to the recipient.
ian@0 11
ian@0 12 Send the output to the maintainer of the kernel area that seems to
ian@0 13 be involved with the problem. Don't worry too much about getting the
ian@0 14 wrong person. If you are unsure send it to the person responsible for the
ian@0 15 code relevant to what you were doing. If it occurs repeatably try and
ian@0 16 describe how to recreate it. That is worth even more than the oops itself.
ian@0 17 The list of maintainers is in the MAINTAINERS file in this directory.
ian@0 18
ian@0 19 If it is a security bug, please copy the Security Contact listed
ian@0 20 in the MAINTAINERS file. They can help coordinate bugfix and disclosure.
ian@0 21 See Documentation/SecurityBugs for more information.
ian@0 22
ian@0 23 If you are totally stumped as to whom to send the report, send it to
ian@0 24 linux-kernel@vger.kernel.org. (For more information on the linux-kernel
ian@0 25 mailing list see http://www.tux.org/lkml/).
ian@0 26
ian@0 27 This is a suggested format for a bug report sent to the Linux kernel mailing
ian@0 28 list. Having a standardized bug report form makes it easier for you not to
ian@0 29 overlook things, and easier for the developers to find the pieces of
ian@0 30 information they're really interested in. Don't feel you have to follow it.
ian@0 31
ian@0 32 First run the ver_linux script included as scripts/ver_linux, which
ian@0 33 reports the version of some important subsystems. Run this script with
ian@0 34 the command "sh scripts/ver_linux".
ian@0 35
ian@0 36 Use that information to fill in all fields of the bug report form, and
ian@0 37 post it to the mailing list with a subject of "PROBLEM: <one line
ian@0 38 summary from [1.]>" for easy identification by the developers.
ian@0 39
ian@0 40 [1.] One line summary of the problem:
ian@0 41 [2.] Full description of the problem/report:
ian@0 42 [3.] Keywords (i.e., modules, networking, kernel):
ian@0 43 [4.] Kernel version (from /proc/version):
ian@0 44 [5.] Most recent kernel version which did not have the bug:
ian@0 45 [6.] Output of Oops.. message (if applicable) with symbolic information
ian@0 46 resolved (see Documentation/oops-tracing.txt)
ian@0 47 [7.] A small shell script or example program which triggers the
ian@0 48 problem (if possible)
ian@0 49 [8.] Environment
ian@0 50 [8.1.] Software (add the output of the ver_linux script here)
ian@0 51 [8.2.] Processor information (from /proc/cpuinfo):
ian@0 52 [8.3.] Module information (from /proc/modules):
ian@0 53 [8.4.] Loaded driver and hardware information (/proc/ioports, /proc/iomem)
ian@0 54 [8.5.] PCI information ('lspci -vvv' as root)
ian@0 55 [8.6.] SCSI information (from /proc/scsi/scsi)
ian@0 56 [8.7.] Other information that might be relevant to the problem
ian@0 57 (please look in /proc and include all information that you
ian@0 58 think to be relevant):
ian@0 59 [X.] Other notes, patches, fixes, workarounds:
ian@0 60
ian@0 61
ian@0 62 Thank you