linux-kernel - Re: [PATCH docs-next v2] docs: handling-regressions.rst: recommend using "Closes:" tags

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <8ebe6545-de7e-4ee4-b36e-e91e90b90b70@leemhuis.info>
Date: Sun, 12 May 2024 09:47:31 +0200
From: Thorsten Leemhuis <linux@...mhuis.info>
To: Karel Balej <balejk@...fyz.cz>, Jonathan Corbet <corbet@....net>,
 regressions@...ts.linux.dev, workflows@...r.kernel.org,
 linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH docs-next v2] docs: handling-regressions.rst: recommend
 using "Closes:" tags

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@...fyz.cz>

Many thx for this, much appreciated. Looks good!

Acked-by: Thorsten Leemhuis <linux@...mhuis.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