Skip to content

Commit 0043f0b

Browse files
knurdJonathan Corbet
authored andcommitted
docs: reporting-issues.rst: CC subsystem and maintainers on regressions
When reporting a regression, users ideally should CC the subsystem and its maintainers, as that will ensure they get aware of the regression quickly. And if the culprit is known, they should also CC everyone who signed if off; the text mentioned the latter in once place already, but forgot to do so in two other areas where it's relevant. While fixing this also remind readers to check the mailing list archives for issues that need to be reported to a bug tracker, as someone might have reported it by mail only. All of this got triggered by a recent report where these changes would have made a difference. Signed-off-by: Thorsten Leemhuis <[email protected]> Link: https://lore.kernel.org/lkml/[email protected]/ Link: https://lore.kernel.org/lkml/CAJZ5v0hX2StQVttAciHYH-urUH+Hi92z9z2ZbcNgQPt0E2Jpwg@mail.gmail.com/ Link: https://lore.kernel.org/r/dd13f10c30e79e550215e53a8103406daec4e593.1618482489.git.linux@leemhuis.info Signed-off-by: Jonathan Corbet <[email protected]>
1 parent 2fa4928 commit 0043f0b

File tree

1 file changed

+30
-19
lines changed

1 file changed

+30
-19
lines changed

Documentation/admin-guide/reporting-issues.rst

Lines changed: 30 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ longterm series? One still supported? Then search the `LKML
2424
you don't find any, install `the latest release from that series
2525
<https://kernel.org/>`_. If it still shows the issue, report it to the stable
2626
mailing list ([email protected]) and CC the regressions list
27-
27+
([email protected]); ideally also CC the maintainer and the mailing
28+
list for the subsystem in question.
2829

2930
In all other cases try your best guess which kernel part might be causing the
3031
issue. Check the :ref:`MAINTAINERS <maintainers>` file for how its developers
@@ -48,8 +49,9 @@ before the issue occurs.
4849
If you are facing multiple issues with the Linux kernel at once, report each
4950
separately. While writing your report, include all information relevant to the
5051
issue, like the kernel and the distro used. In case of a regression, CC the
51-
regressions mailing list ([email protected]) to your report; also try
52-
to include the commit-id of the change causing it, which a bisection can find.
52+
regressions mailing list ([email protected]) to your report. Also try
53+
to pin-point the culprit with a bisection; if you succeed, include its
54+
commit-id and CC everyone in the sign-off-by chain.
5355

5456
Once the report is out, answer any questions that come up and help where you
5557
can. That includes keeping the ball rolling by occasionally retesting with newer
@@ -198,10 +200,11 @@ report them:
198200

199201
* Send a short problem report to the Linux stable mailing list
200202
([email protected]) and CC the Linux regressions mailing list
201-
([email protected]). Roughly describe the issue and ideally
202-
explain how to reproduce it. Mention the first version that shows the
203-
problem and the last version that's working fine. Then wait for further
204-
instructions.
203+
([email protected]); if you suspect the cause in a particular
204+
subsystem, CC its maintainer and its mailing list. Roughly describe the
205+
issue and ideally explain how to reproduce it. Mention the first version
206+
that shows the problem and the last version that's working fine. Then
207+
wait for further instructions.
205208

206209
The reference section below explains each of these steps in more detail.
207210

@@ -768,7 +771,9 @@ regular internet search engine and add something like
768771
the results to the archives at that URL.
769772

770773
It's also wise to check the internet, LKML and maybe bugzilla.kernel.org again
771-
at this point.
774+
at this point. If your report needs to be filed in a bug tracker, you may want
775+
to check the mailing list archives for the subsystem as well, as someone might
776+
have reported it only there.
772777

773778
For details how to search and what to do if you find matching reports see
774779
"Search for existing reports, first run" above.
@@ -1249,9 +1254,10 @@ and the oldest where the issue occurs (say 5.8-rc1).
12491254

12501255
When sending the report by mail, CC the Linux regressions mailing list
12511256
([email protected]). In case the report needs to be filed to some web
1252-
tracker, proceed to do so; once filed, forward the report by mail to the
1253-
regressions list. Make sure to inline the forwarded report, hence do not attach
1254-
it. Also add a short note at the top where you mention the URL to the ticket.
1257+
tracker, proceed to do so. Once filed, forward the report by mail to the
1258+
regressions list; CC the maintainer and the mailing list for the subsystem in
1259+
question. Make sure to inline the forwarded report, hence do not attach it.
1260+
Also add a short note at the top where you mention the URL to the ticket.
12551261

12561262
When mailing or forwarding the report, in case of a successful bisection add the
12571263
author of the culprit to the recipients; also CC everyone in the signed-off-by
@@ -1536,17 +1542,20 @@ Report the regression
15361542

15371543
*Send a short problem report to the Linux stable mailing list
15381544
([email protected]) and CC the Linux regressions mailing list
1539-
([email protected]). Roughly describe the issue and ideally
1540-
explain how to reproduce it. Mention the first version that shows the
1541-
problem and the last version that's working fine. Then wait for further
1542-
instructions.*
1545+
([email protected]); if you suspect the cause in a particular
1546+
subsystem, CC its maintainer and its mailing list. Roughly describe the
1547+
issue and ideally explain how to reproduce it. Mention the first version
1548+
that shows the problem and the last version that's working fine. Then
1549+
wait for further instructions.*
15431550

15441551
When reporting a regression that happens within a stable or longterm kernel
15451552
line (say when updating from 5.10.4 to 5.10.5) a brief report is enough for
1546-
the start to get the issue reported quickly. Hence a rough description is all
1547-
it takes.
1553+
the start to get the issue reported quickly. Hence a rough description to the
1554+
stable and regressions mailing list is all it takes; but in case you suspect
1555+
the cause in a particular subsystem, CC its maintainers and its mailing list
1556+
as well, because that will speed things up.
15481557

1549-
But note, it helps developers a great deal if you can specify the exact version
1558+
And note, it helps developers a great deal if you can specify the exact version
15501559
that introduced the problem. Hence if possible within a reasonable time frame,
15511560
try to find that version using vanilla kernels. Lets assume something broke when
15521561
your distributor released a update from Linux kernel 5.10.5 to 5.10.8. Then as
@@ -1563,7 +1572,9 @@ pinpoint the exact change that causes the issue (which then can easily get
15631572
reverted to fix the issue quickly). Hence consider to do a proper bisection
15641573
right away if time permits. See the section 'Special care for regressions' and
15651574
the document 'Documentation/admin-guide/bug-bisect.rst' for details how to
1566-
perform one.
1575+
perform one. In case of a successful bisection add the author of the culprit to
1576+
the recipients; also CC everyone in the signed-off-by chain, which you find at
1577+
the end of its commit message.
15671578

15681579

15691580
Reference for "Reporting issues only occurring in older kernel version lines"

0 commit comments

Comments
 (0)