[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <d94aa32d4a1ed5ef9d0f768d05e64987f4a1ae69.1761481839.git.linux@leemhuis.info>
Date: Sun, 26 Oct 2025 13:41:53 +0100
From: Thorsten Leemhuis <linux@...mhuis.info>
To: Jonathan Corbet <corbet@....net>
Cc: workflows@...r.kernel.org,
linux-doc@...r.kernel.org,
regressions@...ts.linux.dev,
linux-kernel@...r.kernel.org
Subject: [PATCH v1 02/30] docs: reporting-issues: tweak the reference section intro
Small improvements to the intro of the reference section.
Signed-off-by: Thorsten Leemhuis <linux@...mhuis.info>
---
.../admin-guide/reporting-issues.rst | 67 +++++++++----------
1 file changed, 31 insertions(+), 36 deletions(-)
diff --git a/Documentation/admin-guide/reporting-issues.rst b/Documentation/admin-guide/reporting-issues.rst
index 3bc47afaf85ea0..90b50c27c0d2b6 100644
--- a/Documentation/admin-guide/reporting-issues.rst
+++ b/Documentation/admin-guide/reporting-issues.rst
@@ -244,42 +244,37 @@ The reference section below explains each of these steps in more detail.
Reference section: Reporting issues to the kernel maintainers
=============================================================
-The detailed guides above outline all the major steps in brief fashion, which
-should be enough for most people. But sometimes there are situations where even
-experienced users might wonder how to actually do one of those steps. That's
-what this section is for, as it will provide a lot more details on each of the
-above steps. Consider this as reference documentation: it's possible to read it
-from top to bottom. But it's mainly meant to skim over and a place to look up
-details how to actually perform those steps.
-
-A few words of general advice before digging into the details:
-
- * The Linux kernel developers are well aware this process is complicated and
- demands more than other FLOSS projects. We'd love to make it simpler. But
- that would require work in various places as well as some infrastructure,
- which would need constant maintenance; nobody has stepped up to do that
- work, so that's just how things are for now.
-
- * A warranty or support contract with some vendor doesn't entitle you to
- request fixes from developers in the upstream Linux kernel community: such
- contracts are completely outside the scope of the Linux kernel, its
- development community, and this document. That's why you can't demand
- anything such a contract guarantees in this context, not even if the
- developer handling the issue works for the vendor in question. If you want
- to claim your rights, use the vendor's support channel instead. When doing
- so, you might want to mention you'd like to see the issue fixed in the
- upstream Linux kernel; motivate them by saying it's the only way to ensure
- the fix in the end will get incorporated in all Linux distributions.
-
- * If you never reported an issue to a FLOSS project before you should consider
- reading `How to Report Bugs Effectively
- <https://www.chiark.greenend.org.uk/~sgtatham/bugs.html>`_, `How To Ask
- Questions The Smart Way
- <http://www.catb.org/esr/faqs/smart-questions.html>`_, and `How to ask good
- questions <https://jvns.ca/blog/good-questions/>`_.
-
-With that off the table, find below the details on how to properly report
-issues to the Linux kernel developers.
+The step-by-step guide above outlines all the major steps in brief fashion,
+which usually covers everything required. But even experienced users will
+sometimes wonder how to actually realize some of those steps or why they are
+needed; there are also corner cases the guide ignores for readability. That is
+what the entries in this reference section are for, which provide additional
+information for each of the steps in the detailed guide.
+
+A few words of general advice:
+
+* The Linux kernel developers are well aware that reporting bugs to them is
+ more complicated and demanding than in other FLOSS projects. Quite a few
+ would love to make it simpler. But that would require convincing a lot of
+ developers to change their habits; it, furthermore, would require improvements
+ on several technical fronts and people that constantly take care of various
+ things. Nobody has stepped up to do or fund that work.
+
+* A warranty or support contract with some vendor doesn't entitle you to
+ request fixes from the upstream Linux developers: Such contracts are
+ completely outside the scope of the upstream Linux kernel, its development
+ community, and this document -- even if those handling the issue work for the
+ vendor who issued the contract. If you want to claim your rights, use the
+ vendor's support channel.
+
+* If you never reported an issue to a FLOSS project before, consider skimming
+ guides like `How to ask good questions
+ <https://jvns.ca/blog/good-questions/>`_, `How To Ask Questions The Smart Way
+ <http://www.catb.org/esr/faqs/smart-questions.html>`_, and `How to Report
+ Bugs Effectively <https://www.chiark.greenend.org.uk/~sgtatham/bugs.html>`_,.
+
+With that off the table, find below details for the steps from the detailed
+guide on reporting issues to the Linux kernel developers.
Make sure you're using the upstream Linux kernel
--
2.51.0
Powered by blists - more mailing lists