Re: [PATCH docs-next v2] docs: handling-regressions.rst: recommend using "Closes:" tags
From: Thorsten Leemhuis
Date: Sun May 12 2024 - 03:47:48 EST
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@xxxxxxxxx>
Many thx for this, much appreciated. Looks good!
Acked-by: Thorsten Leemhuis <linux@xxxxxxxxxxxxx>
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@xxxxxxxxxxxxxxxxxx/
> - Link: https://bugzilla.kernel.org/show_bug.cgi?id=1234567890
> + Closes: https://lore.kernel.org/r/30th.anniversary.repost@xxxxxxxxxxxxxxxxxx/
> + 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