mirror of
https://github.com/torvalds/linux.git
synced 2024-11-24 13:11:40 +00:00
docs: *-regressions.rst: unify quoting, add missing word
Quoting of the '"no regressions" rule' expression differs between occurrences, sometimes being presented as '"no regressions rule"'. Unify the quoting using the first form which seems semantically correct or is at least used dominantly, albeit marginally. One of the occurrences is obviously missing the 'rule' part -- add it. Signed-off-by: Karel Balej <balejk@matfyz.cz> Reviewed-by: Thorsten Leemhuis <linux@leemhuis.info> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20240328194342.11760-2-balejk@matfyz.cz
This commit is contained in:
parent
1e596d5eff
commit
9e66f74ce7
@ -42,12 +42,12 @@ The important basics
|
|||||||
--------------------
|
--------------------
|
||||||
|
|
||||||
|
|
||||||
What is a "regression" and what is the "no regressions rule"?
|
What is a "regression" and what is the "no regressions" rule?
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
It's a regression if some application or practical use case running fine with
|
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
|
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
|
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
|
it happens by accident, developers that caused it are expected to quickly fix
|
||||||
the issue.
|
the issue.
|
||||||
|
|
||||||
@ -173,7 +173,7 @@ Additional details about regressions
|
|||||||
------------------------------------
|
------------------------------------
|
||||||
|
|
||||||
|
|
||||||
What is the goal of the "no regressions rule"?
|
What is the goal of the "no regressions" rule?
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
Users should feel safe when updating kernel versions and not have to worry
|
Users should feel safe when updating kernel versions and not have to worry
|
||||||
@ -199,8 +199,8 @@ Exceptions to this rule are extremely rare; in the past developers almost always
|
|||||||
turned out to be wrong when they assumed a particular situation was warranting
|
turned out to be wrong when they assumed a particular situation was warranting
|
||||||
an exception.
|
an exception.
|
||||||
|
|
||||||
Who ensures the "no regressions" is actually followed?
|
Who ensures the "no regressions" rule is actually followed?
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
The subsystem maintainers should take care of that, which are watched and
|
The subsystem maintainers should take care of that, which are watched and
|
||||||
supported by the tree maintainers -- e.g. Linus Torvalds for mainline and
|
supported by the tree maintainers -- e.g. Linus Torvalds for mainline and
|
||||||
|
@ -284,7 +284,7 @@ What else is there to known about regressions?
|
|||||||
Check out Documentation/admin-guide/reporting-regressions.rst, it covers a lot
|
Check out Documentation/admin-guide/reporting-regressions.rst, it covers a lot
|
||||||
of other aspects you want might want to be aware of:
|
of other aspects you want might want to be aware of:
|
||||||
|
|
||||||
* the purpose of the "no regressions rule"
|
* the purpose of the "no regressions" rule
|
||||||
|
|
||||||
* what issues actually qualify as regression
|
* what issues actually qualify as regression
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user