From: Thorsten Leemhuis <linux@leemhuis.info>
To: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [RFC PATCH v1 18/26] docs: reporting-bugs: let users optimize their notes
Date: Thu, 1 Oct 2020 10:39:39 +0200 [thread overview]
Message-ID: <1cac44ddfd3aa33bfa485b47951690fb88d4f9ee.1601541165.git.linux@leemhuis.info> (raw)
In-Reply-To: <cover.1601541165.git.linux@leemhuis.info>
The reader now users the mainline kernel and is getting closer to
reporting the issue, so it's a good point to let the person recheck and
optimize the notes how to reproduce the issue. It's also a good moment
to make him search again for existing reports, as he might have learned
something in the previous steps.
Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info>
---
Documentation/admin-guide/reporting-bugs.rst | 20 ++++++++++++++++++++
1 file changed, 20 insertions(+)
diff --git a/Documentation/admin-guide/reporting-bugs.rst b/Documentation/admin-guide/reporting-bugs.rst
index 2a7d13562905..c9a3491bf4db 100644
--- a/Documentation/admin-guide/reporting-bugs.rst
+++ b/Documentation/admin-guide/reporting-bugs.rst
@@ -760,6 +760,26 @@ use one of those and help their users, head over to the section "Details about
reporting issues only occurring in older kernel version lines" below.
+Optimize description to reproduce issue
+---------------------------------------
+
+ *Optimize your notes: try to find and write the most straightforward way
+ to reproduce your issue. Make sure the end result has all the important
+ details, and at the same time is easy to read and understand for others
+ that hear about it for the first time. And if you learned something in this
+ process, consider searching again for existing reports about the issue.*
+
+An unnecessarily complex report makes it quite hard for others to understand
+your report later, thus try to find a reproducer that's straight forward to
+describe and thus easy to understand in written form. Make it long enough and
+include all important details, but at the same time try to keep it as short
+as possible.
+
+In this in the previous steps you likely have learned a thing or two about the
+issue you face. Use this knowledge and search again for existing reports
+instead you can join.
+
+
.. ############################################################################
.. Temporary marker added while this document is rewritten. Sections above
.. are new and dual-licensed under GPLv2+ and CC-BY 4.0, those below are old.
--
2.26.2
next prev parent reply other threads:[~2020-10-01 8:41 UTC|newest]
Thread overview: 75+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-01 8:39 [RFC PATCH v1 00/26] Make reporting-bugs easier to grasp and yet more detailed Thorsten Leemhuis
2020-10-01 8:39 ` [RFC PATCH v1 01/26] docs: reporting-bugs: temporary markers for licensing and diff reasons Thorsten Leemhuis
2020-10-01 8:39 ` [RFC PATCH v1 02/26] docs: reporting-bugs: Create a TLDR how to report issues Thorsten Leemhuis
2020-10-02 2:32 ` Randy Dunlap
2020-10-03 7:27 ` Thorsten Leemhuis
2020-11-11 15:24 ` Thorsten Leemhuis
2020-11-12 3:33 ` Randy Dunlap
2020-11-12 4:56 ` Thorsten Leemhuis
2020-10-01 8:39 ` [RFC PATCH v1 03/26] docs: reporting-bugs: step-by-step guide on " Thorsten Leemhuis
2020-10-02 3:02 ` Randy Dunlap
2020-10-03 8:05 ` Thorsten Leemhuis
2020-10-01 8:39 ` [RFC PATCH v1 04/26] docs: reporting-bugs: step-by-step guide for issues in stable & longterm Thorsten Leemhuis
2020-10-02 3:25 ` Randy Dunlap
2020-10-03 8:24 ` Thorsten Leemhuis
2020-10-01 8:39 ` [RFC PATCH v1 05/26] docs: reporting-bugs: begin reference section providing details Thorsten Leemhuis
2020-10-02 16:49 ` Randy Dunlap
2020-10-03 8:27 ` Thorsten Leemhuis
2020-10-01 8:39 ` [RFC PATCH v1 06/26] docs: reporting-bugs: point out we only care about fresh vanilla kernels Thorsten Leemhuis
2020-10-01 8:39 ` [RFC PATCH v1 07/26] docs: reporting-bugs: let users classify their issue Thorsten Leemhuis
2020-10-02 16:59 ` Randy Dunlap
2020-10-03 9:42 ` Thorsten Leemhuis
2020-10-01 8:39 ` [RFC PATCH v1 08/26] docs: reporting-bugs: make readers check the taint flag Thorsten Leemhuis
2020-10-02 17:08 ` Randy Dunlap
2020-10-03 9:56 ` Thorsten Leemhuis
2020-10-03 17:47 ` Randy Dunlap
2020-10-01 8:39 ` [RFC PATCH v1 09/26] docs: reporting-bugs: help users find the proper place for their report Thorsten Leemhuis
2020-10-04 4:03 ` Randy Dunlap
2020-10-07 12:05 ` Thorsten Leemhuis
2020-10-01 8:39 ` [RFC PATCH v1 10/26] docs: reporting-bugs: remind people to look for existing reports Thorsten Leemhuis
2020-10-02 17:17 ` Randy Dunlap
2020-10-03 9:58 ` Thorsten Leemhuis
2020-10-01 8:39 ` [RFC PATCH v1 11/26] docs: reporting-bugs: remind people to back up their data Thorsten Leemhuis
2020-10-01 8:39 ` [RFC PATCH v1 12/26] docs: reporting-bugs: tell users to disable DKMS et al Thorsten Leemhuis
2020-10-02 17:28 ` Randy Dunlap
2020-10-03 9:59 ` Thorsten Leemhuis
2020-10-01 8:39 ` [RFC PATCH v1 13/26] docs: reporting-bugs: point out the environment might be causing issue Thorsten Leemhuis
2020-10-02 17:32 ` Randy Dunlap
2020-10-03 10:00 ` Thorsten Leemhuis
2020-10-01 8:39 ` [RFC PATCH v1 14/26] docs: reporting-bugs: make users write notes, one for each issue Thorsten Leemhuis
2020-10-02 17:35 ` Randy Dunlap
2020-10-03 10:01 ` Thorsten Leemhuis
2020-10-01 8:39 ` [RFC PATCH v1 15/26] docs: reporting-bugs: make readers test mainline, but leave a loophole Thorsten Leemhuis
2020-10-02 17:51 ` Randy Dunlap
2020-10-03 10:11 ` Thorsten Leemhuis
2020-11-11 15:36 ` Thorsten Leemhuis
2020-11-12 3:42 ` Randy Dunlap
2020-11-12 5:22 ` Thorsten Leemhuis
2020-10-01 8:39 ` [RFC PATCH v1 16/26] docs: reporting-bugs: let users check taint status again Thorsten Leemhuis
2020-10-01 8:39 ` [RFC PATCH v1 17/26] docs: reporting-bugs: explain options if reproducing on mainline fails Thorsten Leemhuis
2020-10-01 8:39 ` Thorsten Leemhuis [this message]
2020-10-01 8:39 ` [RFC PATCH v1 19/26] docs: reporting-bugs: decode failure messages [need help] Thorsten Leemhuis
2020-10-01 8:39 ` [RFC PATCH v1 20/26] docs: reporting-bugs: instructions for handling regressions Thorsten Leemhuis
2020-10-04 4:03 ` Randy Dunlap
2020-10-04 6:31 ` Thorsten Leemhuis
2020-10-01 8:39 ` [RFC PATCH v1 21/26] docs: reporting-bugs: details on writing and sending the report Thorsten Leemhuis
2020-10-09 2:45 ` Randy Dunlap
2020-10-09 7:38 ` Thorsten Leemhuis
2020-10-01 8:50 ` [RFC PATCH v1 22/26] docs: reporting-bugs: explain what users should do once the report got out Thorsten Leemhuis
2020-10-09 17:37 ` Randy Dunlap
2020-10-11 13:29 ` Thorsten Leemhuis
2020-10-11 15:06 ` Randy Dunlap
2020-10-01 8:50 ` [RFC PATCH v1 23/26] docs: reporting-bugs: details for issues specific to stable and longterm Thorsten Leemhuis
2020-10-09 18:42 ` Randy Dunlap
2020-10-11 13:29 ` Thorsten Leemhuis
2020-10-01 8:50 ` [RFC PATCH v1 24/26] docs: reporting-bugs: explain why users might get neither reply nor fix Thorsten Leemhuis
2020-10-04 4:03 ` Randy Dunlap
2020-10-04 6:35 ` Thorsten Leemhuis
2020-10-01 8:50 ` [RFC PATCH v1 25/26] docs: reporting-bugs: explain things could be easier Thorsten Leemhuis
2020-10-04 4:03 ` Randy Dunlap
2020-10-04 6:36 ` Thorsten Leemhuis
2020-10-01 8:50 ` [RFC PATCH v1 26/26] docs: reporting-bugs: add SPDX tag and license hint, remove markers Thorsten Leemhuis
2020-11-09 11:01 ` [RFC PATCH v1 00/26] Make reporting-bugs easier to grasp and yet more detailed Thorsten Leemhuis
2020-11-09 18:21 ` Jonathan Corbet
2020-11-10 12:01 ` Thorsten Leemhuis
2020-11-10 3:23 ` Randy Dunlap
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=1cac44ddfd3aa33bfa485b47951690fb88d4f9ee.1601541165.git.linux@leemhuis.info \
--to=linux@leemhuis.info \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
/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;
as well as URLs for NNTP newsgroup(s).