diff options
| author | Sarah Sharp <sarah.a.sharp@linux.intel.com> | 2013-04-13 22:11:26 -0400 |
|---|---|---|
| committer | Sarah Sharp <sarah.a.sharp@linux.intel.com> | 2013-04-15 13:10:21 -0400 |
| commit | 7883a250fed9562e6eae8a093e5e2d173ef16662 (patch) | |
| tree | 7034e8141d2f33ec8db720307031c26133e21bda /REPORTING-BUGS | |
| parent | d60418bce5a2afe4ea838cda6a59c74ba8837c3f (diff) | |
Docs: Add "Gather info" section to REPORTING-BUGS.
Add a sub-heading, and emphasize reproducibility.
Suggest taking a picture of the oops message. (Did no one have cameras
in 2006?)
Signed-off-by: Sarah Sharp <sarah.a.sharp@linux.intel.com>
Diffstat (limited to 'REPORTING-BUGS')
| -rw-r--r-- | REPORTING-BUGS | 26 |
1 files changed, 14 insertions, 12 deletions
diff --git a/REPORTING-BUGS b/REPORTING-BUGS index 6ed518b6f715..f86e500bc595 100644 --- a/REPORTING-BUGS +++ b/REPORTING-BUGS | |||
| @@ -44,22 +44,24 @@ http://www.tux.org/lkml/). | |||
| 44 | 44 | ||
| 45 | [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] |
| 46 | 46 | ||
| 47 | What follows is a suggested procedure for reporting Linux bugs. You aren't | 47 | Gather information |
| 48 | obliged to use the bug reporting format, it is provided as a guide to the | 48 | ------------------ |
| 49 | kind of information that can be useful to developers - no more. | ||
| 50 | 49 | ||
| 51 | If the failure includes an "OOPS:" type message in your log or on screen | 50 | The most important information in a bug report is how to reproduce the |
| 52 | please read "Documentation/oops-tracing.txt" before posting your bug | 51 | bug. This includes system information, and (most importantly) |
| 53 | report. This explains what you should do with the "Oops" information to | 52 | step-by-step instructions for how a user can trigger the bug. |
| 54 | make it useful to the recipient. | ||
| 55 | 53 | ||
| 56 | If it occurs repeatably try and describe how to recreate it. That is worth | 54 | If the failure includes an "OOPS:", take a picture of the screen, capture |
| 57 | even more than the oops itself. | 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. | ||
| 58 | 59 | ||
| 59 | This is a suggested format for a bug report sent to the Linux kernel mailing | 60 | This is a suggested format for a bug report sent via email or bugzilla. |
| 60 | list. Having a standardized bug report form makes it easier for you not to | 61 | Having a standardized bug report form makes it easier for you not to |
| 61 | overlook things, and easier for the developers to find the pieces of | 62 | overlook things, and easier for the developers to find the pieces of |
| 62 | information they're really interested in. Don't feel you have to follow it. | 63 | information they're really interested in. If some information is not |
| 64 | relevant to your bug, feel free to exclude it. | ||
| 63 | 65 | ||
| 64 | First run the ver_linux script included as scripts/ver_linux, which | 66 | First run the ver_linux script included as scripts/ver_linux, which |
| 65 | reports the version of some important subsystems. Run this script with | 67 | reports the version of some important subsystems. Run this script with |