mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Sarah Sharp <sarah.a.sharp@linux.intel.com>
To: Rob Landley <rob@landley.net>
Cc: linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org
Subject: [RFC 3/7] Docs: Add "Gather info" section to REPORTING-BUGS.
Date: Mon, 15 Apr 2013 10:33:32 -0700	[thread overview]
Message-ID: <7883a250fed9562e6eae8a093e5e2d173ef16662.1366046390.git.sarah.a.sharp@linux.intel.com> (raw)
In-Reply-To: <cover.1366046390.git.sarah.a.sharp@linux.intel.com>

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>
---
 REPORTING-BUGS |   26 ++++++++++++++------------
 1 files changed, 14 insertions(+), 12 deletions(-)

diff --git a/REPORTING-BUGS b/REPORTING-BUGS
index 6ed518b..f86e500 100644
--- a/REPORTING-BUGS
+++ b/REPORTING-BUGS
@@ -44,22 +44,24 @@ http://www.tux.org/lkml/).
 
 [Some of this is taken from Frohwalt Egerer's original linux-kernel FAQ]
 
-What follows is a suggested procedure for reporting Linux bugs. You aren't
-obliged to use the bug reporting format, it is provided as a guide to the
-kind of information that can be useful to developers - no more.
+Gather information
+------------------
 
-If the failure includes an "OOPS:" type message in your log or on screen
-please read "Documentation/oops-tracing.txt" before posting your bug
-report. This explains what you should do with the "Oops" information to
-make it useful to the recipient.
+The most important information in a bug report is how to reproduce the
+bug.  This includes system information, and (most importantly)
+step-by-step instructions for how a user can trigger the bug.
 
-If it occurs repeatably try and describe how to recreate it. That is worth
-even more than the oops itself.
+If the failure includes an "OOPS:", take a picture of the screen, capture
+a netconsole trace, or type the message from your screen into the bug
+report.  Please read "Documentation/oops-tracing.txt" before posting your
+bug report. This explains what you should do with the "Oops" information
+to make it useful to the recipient.
 
-This is a suggested format for a bug report sent to the Linux kernel mailing
-list. Having a standardized bug report form makes it easier for you not to
+This is a suggested format for a bug report sent via email or bugzilla.
+Having a standardized bug report form makes it easier for you not to
 overlook things, and easier for the developers to find the pieces of
-information they're really interested in. Don't feel you have to follow it.
+information they're really interested in.  If some information is not
+relevant to your bug, feel free to exclude it.
 
 First run the ver_linux script included as scripts/ver_linux, which
 reports the version of some important subsystems.  Run this script with
-- 
1.7.9


  parent reply	other threads:[~2013-04-15 17:33 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-04-15 17:33 [RFC 0/7] Update REPORTING-BUGS Sarah Sharp
2013-04-15 17:33 ` [RFC 1/7] Trivial: docs: Remove six-space indentation in REPORTING-BUGS Sarah Sharp
2013-04-15 17:33 ` [RFC 2/7] Docs: Step-by-step directions for reporting bugs Sarah Sharp
2013-04-15 17:33 ` Sarah Sharp [this message]
2013-04-15 17:33 ` [RFC 4/7] Docs: Add info on supported kernels to REPORTING-BUGS Sarah Sharp
2013-04-17  0:24   ` Rob Landley
2013-04-15 17:33 ` [RFC 5/7] Docs: Expectations for bug reporters and maintainers Sarah Sharp
2013-04-17  2:15   ` Rob Landley
2013-04-17 18:23     ` Sarah Sharp
2013-04-17 23:49       ` Rob Landley
2013-04-18 23:52         ` Sarah Sharp
2013-04-20  6:24           ` Rob Landley
2013-04-19  6:08       ` Greg KH
2013-05-01 15:26       ` Mark Brown
2013-04-15 17:33 ` [RFC 6/7] Docs: Add a tips section to REPORTING-BUGS Sarah Sharp
2013-04-15 17:33 ` [RFC 7/7] Docs: Move ref to Frohwalt Egerer to end of REPORTING-BUGS Sarah Sharp
2013-04-15 21:40 ` [RFC 0/7] Update REPORTING-BUGS Linus Torvalds
2013-04-16  1:47 ` Theodore Ts'o
2013-04-16 21:58   ` Sarah Sharp

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=7883a250fed9562e6eae8a093e5e2d173ef16662.1366046390.git.sarah.a.sharp@linux.intel.com \
    --to=sarah.a.sharp@linux.intel.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rob@landley.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

Powered by JetHome