* [PATCH docs-next v2] docs: handling-regressions.rst: recommend using "Closes:" tags
@ 2024-05-10 18:34 Karel Balej
2024-05-12 7:47 ` Thorsten Leemhuis
0 siblings, 1 reply; 4+ messages in thread
From: Karel Balej @ 2024-05-10 18:34 UTC (permalink / raw
To: Thorsten Leemhuis, Jonathan Corbet, regressions, workflows,
linux-doc, linux-kernel
Cc: balejk
Update the handling-regressions guide to recommend using "Closes:" tags
rather than "Link:" when referencing fixed reports. The latter was used
originally but now is only recommended when the given patch only fixes
part of the issue, as described in submitting-patches. Briefly mention
that and also note that regzbot currently doesn't make a distinction.
Also fix a typo.
Signed-off-by: Karel Balej <balejk@matfyz.cz>
---
Notes:
v2:
- v1: https://lore.kernel.org/r/20240328194342.11760-1-balejk@matfyz.cz/
- Rebase to git://git.lwn.net/linux.git docs-next.
- Prefer Closes: tags, mention that regzbot makes no distinction and
only mention Link: briefly and explain when it's preferred, in
accordance with submitting-patches.
- Include a typo fix.
- Reword commit message accordingly (and make it less verbose :-).
.../process/handling-regressions.rst | 32 ++++++++++++-------
1 file changed, 20 insertions(+), 12 deletions(-)
diff --git a/Documentation/process/handling-regressions.rst b/Documentation/process/handling-regressions.rst
index 49ba1410cfce..c162748f5ec9 100644
--- a/Documentation/process/handling-regressions.rst
+++ b/Documentation/process/handling-regressions.rst
@@ -40,10 +40,13 @@ The important bits (aka "The TL;DR")
#regzbot from: Some N. Ice Human <some.human@example.com>
#regzbot monitor: http://some.bugtracker.example.com/ticket?id=123456789
-#. When submitting fixes for regressions, add "Link:" tags to the patch
+#. When submitting fixes for regressions, add "Closes:" tags to the patch
description pointing to all places where the issue was reported, as
mandated by Documentation/process/submitting-patches.rst and
- :ref:`Documentation/process/5.Posting.rst <development_posting>`.
+ :ref:`Documentation/process/5.Posting.rst <development_posting>`. If you are
+ only fixing part of the issue that caused the regression, you may use
+ "Link:" tags instead. regzbot currently makes no distinction between the
+ two.
#. Try to fix regressions quickly once the culprit has been identified; fixes
for most regressions should be merged within two weeks, but some need to be
@@ -91,10 +94,10 @@ When doing either, consider making the Linux kernel regression tracking bot
Note the caret (^) before the "introduced": it tells regzbot to treat the
parent mail (the one you reply to) as the initial report for the regression
you want to see tracked; that's important, as regzbot will later look out
- for patches with "Link:" tags pointing to the report in the archives on
+ for patches with "Closes:" tags pointing to the report in the archives on
lore.kernel.org.
- * When forwarding a regressions reported to a bug tracker, include a paragraph
+ * When forwarding a regression reported to a bug tracker, include a paragraph
with these regzbot commands::
#regzbot introduced: 1f2e3d4c5b6a
@@ -102,7 +105,7 @@ When doing either, consider making the Linux kernel regression tracking bot
#regzbot monitor: http://some.bugtracker.example.com/ticket?id=123456789
Regzbot will then automatically associate patches with the report that
- contain "Link:" tags pointing to your mail or the mentioned ticket.
+ contain "Closes:" tags pointing to your mail or the mentioned ticket.
What's important when fixing regressions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -112,10 +115,16 @@ remember to do what Documentation/process/submitting-patches.rst,
:ref:`Documentation/process/5.Posting.rst <development_posting>`, and
Documentation/process/stable-kernel-rules.rst already explain in more detail:
- * Point to all places where the issue was reported using "Link:" tags::
+ * Point to all places where the issue was reported using "Closes:" tags::
- Link: https://lore.kernel.org/r/30th.anniversary.repost@klaava.Helsinki.FI/
- Link: https://bugzilla.kernel.org/show_bug.cgi?id=1234567890
+ Closes: https://lore.kernel.org/r/30th.anniversary.repost@klaava.Helsinki.FI/
+ Closes: https://bugzilla.kernel.org/show_bug.cgi?id=1234567890
+
+ If you are only fixing part of the issue, you may use "Link:" instead as
+ described in the first document mentioned above. Some maintainers may even
+ prefer it over "Closes:" entirely, although the latter is generally
+ recommended. regzbot currently treats both of these equivalently and
+ considers the linked reports as resolved.
* Add a "Fixes:" tag to specify the commit causing the regression.
@@ -126,7 +135,7 @@ All this is expected from you and important when it comes to regression, as
these tags are of great value for everyone (you included) that might be looking
into the issue weeks, months, or years later. These tags are also crucial for
tools and scripts used by other kernel developers or Linux distributions; one of
-these tools is regzbot, which heavily relies on the "Link:" tags to associate
+these tools is regzbot, which heavily relies on the "Closes:" tags to associate
reports for regression with changes resolving them.
Expectations and best practices for fixing regressions
@@ -326,7 +335,7 @@ How does regression tracking work with regzbot?
The bot watches for replies to reports of tracked regressions. Additionally,
it's looking out for posted or committed patches referencing such reports
-with "Link:" tags; replies to such patch postings are tracked as well.
+with "Closes:" tags; replies to such patch postings are tracked as well.
Combined this data provides good insights into the current state of the fixing
process.
@@ -338,8 +347,7 @@ take care of that using ``#regzbot ^introduced``.
For developers there normally is no extra work involved, they just need to make
sure to do something that was expected long before regzbot came to light: add
-"Link:" tags to the patch description pointing to all reports about the issue
-fixed.
+links to the patch description pointing to all reports about the issue fixed.
Do I have to use regzbot?
~~~~~~~~~~~~~~~~~~~~~~~~~
--
2.45.0
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH docs-next v2] docs: handling-regressions.rst: recommend using "Closes:" tags
2024-05-10 18:34 [PATCH docs-next v2] docs: handling-regressions.rst: recommend using "Closes:" tags Karel Balej
@ 2024-05-12 7:47 ` Thorsten Leemhuis
2024-05-12 8:48 ` Karel Balej
0 siblings, 1 reply; 4+ messages in thread
From: Thorsten Leemhuis @ 2024-05-12 7:47 UTC (permalink / raw
To: Karel Balej, Jonathan Corbet, regressions, workflows, linux-doc,
linux-kernel
On 10.05.24 20:34, Karel Balej wrote:
> Update the handling-regressions guide to recommend using "Closes:" tags
> rather than "Link:" when referencing fixed reports. The latter was used
> originally but now is only recommended when the given patch only fixes
> part of the issue, as described in submitting-patches. Briefly mention
> that and also note that regzbot currently doesn't make a distinction.
>
> Also fix a typo.
>
> Signed-off-by: Karel Balej <balejk@matfyz.cz>
Many thx for this, much appreciated. Looks good!
Acked-by: Thorsten Leemhuis <linux@leemhuis.info>
One quick note:
>
> What's important when fixing regressions
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> @@ -112,10 +115,16 @@ remember to do what Documentation/process/submitting-patches.rst,
> :ref:`Documentation/process/5.Posting.rst <development_posting>`, and
> Documentation/process/stable-kernel-rules.rst already explain in more detail:
>
> - * Point to all places where the issue was reported using "Link:" tags::
> + * Point to all places where the issue was reported using "Closes:" tags::
>
> - Link: https://lore.kernel.org/r/30th.anniversary.repost@klaava.Helsinki.FI/
> - Link: https://bugzilla.kernel.org/show_bug.cgi?id=1234567890
> + Closes: https://lore.kernel.org/r/30th.anniversary.repost@klaava.Helsinki.FI/
> + Closes: https://bugzilla.kernel.org/show_bug.cgi?id=1234567890
> +
> + If you are only fixing part of the issue, you may use "Link:" instead as
> + described in the first document mentioned above.
Not totally sure if...
> Some maintainers may even
> + prefer it over "Closes:" entirely, although the latter is generally
> + recommended.
...this sentence really should be here, but whatever.
> regzbot currently treats both of these equivalently and
> + considers the linked reports as resolved.
>
Thx again! Ciao, Thorsten
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH docs-next v2] docs: handling-regressions.rst: recommend using "Closes:" tags
2024-05-12 7:47 ` Thorsten Leemhuis
@ 2024-05-12 8:48 ` Karel Balej
2024-05-13 6:49 ` Thorsten Leemhuis
0 siblings, 1 reply; 4+ messages in thread
From: Karel Balej @ 2024-05-12 8:48 UTC (permalink / raw
To: Thorsten Leemhuis, Jonathan Corbet, regressions, workflows,
linux-doc, linux-kernel
Thorsten Leemhuis, 2024-05-12T09:47:31+02:00:
> On 10.05.24 20:34, Karel Balej wrote:
> > Update the handling-regressions guide to recommend using "Closes:" tags
> > rather than "Link:" when referencing fixed reports. The latter was used
> > originally but now is only recommended when the given patch only fixes
> > part of the issue, as described in submitting-patches. Briefly mention
> > that and also note that regzbot currently doesn't make a distinction.
> >
> > Also fix a typo.
> >
> > Signed-off-by: Karel Balej <balejk@matfyz.cz>
>
> Many thx for this, much appreciated. Looks good!
>
> Acked-by: Thorsten Leemhuis <linux@leemhuis.info>
Thanks!
> One quick note:
>
> >
> > What's important when fixing regressions
> > ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> > @@ -112,10 +115,16 @@ remember to do what Documentation/process/submitting-patches.rst,
> > :ref:`Documentation/process/5.Posting.rst <development_posting>`, and
> > Documentation/process/stable-kernel-rules.rst already explain in more detail:
> >
> > - * Point to all places where the issue was reported using "Link:" tags::
> > + * Point to all places where the issue was reported using "Closes:" tags::
> >
> > - Link: https://lore.kernel.org/r/30th.anniversary.repost@klaava.Helsinki.FI/
> > - Link: https://bugzilla.kernel.org/show_bug.cgi?id=1234567890
> > + Closes: https://lore.kernel.org/r/30th.anniversary.repost@klaava.Helsinki.FI/
> > + Closes: https://bugzilla.kernel.org/show_bug.cgi?id=1234567890
> > +
> > + If you are only fixing part of the issue, you may use "Link:" instead as
> > + described in the first document mentioned above.
>
> Not totally sure if...
>
> > Some maintainers may even
> > + prefer it over "Closes:" entirely, although the latter is generally
> > + recommended.
>
> ...this sentence really should be here, but whatever.
I think I can see your point. I added it as it was something you
mentioned before but looking now at that mail again, I think this is not
really what you said. So I'm in favour of dropping it.
If you give me a go-ahead, I will send v3 with this sentence dropped and
your Ack added right back.
Thanks, kind regards,
K. B.
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH docs-next v2] docs: handling-regressions.rst: recommend using "Closes:" tags
2024-05-12 8:48 ` Karel Balej
@ 2024-05-13 6:49 ` Thorsten Leemhuis
0 siblings, 0 replies; 4+ messages in thread
From: Thorsten Leemhuis @ 2024-05-13 6:49 UTC (permalink / raw
To: Karel Balej, Jonathan Corbet, regressions, workflows, linux-doc,
linux-kernel
On 12.05.24 10:48, Karel Balej wrote:
> Thorsten Leemhuis, 2024-05-12T09:47:31+02:00:
>> On 10.05.24 20:34, Karel Balej wrote:
>> Not totally sure if...
>>
>>> Some maintainers may even
>>> + prefer it over "Closes:" entirely, although the latter is generally
>>> + recommended.
>>
>> ...this sentence really should be here, but whatever.
>
> I think I can see your point. I added it as it was something you
> mentioned before but looking now at that mail again, I think this is not
> really what you said. So I'm in favour of dropping it.
>
> If you give me a go-ahead, I will send v3 with this sentence dropped and
> your Ack added right back.
Yeah, do that please. Thx again! Ciao, Thorsten
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2024-05-13 6:49 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-05-10 18:34 [PATCH docs-next v2] docs: handling-regressions.rst: recommend using "Closes:" tags Karel Balej
2024-05-12 7:47 ` Thorsten Leemhuis
2024-05-12 8:48 ` Karel Balej
2024-05-13 6:49 ` Thorsten Leemhuis
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).