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 for Android: free password hash cracker in your pocket

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

Message-Id: <D17JB1SPR5SK.1B6BRVVU2Q6XN@matfyz.cz>
Date: Sun, 12 May 2024 10:48:15 +0200
From: "Karel Balej" <balejk@...fyz.cz>
To: "Thorsten Leemhuis" <linux@...mhuis.info>,
        "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

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@...fyz.cz>
>
> Many thx for this, much appreciated. Looks good!
>
> Acked-by: Thorsten Leemhuis <linux@...mhuis.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.