Commit 4d2f46a8 authored by Thorsten Leemhuis's avatar Thorsten Leemhuis Committed by Jonathan Corbet

docs: reporting-issues.rst: reshuffle and improve TLDR

Make the TLDR a bit shorter while improving it at the same time by going
straight to the aspects readers are more interested it. The change makes
the process especially more straight-forward for people that hit a
regression in a stable or longterm kernel. Due to the changes the TLDR
now also matches the step by step guide better.
Signed-off-by: default avatarThorsten Leemhuis <linux@leemhuis.info>
Link: https://lore.kernel.org/r/762ccd7735315d2fdaa79612fccc1f474881118b.1617113469.git.linux@leemhuis.info
[ jc: fixed transposed _` as noted by Thorsten ]
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent d8d13934
...@@ -17,46 +17,41 @@ Reporting issues ...@@ -17,46 +17,41 @@ Reporting issues
The short guide (aka TL;DR) The short guide (aka TL;DR)
=========================== ===========================
If you're facing multiple issues with the Linux kernel at once, report each Are you facing a regression with vanilla kernels from the same stable or
separately to its developers. Try your best guess which kernel part might be longterm series? One still supported? Then search the `LKML
causing the issue. Check the :ref:`MAINTAINERS <maintainers>` file for how its <https://lore.kernel.org/lkml/>`_ and the `Linux stable mailing list
developers expect to be told about issues. Note, it's rarely <https://lore.kernel.org/stable/>`_ archives for matching reports to join. If
`bugzilla.kernel.org <https://bugzilla.kernel.org/>`_, as in almost all cases you don't find any, install `the latest release from that series
the report needs to be sent by email! <https://kernel.org/>`_. If it still shows the issue, report it to the stable
mailing list (stable@vger.kernel.org).
Check the destination thoroughly for existing reports; also search the LKML
archives and the web. Join existing discussion if you find matches. If you In all other cases try your best guess which kernel part might be causing the
don't find any, install `the latest Linux mainline kernel issue. Check the :ref:`MAINTAINERS <maintainers>` file for how its developers
<https://kernel.org/>`_. Make sure it's vanilla, thus is not patched or using expect to be told about problems, which most of the time will be by email with a
add-on kernel modules. Also ensure the kernel is running in a healthy mailing list in CC. Check the destination's archives for matching reports;
environment and is not already tainted before the issue occurs. search the `LKML <https://lore.kernel.org/lkml/>`_ and the web, too. If you
don't find any to join, install `the latest mainline kernel
If you can reproduce your issue with the mainline kernel, send a report to the <https://kernel.org/>`_. If the issue is present there, send a report.
destination you determined earlier. Make sure it includes all relevant
information, which in case of a regression should mention the change that's The issue was fixed there, but you would like to see it resolved in a still
causing it which can often can be found with a bisection. Also ensure the supported stable or longterm series as well? Then install its latest release.
report reaches all people that need to know about it, for example the security If it shows the problem, search for the change that fixed it in mainline and
team, the stable maintainers or the developers of the patch that causes a check if backporting is in the works or was discarded; if it's neither, ask
regression. Once the report is out, answer any questions that might be raised those who handled the change for it.
and help where you can. That includes keeping the ball rolling: every time a
new rc1 mainline kernel is released, check if the issue is still happening **General remarks**: When installing and testing a kernel as outlined above,
there and attach a status update to your initial report. ensure it's vanilla (IOW: not patched and not using add-on modules). Also make
sure it's built and running in a healthy environment and not already tainted
If you can not reproduce the issue with the mainline kernel, consider sticking before the issue occurs.
with it; if you'd like to use an older version line and want to see it fixed
there, first make sure it's still supported. Install its latest release as While writing your report, include all information relevant to the issue, like
vanilla kernel. If you cannot reproduce the issue there, try to find the commit the kernel and the distro used. In case of a regression try to include the
that fixed it in mainline or any discussion preceding it: those will often commit-id of the change causing it, which a bisection can find. If you're facing
mention if backporting is planed or considered too complex. If backporting was multiple issues with the Linux kernel at once, report each separately.
not discussed, ask if it's in the cards. In case you don't find any commits or
a preceding discussion, see the Linux-stable mailing list archives for existing Once the report is out, answer any questions that come up and help where you
reports, as it might be a regression specific to the version line. If it is, can. That includes keeping the ball rolling by occasionally retesting with newer
report it like you would report a problem in mainline (including the releases and sending a status update afterwards.
bisection).
If you reached this point without a solution, ask for advice one the
subsystem's mailing list.
Step-by-step guide how to report issues to the kernel maintainers Step-by-step guide how to report issues to the kernel maintainers
================================================================= =================================================================
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment