Message-ID: <20240328194342.11760-3-balejk@matfyz.cz>
Date: Thu, 28 Mar 2024 20:29:16 +0100
From: Karel Balej <balejk@...fyz.cz>
To: Thorsten Leemhuis <linux@...mhuis.info>, Jonathan Corbet <corbet@....net>,
        regressions@...ts.linux.dev, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org, workflows@...r.kernel.org
Cc: balejk@...fyz.cz
Subject: [PATCH 2/2] docs: handling-regressions.rst: clarify that "Closes:" tags work too

The regressions handling manual claims that regzbot associates patches
fixing an issue with the report based on the occurrence of the
appropriate "Link:" trailers. It reasons that this does not add any
burden on the maintainers/bug fix authors as this is already mandated by
the "Submitting patches" guide. In fact however, the guide encourages
using "Link:" tags for related discussions or issues which the patch
fixes only partially, recommending "Closes:" for full resolutions.

Despite it not being mentioned anywhere in the "Handling regressions"
guide, regzbot does in fact take the "Closes:" tags into account and
seems to in fact treat them fully equivalently to "Link:" tags.

Clarify this in the regressions handling guide by always mentioning both
of the tags.

Signed-off-by: Karel Balej <balejk@...fyz.cz>
---
 .../process/handling-regressions.rst          | 30 ++++++++++---------
 1 file changed, 16 insertions(+), 14 deletions(-)

diff --git a/Documentation/process/handling-regressions.rst b/Documentation/process/handling-regressions.rst
index 49ba1410cfce..b9f8c8aa5936 100644
--- a/Documentation/process/handling-regressions.rst
+++ b/Documentation/process/handling-regressions.rst
@@ -40,9 +40,9 @@ The important bits (aka "The TL;DR")
        #regzbot from: Some N. Ice Human <some.human@...mple.com>
        #regzbot monitor: http://some.bugtracker.example.com/ticket?id=123456789
 
-#. When submitting fixes for regressions, add "Link:" tags to the patch
-   description pointing to all places where the issue was reported, as
-   mandated by Documentation/process/submitting-patches.rst and
+#. When submitting fixes for regressions, add "Closes:" (or "Link:") 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>`.
 
 #. Try to fix regressions quickly once the culprit has been identified; fixes
@@ -91,8 +91,8 @@ 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
-   lore.kernel.org.
+   for patches with "Closes:" or "Link:" tags pointing to the report in the
+   archives on lore.kernel.org.
 
  * When forwarding a regressions reported to a bug tracker, include a paragraph
    with these regzbot commands::
@@ -102,7 +102,8 @@ 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:" or "Link:" tags pointing to your mail or the mentioned
+   ticket.
 
 What's important when fixing regressions
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -112,7 +113,8 @@ 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:" or "Link:"
+   tags::
 
        Link: https://lore.kernel.org/r/30th.anniversary.repost@klaava.Helsinki.FI/
        Link: https://bugzilla.kernel.org/show_bug.cgi?id=1234567890
@@ -126,8 +128,8 @@ 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
-reports for regression with changes resolving them.
+these tools is regzbot, which heavily relies on the "Closes:" and "Link:" tags
+to associate reports for regression with changes resolving them.
 
 Expectations and best practices for fixing regressions
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -326,9 +328,9 @@ 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.
-Combined this data provides good insights into the current state of the fixing
-process.
+with "Closes:" or "Link:" tags; replies to such patch postings are tracked as
+well. Combined this data provides good insights into the current state of the
+fixing process.
 
 Regzbot tries to do its job with as little overhead as possible for both
 reporters and developers. In fact, only reporters are burdened with an extra
@@ -338,8 +340,8 @@ 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.
+"Closes:" (or "Link:") tags to the patch description pointing to all reports
+about the issue fixed.
 
 Do I have to use regzbot?
 ~~~~~~~~~~~~~~~~~~~~~~~~~
-- 
2.44.0

Powered by blists - more mailing lists