workflows.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Thorsten Leemhuis <linux@leemhuis.info>
To: Jonathan Corbet <corbet@lwn.net>
Cc: workflows@vger.kernel.org, linux-doc@vger.kernel.org,
	regressions@lists.linux.dev, linux-kernel@vger.kernel.org
Subject: [PATCH v1 22/30] docs: reporting-issues: move text on 'initial write-up' upwards
Date: Sun, 26 Oct 2025 13:42:13 +0100	[thread overview]
Message-ID: <769d2d492ac273f66a1e867bb17a14f32dde0d27.1761481839.git.linux@leemhuis.info> (raw)
In-Reply-To: <cover.1761481839.git.linux@leemhuis.info>

Move text around to improve diffability of a follow-up patch.

Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info>
---
 .../admin-guide/reporting-issues.rst          | 39 +++++++++++--------
 1 file changed, 22 insertions(+), 17 deletions(-)

diff --git a/Documentation/admin-guide/reporting-issues.rst b/Documentation/admin-guide/reporting-issues.rst
index 824b7b5394440e..a5c40e75833638 100644
--- a/Documentation/admin-guide/reporting-issues.rst
+++ b/Documentation/admin-guide/reporting-issues.rst
@@ -183,10 +183,15 @@ following the others is usually in your own interest.
 
  [:ref:`details <backup_repiref>`]
 
+ * Write down coarsely how to reproduce the issue.
+
  * Ensure your system does not enhance its kernels by building additional
    kernel modules on-the-fly, which solutions like DKMS might be doing locally
    without your knowledge.
 
+ * Check if your kernel was 'tainted' when the issue occurred, as the event
+   that made the kernel set this flag might be causing the issue you face.
+
  * Write down coarsely how to reproduce the issue.
 
  * If you are facing a regression within a stable or longterm version line
@@ -926,6 +931,23 @@ operating system as well as everything you need to restore the backup.
 [:ref:`back to step-by-step guide <backup_repisbs>`]
 
 
+Document how to reproduce issue
+-------------------------------
+
+    *Write down coarsely how to reproduce the issue.*
+
+During the reporting process you will have to test if the issue
+happens with other kernel versions. Therefore, it will make your work easier if
+you know exactly how to reproduce an issue quickly on a freshly booted system.
+
+Note: it's often fruitless to report issues that only happened once, as they
+might be caused by a bit flip due to cosmic radiation. That's why you should
+try to rule that out by reproducing the issue before going further. Feel free
+to ignore this advice if you are experienced enough to tell a one-time error
+due to faulty hardware apart from a kernel issue that rarely happens and thus
+is hard to reproduce.
+
+
 Make sure your kernel doesn't get enhanced
 ------------------------------------------
 
@@ -947,23 +969,6 @@ module not part of the Linux kernel. That why your might need to uninstall the
 packages with such software to get rid of any 3rd party kernel module.
 
 
-Document how to reproduce issue
--------------------------------
-
-    *Write down coarsely how to reproduce the issue.*
-
-During the reporting process you will have to test if the issue
-happens with other kernel versions. Therefore, it will make your work easier if
-you know exactly how to reproduce an issue quickly on a freshly booted system.
-
-Note: it's often fruitless to report issues that only happened once, as they
-might be caused by a bit flip due to cosmic radiation. That's why you should
-try to rule that out by reproducing the issue before going further. Feel free
-to ignore this advice if you are experienced enough to tell a one-time error
-due to faulty hardware apart from a kernel issue that rarely happens and thus
-is hard to reproduce.
-
-
 Regression in stable or longterm kernel?
 ----------------------------------------
 
-- 
2.51.0


  parent reply	other threads:[~2025-10-26 12:42 UTC|newest]

