On 10/1/20 1:39 AM, Thorsten Leemhuis wrote: > Explicitly outline that some issues are more important than others and > thus need to be handled differently in some steps that are about to > follow. This makes things explicit and easy to find if you need to look > up what issues actually qualify as "regression" or a "severe problem". > > The alternative would have been: explain each of the three types in the > place where it requires special handling for the first time. But that > makes it quite easy to miss and harder to find when you need to look it > up. > > Signed-off-by: Thorsten Leemhuis <linux@xxxxxxxxxxxxx> > --- > Documentation/admin-guide/reporting-bugs.rst | 39 ++++++++++++++++++++ > 1 file changed, 39 insertions(+) > > diff --git a/Documentation/admin-guide/reporting-bugs.rst b/Documentation/admin-guide/reporting-bugs.rst > index 434e1a890dfe..430a0c3ee0ad 100644 > --- a/Documentation/admin-guide/reporting-bugs.rst > +++ b/Documentation/admin-guide/reporting-bugs.rst > @@ -272,6 +272,45 @@ you want to circumvent it consider installing the mainline kernel yourself; just > make sure it's the latest one (see below). > > > +Issue of high priority? > +----------------------- > + > + *See if the issue you are dealing with qualifies as regression, security > + issue, or a really severe problem: those are 'issues of high priority' that > + need special handling in some steps that are about to follow.* > + > +Linus Torvalds and the leading Linux kernel developers want to see some issues > +fixed as soon as possible, hence these 'issues of high priority' get handled > +slightly different in the reporting process. Three type of cases qualify: differently at least that's what I would say. :) > +regressions, security issues, and really severe problems. > + > +You deal with a 'regression' if something that worked with an older version of > +the Linux kernel does not work with a newer one or somehow works worse with it. > +It thus is a regression when a Wi-Fi driver that did a fine job with Linux 5.7 > +somehow misbehaves with 5.8 or doesn't work at all. It's also a regression if > +an application shows erratic behavior with a newer kernel, which might happen > +due to incompatible changes in the interface between the kernel and the > +userland (like procfs and sysfs). Significantly reduced performance or > +increased power consumption also qualify as regression. But keep in mind: the > +new kernel needs to be build with a configuration that is similar to the one built > +from the old kernel (see below how to archive that). That's because achieve > +process is sometimes only possible by doing incompatible changes; but to avoid eh? That's because ... ??? > +regression such changes have to be enabled explicitly during build time > +configuration. > + > +What qualifies as security issue is left to your judgment. Consider reading > +:ref:`Documentation/admin-guide/security-bugs.rst <securitybugs>` before > +proceeding. > + > +An issue is a 'really severe problem' when something totally unacceptable bad unacceptably > +happens. That's for example the case when a Linux kernel corrupts the data it's > +handling or damages hardware it's running on. You're also dealing with a severe > +issue when the kernel suddenly stops working with an error message ('kernel > +panic') or without any farewell note at all. Note: do not confused a 'panic' (a confuse > +fatal error where the kernels stop itself) with a 'Oops' (a recoverable error), > +as the kernel remains running after an 'Oops'. > + > + > .. ############################################################################ > .. Temporary marker added while this document is rewritten. Sections above > .. are new and dual-licensed under GPLv2+ and CC-BY 4.0, those below are old. > -- ~Randy Reported-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>