Skip to content

Commit 9e66f74

Browse files
balejkJonathan Corbet
authored andcommitted
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
1 parent 1e596d5 commit 9e66f74

2 files changed

Lines changed: 6 additions & 6 deletions

File tree

Documentation/admin-guide/reporting-regressions.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,12 @@ The important basics
4242
--------------------
4343

4444

45-
What is a "regression" and what is the "no regressions rule"?
45+
What is a "regression" and what is the "no regressions" rule?
4646
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4747

4848
It's a regression if some application or practical use case running fine with
4949
one Linux kernel works worse or not at all with a newer version compiled using a
50-
similar configuration. The "no regressions rule" forbids this to take place; if
50+
similar configuration. The "no regressions" rule forbids this to take place; if
5151
it happens by accident, developers that caused it are expected to quickly fix
5252
the issue.
5353

@@ -173,7 +173,7 @@ Additional details about regressions
173173
------------------------------------
174174

175175

176-
What is the goal of the "no regressions rule"?
176+
What is the goal of the "no regressions" rule?
177177
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
178178

179179
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
199199
turned out to be wrong when they assumed a particular situation was warranting
200200
an exception.
201201

202-
Who ensures the "no regressions" is actually followed?
203-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
202+
Who ensures the "no regressions" rule is actually followed?
203+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
204204

205205
The subsystem maintainers should take care of that, which are watched and
206206
supported by the tree maintainers -- e.g. Linus Torvalds for mainline and

Documentation/process/handling-regressions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@ What else is there to known about regressions?
284284
Check out Documentation/admin-guide/reporting-regressions.rst, it covers a lot
285285
of other aspects you want might want to be aware of:
286286

287-
* the purpose of the "no regressions rule"
287+
* the purpose of the "no regressions" rule
288288

289289
* what issues actually qualify as regression
290290

0 commit comments

Comments
 (0)