Thread overview: 43+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-10-26 12:41 [PATCH v1 00/30] docs: reporting-issues: rework Thorsten Leemhuis
2025-10-26 12:41 ` [PATCH v1 01/30] docs: reporting-issues: mention text is best viewed rendered Thorsten Leemhuis
2025-10-27 17:18   ` Jonathan Corbet
2025-10-27 21:19   ` Randy Dunlap
2025-10-26 12:41 ` [PATCH v1 02/30] docs: reporting-issues: tweak the reference section intro Thorsten Leemhuis
2025-10-27 17:27   ` Jonathan Corbet
2025-10-26 12:41 ` [PATCH v1 03/30] docs: reporting-issues: add conclusion to the step-by-step guide Thorsten Leemhuis
2025-10-27 17:29   ` Jonathan Corbet
2025-10-26 12:41 ` [PATCH v1 04/30] docs: reporting-issues: add proper appendix Thorsten Leemhuis
2025-10-27 17:38   ` Jonathan Corbet
2025-10-26 12:41 ` [PATCH v1 05/30] docs: reporting-issues: outline why reporting is complicated Thorsten Leemhuis
2025-10-27 17:44   ` Jonathan Corbet
2025-10-26 12:41 ` [PATCH v1 06/30] docs: reporting-issues: replace TLDR guide with more of an into Thorsten Leemhuis
2025-10-28 21:32   ` Jonathan Corbet
2025-10-26 12:41 ` [PATCH v1 07/30] docs: reporting-issues: explain need for fresh vanilla kernel Thorsten Leemhuis
2025-10-28 21:40   ` Jonathan Corbet
2025-10-26 12:41 ` [PATCH v1 08/30] docs: reporting-issues: add step about processing issues separately Thorsten Leemhuis
2025-10-28 21:42   ` Jonathan Corbet
2025-10-26 12:42 ` [PATCH v1 09/30] docs: reporting-issues: tell users to check the kernel log Thorsten Leemhuis
2025-10-28 21:43   ` Jonathan Corbet
2025-10-26 12:42 ` [PATCH v1 10/30] docs: reporting-issues: move 'check tainted flag' upwards Thorsten Leemhuis
2025-10-28 21:47   ` Jonathan Corbet
2025-10-26 12:42 ` [PATCH v1 11/30] docs: reporting-issues: improve first tainted check Thorsten Leemhuis
2025-10-26 12:42 ` [PATCH v1 12/30] docs: reporting-issues: move 'check environment' upwards Thorsten Leemhuis
2025-10-26 12:42 ` [PATCH v1 13/30] docs: reporting-issues: improve environment check Thorsten Leemhuis
2025-10-26 12:42 ` [PATCH v1 14/30] docs: reporting-issues: improve text about checking for existing issues Thorsten Leemhuis
2025-10-26 12:42 ` [PATCH v1 15/30] docs: reporting-issues: improve text on classifying the bug Thorsten Leemhuis
2025-10-26 12:42 ` [PATCH v1 16/30] docs: reporting-issues: add fast-track for regressions Thorsten Leemhuis
2025-10-26 12:42 ` [PATCH v1 17/30] docs: reporting-issues: move text on 'check MAINTAINERS file' upwards Thorsten Leemhuis
2025-10-26 12:42 ` [PATCH v1 18/30] docs: reporting-issues: improve text on looking up place to report Thorsten Leemhuis
2025-10-26 12:42 ` [PATCH v1 19/30] docs: reporting-issues: move text on 'check other places' upwards Thorsten Leemhuis
2025-10-26 12:42 ` [PATCH v1 20/30] docs: reporting-issues: improve text on check other places Thorsten Leemhuis
2025-10-26 12:42 ` [PATCH v1 21/30] docs: reporting-issues: improve text on backup et. al Thorsten Leemhuis
2025-10-26 12:42 ` Thorsten Leemhuis [this message]
2025-10-26 12:42 ` [PATCH v1 23/30] docs: reporting-issues: improve text on initial write-up Thorsten Leemhuis
2025-10-26 12:42 ` [PATCH v1 24/30] docs: reporting-issues: improve text on bug verification Thorsten Leemhuis
2025-10-26 12:42 ` [PATCH v1 25/30] docs: reporting-issues: improve text on non-regressions in stable Thorsten Leemhuis
2025-10-26 12:42 ` [PATCH v1 26/30] docs: reporting-issues: improve text on second search Thorsten Leemhuis
2025-10-26 12:42 ` [PATCH v1 27/30] docs: reporting-issues: make collecting files a separate step Thorsten Leemhuis
2025-10-26 12:42 ` [PATCH v1 28/30] docs: reporting-issues: separate steps for optimizing and submitting reports Thorsten Leemhuis
2025-10-26 12:42 ` [PATCH v1 29/30] docs: reporting-issues: separate steps for follow-up tasks Thorsten Leemhuis
2025-10-26 12:42 ` [PATCH v1 30/30] docs: reporting-issues: fix a few line breaks Thorsten Leemhuis
2025-10-27 17:16 ` [PATCH v1 00/30] docs: reporting-issues: rework Jonathan Corbet

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=769d2d492ac273f66a1e867bb17a14f32dde0d27.1761481839.git.linux@leemhuis.info \
    --to=linux@leemhuis.info \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=regressions@lists.linux.dev \
    --cc=workflows@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