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 25/30] docs: reporting-issues: improve text on non-regressions in stable
Date: Sun, 26 Oct 2025 13:42:16 +0100 [thread overview]
Message-ID: <0a3548a6b5d8ca87c9d81838d84afeb619a6985e.1761481839.git.linux@leemhuis.info> (raw)
In-Reply-To: <cover.1761481839.git.linux@leemhuis.info>
Fine-tune the instructions about handling non-regressions only occurring
in stable or longterm kernels. This removes the accompanying text in the
reference section to shorten things somewhat: this case is rare and the
instructions in the step-by-step guide cover all the important bits now.
Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info>
---
.../admin-guide/reporting-issues.rst | 129 ++----------------
1 file changed, 9 insertions(+), 120 deletions(-)
diff --git a/Documentation/admin-guide/reporting-issues.rst b/Documentation/admin-guide/reporting-issues.rst
index 9611514d10414e..a78060098c59f0 100644
--- a/Documentation/admin-guide/reporting-issues.rst
+++ b/Documentation/admin-guide/reporting-issues.rst
@@ -299,29 +299,29 @@ supported stable or longterm series that (b) you were unable to reproduce in
the current mainline and (c) is not a regression. If all of that holds true,
follow these steps:
-* Be aware: it is possible the issue will not be resolved, as the fix might be
+* Be aware: It is possible the issue will not be resolved, as the fix might be
too big or risky to backport.
-* Search Linux' mainline Git repository or `lore
+* Search Linux's mainline Git repository or `lore
<https://lore.kernel.org/all/>`_ for the change resolving the issue. In case
- you have trouble locating it, consider using a bisection; alternatively ask
+ you have trouble locating it, consider using a bisection; alternatively, ask
on the list of the affected subsystem for advice while CCing the relevant
maintainers and developers.
* Check if the change is already scheduled to be backported by searching the
- patch description for a 'stable tag' (a line like 'Cc:
- <stable@vger.kernel.org>' and the patch's title in lore.kernel.org:
+ patch description for a 'stable tag' (e.g., a line like 'Cc:
+ <stable@vger.kernel.org>') and the patch's title in lore.kernel.org:
- * If the change is already scheduled for backporting, it usually will be
- picked up within one or two weeks after being mainlined. Note though, plans
+ * If the change is already scheduled for backporting, it will usually be
+ picked up within one or two weeks after being mainlined. Note, though, plans
sometimes change; a comment next to the stable tag might also limit how far
the fix is backported and thus exclude the series you care about. If there
are good reasons for this, you are out of luck. If you can't spot any:
Send a reply asking the involved developers if backporting to the series is
- an option. Note though, the developers might greenlight backporting, but
+ an option. Note, though, the developers might greenlight backporting, but
unwilling to handle the work themselves -- in which case you or somebody
- else must test and submit the fix and everything it depends on as explained
+ else must test and submit the fix and everything it depends on, as explained
in Documentation/process/stable-kernel-rules.rst.
* If the change is not scheduled for backporting, search `lore
@@ -1457,117 +1457,6 @@ easier. And with a bit of luck there might be someone in the team that knows a
bit about programming and might be able to write a fix.
-Reference for "Reporting issues only occurring in older kernel version lines"
------------------------------------------------------------------------------
-
-This section provides details for the steps you need to take if you could not
-reproduce your issue with a mainline kernel, but want to see it fixed in older
-version lines (aka stable and longterm kernels).
-
-Some fixes are too complex
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-
- *Prepare yourself for the possibility that going through the next few steps
- might not get the issue solved in older releases: the fix might be too big
- or risky to get backported there.*
-
-Even small and seemingly obvious code-changes sometimes introduce new and
-totally unexpected problems. The maintainers of the stable and longterm kernels
-are very aware of that and thus only apply changes to these kernels that are
-within rules outlined in Documentation/process/stable-kernel-rules.rst.
-
-Complex or risky changes for example do not qualify and thus only get applied
-to mainline. Other fixes are easy to get backported to the newest stable and
-longterm kernels, but too risky to integrate into older ones. So be aware the
-fix you are hoping for might be one of those that won't be backported to the
-version line your care about. In that case you'll have no other choice then to
-live with the issue or switch to a newer Linux version, unless you want to
-patch the fix into your kernels yourself.
-
-Common preparations
-~~~~~~~~~~~~~~~~~~~
-
- *Perform the first three steps in the section "Reporting issues only
- occurring in older kernel version lines" above.*
-
-You need to carry out a few steps already described in another section of this
-guide. Those steps will let you:
-
- * Check if the kernel developers still maintain the Linux kernel version line
- you care about.
-
- * Search the Linux stable mailing list for exiting reports.
-
- * Check with the latest release.
-
-
-Check code history and search for existing discussions
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
- *Search the Linux kernel version control system for the change that fixed
- the issue in mainline, as its commit message might tell you if the fix is
- scheduled for backporting already. If you don't find anything that way,
- search the appropriate mailing lists for posts that discuss such an issue
- or peer-review possible fixes; then check the discussions if the fix was
- deemed unsuitable for backporting. If backporting was not considered at
- all, join the newest discussion, asking if it's in the cards.*
-
-In a lot of cases the issue you deal with will have happened with mainline, but
-got fixed there. The commit that fixed it would need to get backported as well
-to get the issue solved. That's why you want to search for it or any
-discussions abound it.
-
- * First try to find the fix in the Git repository that holds the Linux kernel
- sources. You can do this with the web interfaces `on kernel.org
- <https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/>`_
- or its mirror `on GitHub <https://github.com/torvalds/linux>`_; if you have
- a local clone you alternatively can search on the command line with ``git
- log --grep=<pattern>``.
-
- If you find the fix, look if the commit message near the end contains a
- 'stable tag' that looks like this:
-
- Cc: <stable@vger.kernel.org> # 5.4+
-
- If that's case the developer marked the fix safe for backporting to version
- line 5.4 and later. Most of the time it's getting applied there within two
- weeks, but sometimes it takes a bit longer.
-
- * If the commit doesn't tell you anything or if you can't find the fix, look
- again for discussions about the issue. Search the net with your favorite
- internet search engine as well as the archives for the `Linux kernel
- developers mailing list <https://lore.kernel.org/lkml/>`_. Also read the
- section `Locate kernel area that causes the issue` above and follow the
- instructions to find the subsystem in question: its bug tracker or mailing
- list archive might have the answer you are looking for.
-
- * If you see a proposed fix, search for it in the version control system as
- outlined above, as the commit might tell you if a backport can be expected.
-
- * Check the discussions for any indicators the fix might be too risky to get
- backported to the version line you care about. If that's the case you have
- to live with the issue or switch to the kernel version line where the fix
- got applied.
-
- * If the fix doesn't contain a stable tag and backporting was not discussed,
- join the discussion: mention the version where you face the issue and that
- you would like to see it fixed, if suitable.
-
-
-Ask for advice
-~~~~~~~~~~~~~~
-
- *One of the former steps should lead to a solution. If that doesn't work
- out, ask the maintainers for the subsystem that seems to be causing the
- issue for advice; CC the mailing list for the particular subsystem as well
- as the stable mailing list.*
-
-If the previous three steps didn't get you closer to a solution there is only
-one option left: ask for advice. Do that in a mail you sent to the maintainers
-for the subsystem where the issue seems to have its roots; CC the mailing list
-for the subsystem as well as the stable mailing list (stable@vger.kernel.org).
-
-
Appendix: additional background information
===========================================
--
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 ` [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 ` [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 ` Thorsten Leemhuis [this message]
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=0a3548a6b5d8ca87c9d81838d84afeb619a6985e.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