sphinx.addnodesdocument)}( rawsource children](translations
LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}(hhparenthuba
attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget5/translations/zh_CN/admin-guide/reporting-regressionsmodnameN classnameNrefexplicitutagnamehhhubh)}(hhh]hChinese (Traditional)}(hhhh2ubah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget5/translations/zh_TW/admin-guide/reporting-regressionsmodnameN classnameNrefexplicituh1hhhubh)}(hhh]hItalian}(hhhhFubah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget5/translations/it_IT/admin-guide/reporting-regressionsmodnameN classnameNrefexplicituh1hhhubh)}(hhh]hJapanese}(hhhhZubah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget5/translations/ja_JP/admin-guide/reporting-regressionsmodnameN classnameNrefexplicituh1hhhubh)}(hhh]hKorean}(hhhhnubah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget5/translations/ko_KR/admin-guide/reporting-regressionsmodnameN classnameNrefexplicituh1hhhubh)}(hhh]hSpanish}(hhhhubah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget5/translations/sp_SP/admin-guide/reporting-regressionsmodnameN classnameNrefexplicituh1hhhubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h
hh _documenthsourceNlineNubhcomment)}(h0SPDX-License-Identifier: (GPL-2.0+ OR CC-BY-4.0)h]h0SPDX-License-Identifier: (GPL-2.0+ OR CC-BY-4.0)}(hhhhubah}(h]h ]h"]h$]h&] xml:spacepreserveuh1hhhhhhO/var/lib/git/docbuild/linux/Documentation/admin-guide/reporting-regressions.rsthKubh)}(h<[see the bottom of this file for redistribution information]h]h<[see the bottom of this file for redistribution information]}(hhhhubah}(h]h ]h"]h$]h&]hhuh1hhhhhhhhKubhsection)}(hhh](htitle)}(hReporting regressionsh]hReporting regressions}(hhhhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh paragraph)}(h"*We don't cause regressions*" is the first rule of Linux kernel development;
Linux founder and lead developer Linus Torvalds established it himself and
ensures it's obeyed.h](h“}(h"hhhhhNhNubhemphasis)}(h*We don't cause regressions*h]hWe don’t cause regressions}(hhhhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhubh” is the first rule of Linux kernel development;
Linux founder and lead developer Linus Torvalds established it himself and
ensures it’s obeyed.}(h" is the first rule of Linux kernel development;
Linux founder and lead developer Linus Torvalds established it himself and
ensures it's obeyed.hhhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hThis document describes what the rule means for users and how the Linux kernel's
development model ensures to address all reported regressions; aspects relevant
for kernel developers are left to Documentation/process/handling-regressions.rst.h]hThis document describes what the rule means for users and how the Linux kernel’s
development model ensures to address all reported regressions; aspects relevant
for kernel developers are left to Documentation/process/handling-regressions.rst.}(hhhhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hhh](h)}(h The important bits (aka "TL;DR")h]h$The important bits (aka “TL;DR”)}(hj hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hhhhhKubhenumerated_list)}(hhh](h list_item)}(hX It's a regression if something running fine with one Linux kernel works worse
or not at all with a newer version. Note, the newer kernel has to be compiled
using a similar configuration; the detailed explanations below describes this
and other fine print in more detail.
h]h)}(hX It's a regression if something running fine with one Linux kernel works worse
or not at all with a newer version. Note, the newer kernel has to be compiled
using a similar configuration; the detailed explanations below describes this
and other fine print in more detail.h]hX It’s a regression if something running fine with one Linux kernel works worse
or not at all with a newer version. Note, the newer kernel has to be compiled
using a similar configuration; the detailed explanations below describes this
and other fine print in more detail.}(hj) hj' hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj# ubah}(h]h ]h"]h$]h&]uh1j! hj hhhhhNubj" )}(hXu Report your issue as outlined in Documentation/admin-guide/reporting-issues.rst,
it already covers all aspects important for regressions and repeated
below for convenience. Two of them are important: start your report's subject
with "[REGRESSION]" and CC or forward it to `the regression mailing list
`_ (regressions@lists.linux.dev).
h]h)}(hXt Report your issue as outlined in Documentation/admin-guide/reporting-issues.rst,
it already covers all aspects important for regressions and repeated
below for convenience. Two of them are important: start your report's subject
with "[REGRESSION]" and CC or forward it to `the regression mailing list
`_ (regressions@lists.linux.dev).h](hX Report your issue as outlined in Documentation/admin-guide/reporting-issues.rst,
it already covers all aspects important for regressions and repeated
below for convenience. Two of them are important: start your report’s subject
with “[REGRESSION]” and CC or forward it to }(hX Report your issue as outlined in Documentation/admin-guide/reporting-issues.rst,
it already covers all aspects important for regressions and repeated
below for convenience. Two of them are important: start your report's subject
with "[REGRESSION]" and CC or forward it to hj? hhhNhNubh reference)}(hE`the regression mailing list
`_h]hthe regression mailing list}(hthe regression mailing listhjJ hhhNhNubah}(h]h ]h"]h$]h&]namethe regression mailing listrefuri$https://lore.kernel.org/regressions/uh1jH hj? ubhtarget)}(h'
h]h}(h]the-regression-mailing-listah ]h"]the regression mailing listah$]h&]refurij\ uh1j]
referencedKhj? ubh (}(h (hj? hhhNhNubjI )}(hregressions@lists.linux.devh]hregressions@lists.linux.dev}(hhhjr hhhNhNubah}(h]h ]h"]h$]h&]refuri"mailto:regressions@lists.linux.devuh1jH hj? ubh).}(h).hj? hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj; ubah}(h]h ]h"]h$]h&]uh1j! hj hhhhhNubj" )}(hOptional, but recommended: when sending or forwarding your report, make the
Linux kernel regression tracking bot "regzbot" track the issue by specifying
when the regression started like this::
#regzbot introduced: v5.13..v5.14-rc1
h](h)}(hOptional, but recommended: when sending or forwarding your report, make the
Linux kernel regression tracking bot "regzbot" track the issue by specifying
when the regression started like this::h]hOptional, but recommended: when sending or forwarding your report, make the
Linux kernel regression tracking bot “regzbot” track the issue by specifying
when the regression started like this:}(hOptional, but recommended: when sending or forwarding your report, make the
Linux kernel regression tracking bot "regzbot" track the issue by specifying
when the regression started like this:hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubh
literal_block)}(h%#regzbot introduced: v5.13..v5.14-rc1h]h%#regzbot introduced: v5.13..v5.14-rc1}(hhhj ubah}(h]h ]h"]h$]h&]hhuh1j hhhK"hj ubeh}(h]h ]h"]h$]h&]uh1j! hj hhhhhNubeh}(h]h ]h"]h$]h&]enumtypearabicprefixhsuffix.uh1j hj hhhhhKubeh}(h]the-important-bits-aka-tl-drah ]h"] the important bits (aka "tl;dr")ah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h>All the details on Linux kernel regressions relevant for usersh]h>All the details on Linux kernel regressions relevant for users}(hj hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hhhhhK&ubh)}(hhh](h)}(hThe important basicsh]hThe important basics}(hj hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hhhhhK*ubh)}(hhh](h)}(h=What is a "regression" and what is the "no regressions" rule?h]hEWhat is a “regression” and what is the “no regressions” rule?}(hj hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hhhhhK.ubh)}(hXG It's a regression if some application or practical use case running fine with
one Linux kernel works worse or not at all with a newer version compiled using a
similar configuration. The "no regressions" rule forbids this to take place; if
it happens by accident, developers that caused it are expected to quickly fix
the issue.h]hXM It’s a regression if some application or practical use case running fine with
one Linux kernel works worse or not at all with a newer version compiled using a
similar configuration. The “no regressions” rule forbids this to take place; if
it happens by accident, developers that caused it are expected to quickly fix
the issue.}(hj hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK0hj hhubh)}(hXj It thus is a regression when a WiFi driver from Linux 5.13 works fine, but with
5.14 doesn't work at all, works significantly slower, or misbehaves somehow.
It's also a regression if a perfectly working application suddenly shows erratic
behavior with a newer kernel version; such issues can be caused by changes in
procfs, sysfs, or one of the many other interfaces Linux provides to userland
software. But keep in mind, as mentioned earlier: 5.14 in this example needs to
be built from a configuration similar to the one from 5.13. This can be achieved
using ``make olddefconfig``, as explained in more detail below.h](hX5 It thus is a regression when a WiFi driver from Linux 5.13 works fine, but with
5.14 doesn’t work at all, works significantly slower, or misbehaves somehow.
It’s also a regression if a perfectly working application suddenly shows erratic
behavior with a newer kernel version; such issues can be caused by changes in
procfs, sysfs, or one of the many other interfaces Linux provides to userland
software. But keep in mind, as mentioned earlier: 5.14 in this example needs to
be built from a configuration similar to the one from 5.13. This can be achieved
using }(hX1 It thus is a regression when a WiFi driver from Linux 5.13 works fine, but with
5.14 doesn't work at all, works significantly slower, or misbehaves somehow.
It's also a regression if a perfectly working application suddenly shows erratic
behavior with a newer kernel version; such issues can be caused by changes in
procfs, sysfs, or one of the many other interfaces Linux provides to userland
software. But keep in mind, as mentioned earlier: 5.14 in this example needs to
be built from a configuration similar to the one from 5.13. This can be achieved
using hj hhhNhNubhliteral)}(h``make olddefconfig``h]hmake olddefconfig}(hhhj hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj ubh$, as explained in more detail below.}(h$, as explained in more detail below.hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK6hj hhubh)}(hNote the "practical use case" in the first sentence of this section: developers
despite the "no regressions" rule are free to change any aspect of the kernel
and even APIs or ABIs to userland, as long as no existing application or use
case breaks.h]hNote the “practical use case” in the first sentence of this section: developers
despite the “no regressions” rule are free to change any aspect of the kernel
and even APIs or ABIs to userland, as long as no existing application or use
case breaks.}(hj6 hj4 hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK?hj hhubh)}(hAlso be aware the "no regressions" rule covers only interfaces the kernel
provides to the userland. It thus does not apply to kernel-internal interfaces
like the module API, which some externally developed drivers use to hook into
the kernel.h]hAlso be aware the “no regressions” rule covers only interfaces the kernel
provides to the userland. It thus does not apply to kernel-internal interfaces
like the module API, which some externally developed drivers use to hook into
the kernel.}(hjD hjB hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKDhj hhubeh}(h]8what-is-a-regression-and-what-is-the-no-regressions-ruleah ]h"]=what is a "regression" and what is the "no regressions" rule?ah$]h&]uh1hhj hhhhhK.ubh)}(hhh](h)}(hHow do I report a regression?h]hHow do I report a regression?}(hj] hj[ hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjX hhhhhKJubh)}(hJust report the issue as outlined in
Documentation/admin-guide/reporting-issues.rst, it already describes the
important points. The following aspects outlined there are especially relevant
for regressions:h]hJust report the issue as outlined in
Documentation/admin-guide/reporting-issues.rst, it already describes the
important points. The following aspects outlined there are especially relevant
for regressions:}(hjk hji hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKLhjX hhubhblock_quote)}(hhh](hbullet_list)}(hhh](j" )}(hWhen checking for existing reports to join, also search the `archives of the
Linux regressions mailing list `_ and
`regzbot's web-interface `_.
h]h)}(hWhen checking for existing reports to join, also search the `archives of the
Linux regressions mailing list `_ and
`regzbot's web-interface `_.h](h