Commit 247097e2 authored by Thorsten Leemhuis's avatar Thorsten Leemhuis Committed by Jonathan Corbet

docs: reporting-issues.rst: link new document about regressions

Make Documentation/admin-guide/reporting-issues.rst point to the newly
created document about regressions
(Documentation/admin-guide/regressions-regressions.rst). This allows to
shorten a few explanations the new document describes better and in more
detail.

While at it move the copyright hint to the end of the file and remove
quotes around links to other places in the documentation. Both issues
came up during the review of the new documents about regressions.
Signed-off-by: default avatarThorsten Leemhuis <linux@leemhuis.info>
Link: https://lore.kernel.org/r/f20114eaddc356a8c79dd62812a6c7f4ca5d87b9.1644994117.git.linux@leemhuis.infoSigned-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent d2b40ba2
.. SPDX-License-Identifier: (GPL-2.0+ OR CC-BY-4.0) .. SPDX-License-Identifier: (GPL-2.0+ OR CC-BY-4.0)
.. .. See the bottom of this file for additional redistribution information.
If you want to distribute this text under CC-BY-4.0 only, please use 'The
Linux kernel developers' for author attribution and link this as source:
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/Documentation/admin-guide/reporting-issues.rst
..
Note: Only the content of this RST file as found in the Linux kernel sources
is available under CC-BY-4.0, as versions of this text that were processed
(for example by the kernel's build system) might contain content taken from
files which use a more restrictive license.
Reporting issues Reporting issues
++++++++++++++++ ++++++++++++++++
...@@ -395,22 +386,16 @@ fixed as soon as possible, hence there are 'issues of high priority' that get ...@@ -395,22 +386,16 @@ fixed as soon as possible, hence there are 'issues of high priority' that get
handled slightly differently in the reporting process. Three type of cases handled slightly differently in the reporting process. Three type of cases
qualify: regressions, security issues, and really severe problems. qualify: regressions, security issues, and really severe problems.
You deal with a 'regression' if something that worked with an older version of You deal with a regression if some application or practical use case running
the Linux kernel does not work with a newer one or somehow works worse with it. fine with one Linux kernel works worse or not at all with a newer version
It thus is a regression when a WiFi driver that did a fine job with Linux 5.7 compiled using a similar configuration. The document
somehow misbehaves with 5.8 or doesn't work at all. It's also a regression if Documentation/admin-guide/reporting-regressions.rst explains this in more
an application shows erratic behavior with a newer kernel, which might happen detail. It also provides a good deal of other information about regressions you
due to incompatible changes in the interface between the kernel and the might want to be aware of; it for example explains how to add your issue to the
userland (like procfs and sysfs). Significantly reduced performance or list of tracked regressions, to ensure it won't fall through the cracks.
increased power consumption also qualify as regression. But keep in mind: the
new kernel needs to be built with a configuration that is similar to the one
from the old kernel (see below how to achieve that). That's because the kernel
developers sometimes can not avoid incompatibilities when implementing new
features; but to avoid regressions such features have to be enabled explicitly
during build time configuration.
What qualifies as security issue is left to your judgment. Consider reading What qualifies as security issue is left to your judgment. Consider reading
'Documentation/admin-guide/security-bugs.rst' before proceeding, as it Documentation/admin-guide/security-bugs.rst before proceeding, as it
provides additional details how to best handle security issues. provides additional details how to best handle security issues.
An issue is a 'really severe problem' when something totally unacceptably bad An issue is a 'really severe problem' when something totally unacceptably bad
...@@ -517,7 +502,7 @@ line starting with 'CPU:'. It should end with 'Not tainted' if the kernel was ...@@ -517,7 +502,7 @@ line starting with 'CPU:'. It should end with 'Not tainted' if the kernel was
not tainted when it noticed the problem; it was tainted if you see 'Tainted:' not tainted when it noticed the problem; it was tainted if you see 'Tainted:'
followed by a few spaces and some letters. followed by a few spaces and some letters.
If your kernel is tainted, study 'Documentation/admin-guide/tainted-kernels.rst' If your kernel is tainted, study Documentation/admin-guide/tainted-kernels.rst
to find out why. Try to eliminate the reason. Often it's caused by one these to find out why. Try to eliminate the reason. Often it's caused by one these
three things: three things:
...@@ -1043,7 +1028,7 @@ down the culprit, as maintainers often won't have the time or setup at hand to ...@@ -1043,7 +1028,7 @@ down the culprit, as maintainers often won't have the time or setup at hand to
reproduce it themselves. reproduce it themselves.
To find the change there is a process called 'bisection' which the document To find the change there is a process called 'bisection' which the document
'Documentation/admin-guide/bug-bisect.rst' describes in detail. That process Documentation/admin-guide/bug-bisect.rst describes in detail. That process
will often require you to build about ten to twenty kernel images, trying to will often require you to build about ten to twenty kernel images, trying to
reproduce the issue with each of them before building the next. Yes, that takes reproduce the issue with each of them before building the next. Yes, that takes
some time, but don't worry, it works a lot quicker than most people assume. some time, but don't worry, it works a lot quicker than most people assume.
...@@ -1073,10 +1058,11 @@ When dealing with regressions make sure the issue you face is really caused by ...@@ -1073,10 +1058,11 @@ When dealing with regressions make sure the issue you face is really caused by
the kernel and not by something else, as outlined above already. the kernel and not by something else, as outlined above already.
In the whole process keep in mind: an issue only qualifies as regression if the In the whole process keep in mind: an issue only qualifies as regression if the
older and the newer kernel got built with a similar configuration. The best way older and the newer kernel got built with a similar configuration. This can be
to archive this: copy the configuration file (``.config``) from the old working achieved by using ``make olddefconfig``, as explained in more detail by
kernel freshly to each newer kernel version you try. Afterwards run ``make Documentation/admin-guide/reporting-regressions.rst; that document also
olddefconfig`` to adjust it for the needs of the new version. provides a good deal of other information about regressions you might want to be
aware of.
Write and send the report Write and send the report
...@@ -1283,7 +1269,7 @@ them when sending the report by mail. If you filed it in a bug tracker, forward ...@@ -1283,7 +1269,7 @@ them when sending the report by mail. If you filed it in a bug tracker, forward
the report's text to these addresses; but on top of it put a small note where the report's text to these addresses; but on top of it put a small note where
you mention that you filed it with a link to the ticket. you mention that you filed it with a link to the ticket.
See 'Documentation/admin-guide/security-bugs.rst' for more information. See Documentation/admin-guide/security-bugs.rst for more information.
Duties after the report went out Duties after the report went out
...@@ -1571,7 +1557,7 @@ Once your report is out your might get asked to do a proper one, as it allows to ...@@ -1571,7 +1557,7 @@ Once your report is out your might get asked to do a proper one, as it allows to
pinpoint the exact change that causes the issue (which then can easily get pinpoint the exact change that causes the issue (which then can easily get
reverted to fix the issue quickly). Hence consider to do a proper bisection reverted to fix the issue quickly). Hence consider to do a proper bisection
right away if time permits. See the section 'Special care for regressions' and right away if time permits. See the section 'Special care for regressions' and
the document 'Documentation/admin-guide/bug-bisect.rst' for details how to the document Documentation/admin-guide/bug-bisect.rst for details how to
perform one. In case of a successful bisection add the author of the culprit to perform one. In case of a successful bisection add the author of the culprit to
the recipients; also CC everyone in the signed-off-by chain, which you find at the recipients; also CC everyone in the signed-off-by chain, which you find at
the end of its commit message. the end of its commit message.
...@@ -1594,7 +1580,7 @@ Some fixes are too complex ...@@ -1594,7 +1580,7 @@ Some fixes are too complex
Even small and seemingly obvious code-changes sometimes introduce new and Even small and seemingly obvious code-changes sometimes introduce new and
totally unexpected problems. The maintainers of the stable and longterm kernels 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 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'. within rules outlined in Documentation/process/stable-kernel-rules.rst.
Complex or risky changes for example do not qualify and thus only get applied 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 to mainline. Other fixes are easy to get backported to the newest stable and
...@@ -1756,10 +1742,23 @@ art will lay some groundwork to improve the situation over time. ...@@ -1756,10 +1742,23 @@ art will lay some groundwork to improve the situation over time.
.. ..
This text is maintained by Thorsten Leemhuis <linux@leemhuis.info>. If you end-of-content
spot a typo or small mistake, feel free to let him know directly and he'll ..
fix it. You are free to do the same in a mostly informal way if you want This document is maintained by Thorsten Leemhuis <linux@leemhuis.info>. If
to contribute changes to the text, but for copyright reasons please CC you spot a typo or small mistake, feel free to let him know directly and
he'll fix it. You are free to do the same in a mostly informal way if you
want to contribute changes to the text, but for copyright reasons please CC
linux-doc@vger.kernel.org and "sign-off" your contribution as linux-doc@vger.kernel.org and "sign-off" your contribution as
Documentation/process/submitting-patches.rst outlines in the section "Sign Documentation/process/submitting-patches.rst outlines in the section "Sign
your work - the Developer's Certificate of Origin". your work - the Developer's Certificate of Origin".
..
This text is available under GPL-2.0+ or CC-BY-4.0, as stated at the top
of the file. If you want to distribute this text under CC-BY-4.0 only,
please use "The Linux kernel developers" for author attribution and link
this as source:
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/Documentation/admin-guide/reporting-issues.rst
..
Note: Only the content of this RST file as found in the Linux kernel sources
is available under CC-BY-4.0, as versions of this text that were processed
(for example by the kernel's build system) might contain content taken from
files which use a more restrictive license.
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