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 17/30] docs: reporting-issues: move text on 'check MAINTAINERS file' upwards
Date: Sun, 26 Oct 2025 13:42:08 +0100 [thread overview]
Message-ID: <e5e8f1c554e922cbcd34a98811a8e900c72cf434.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 | 162 +++++++++---------
1 file changed, 81 insertions(+), 81 deletions(-)
diff --git a/Documentation/admin-guide/reporting-issues.rst b/Documentation/admin-guide/reporting-issues.rst
index f040ca7c0a2f59..e9d304040e3b54 100644
--- a/Documentation/admin-guide/reporting-issues.rst
+++ b/Documentation/admin-guide/reporting-issues.rst
@@ -149,6 +149,11 @@ following the others is usually in your own interest.
[:ref:`details <reginquiry_repiref>`]
+ * Locate the driver or kernel subsystem that seems to be causing the issue.
+ Find out how and where its developers expect reports. Note: most of the
+ time this won't be bugzilla.kernel.org, as issues typically need to be sent
+ by mail to a maintainer and a public mailing list.
+
* Create a fresh backup and put system repair and restore tools at hand.
* Ensure your system does not enhance its kernels by building additional
@@ -161,11 +166,6 @@ following the others is usually in your own interest.
(say something broke when updating from 5.10.4 to 5.10.5), scroll down to
'Dealing with regressions within a stable and longterm kernel line'.
- * Locate the driver or kernel subsystem that seems to be causing the issue.
- Find out how and where its developers expect reports. Note: most of the
- time this won't be bugzilla.kernel.org, as issues typically need to be sent
- by mail to a maintainer and a public mailing list.
-
* Search the archives of the bug tracker or mailing list in question
thoroughly for reports that might match your issue. If you find anything,
join the discussion instead of sending a new report.
@@ -705,73 +705,6 @@ answer these emails on a best-effort basis.
[:ref:`back to step-by-step guide <reginquiry_repisbs>`]
-Prepare for emergencies
------------------------
-
- *Create a fresh backup and put system repair and restore tools at hand.*
-
-Reminder, you are dealing with computers, which sometimes do unexpected things,
-especially if you fiddle with crucial parts like the kernel of its operating
-system. That's what you are about to do in this process. Thus, make sure to
-create a fresh backup; also ensure you have all tools at hand to repair or
-reinstall the operating system as well as everything you need to restore the
-backup.
-
-
-Make sure your kernel doesn't get enhanced
-------------------------------------------
-
- *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.*
-
-The risk your issue report gets ignored or rejected dramatically increases if
-your kernel gets enhanced in any way. That's why you should remove or disable
-mechanisms like akmods and DKMS: those build add-on kernel modules
-automatically, for example when you install a new Linux kernel or boot it for
-the first time. Also remove any modules they might have installed. Then reboot
-before proceeding.
-
-Note, you might not be aware that your system is using one of these solutions:
-they often get set up silently when you install Nvidia's proprietary graphics
-driver, VirtualBox, or other software that requires a some support from a
-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?
-----------------------------------------
-
- *If you are facing a regression within a stable or longterm version line
- (say something broke when updating from 5.10.4 to 5.10.5), scroll down to
- 'Dealing with regressions within a stable and longterm kernel line'.*
-
-Regression within a stable and longterm kernel version line are something the
-Linux developers want to fix badly, as such issues are even more unwanted than
-regression in the main development branch, as they can quickly affect a lot of
-people. The developers thus want to learn about such issues as quickly as
-possible, hence there is a streamlined process to report them. Note,
-regressions with newer kernel version line (say something broke when switching
-from 5.9.15 to 5.10.5) do not qualify.
-
-
Check where you need to report your issue
-----------------------------------------
@@ -886,18 +819,18 @@ to find all people to contact. It queries the MAINTAINERS file and needs to be
called with a path to the source code in question. For drivers compiled as
module if often can be found with a command like this::
- $ modinfo ath10k_pci | grep filename | sed 's!/lib/modules/.*/kernel/!!; s!filename:!!; s!\.ko\(\|\.xz\)!!'
- drivers/net/wireless/ath/ath10k/ath10k_pci.ko
+ $ modinfo ath10k_pci | grep filename | sed 's!/lib/modules/.*/kernel/!!; s!filename:!!; s!\.ko\(\|\.xz\)!!'
+ drivers/net/wireless/ath/ath10k/ath10k_pci.ko
Pass parts of this to the script::
- $ ./scripts/get_maintainer.pl -f drivers/net/wireless/ath/ath10k*
- Some Human <shuman@example.com> (supporter:QUALCOMM ATHEROS ATH10K WIRELESS DRIVER)
- Another S. Human <asomehuman@example.com> (maintainer:NETWORKING DRIVERS)
- ath10k@lists.infradead.org (open list:QUALCOMM ATHEROS ATH10K WIRELESS DRIVER)
- linux-wireless@vger.kernel.org (open list:NETWORKING DRIVERS (WIRELESS))
- netdev@vger.kernel.org (open list:NETWORKING DRIVERS)
- linux-kernel@vger.kernel.org (open list)
+ $ ./scripts/get_maintainer.pl --no-git -f drivers/net/wireless/ath/ath10k*
+ Some Human <shuman@example.com> (supporter:QUALCOMM ATHEROS ATH10K WIRELESS DRIVER)
+ Another S. Human <asomehuman@example.com> (maintainer:NETWORKING DRIVERS)
+ ath10k@lists.infradead.org (open list:QUALCOMM ATHEROS ATH10K WIRELESS DRIVER)
+ linux-wireless@vger.kernel.org (open list:NETWORKING DRIVERS (WIRELESS))
+ netdev@vger.kernel.org (open list:NETWORKING DRIVERS)
+ linux-kernel@vger.kernel.org (open list)
Don't sent your report to all of them. Send it to the maintainers, which the
script calls "supporter:"; additionally CC the most specific mailing list for
@@ -915,6 +848,73 @@ modified during tree-wide cleanups by developers that do not care about the
particular driver at all.
+Prepare for emergencies
+-----------------------
+
+ *Create a fresh backup and put system repair and restore tools at hand.*
+
+Reminder, you are dealing with computers, which sometimes do unexpected things,
+especially if you fiddle with crucial parts like the kernel of its operating
+system. That's what you are about to do in this process. Thus, make sure to
+create a fresh backup; also ensure you have all tools at hand to repair or
+reinstall the operating system as well as everything you need to restore the
+backup.
+
+
+Make sure your kernel doesn't get enhanced
+------------------------------------------
+
+ *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.*
+
+The risk your issue report gets ignored or rejected dramatically increases if
+your kernel gets enhanced in any way. That's why you should remove or disable
+mechanisms like akmods and DKMS: those build add-on kernel modules
+automatically, for example when you install a new Linux kernel or boot it for
+the first time. Also remove any modules they might have installed. Then reboot
+before proceeding.
+
+Note, you might not be aware that your system is using one of these solutions:
+they often get set up silently when you install Nvidia's proprietary graphics
+driver, VirtualBox, or other software that requires a some support from a
+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?
+----------------------------------------
+
+ *If you are facing a regression within a stable or longterm version line
+ (say something broke when updating from 5.10.4 to 5.10.5), scroll down to
+ 'Dealing with regressions within a stable and longterm kernel line'.*
+
+Regression within a stable and longterm kernel version line are something the
+Linux developers want to fix badly, as such issues are even more unwanted than
+regression in the main development branch, as they can quickly affect a lot of
+people. The developers thus want to learn about such issues as quickly as
+possible, hence there is a streamlined process to report them. Note,
+regressions with newer kernel version line (say something broke when switching
+from 5.9.15 to 5.10.5) do not qualify.
+
+
Search for existing reports, second run
---------------------------------------
--
2.51.0
next prev 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 ` Thorsten Leemhuis [this message]
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 ` [PATCH v1 22/30] docs: reporting-issues: move text on 'initial write-up' upwards Thorsten Leemhuis
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=e5e8f1c554e922cbcd34a98811a8e900c72cf434.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