Received-SPF: pass (google.com: domain of linux-kernel+bounces-176841-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) client-ip=147.75.80.249;
Precedence: bulk
Mime-Version: 1.0
Content-Transfer-Encoding: quoted-printable
Content-Type: text/plain; charset=UTF-8
Date: Sun, 12 May 2024 10:48:15 +0200
Message-Id: <D17JB1SPR5SK.1B6BRVVU2Q6XN@matfyz.cz>
Subject: Re: [PATCH docs-next v2] docs: handling-regressions.rst: recommend
 using "Closes:" tags
To: "Thorsten Leemhuis" <linux@leemhuis.info>,
        "Jonathan Corbet"
 <corbet@lwn.net>, <regressions@lists.linux.dev>,
        <workflows@vger.kernel.org>, <linux-doc@vger.kernel.org>,
        <linux-kernel@vger.kernel.org>
From: "Karel Balej" <balejk@matfyz.cz>
References: <20240510183748.13028-1-balejk@matfyz.cz>
 <8ebe6545-de7e-4ee4-b36e-e91e90b90b70@leemhuis.info>
In-Reply-To: <8ebe6545-de7e-4ee4-b36e-e91e90b90b70@leemhuis.info>

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.
> >=20
> > Also fix a typo.
> >=20
> > 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:
>
> > =20
> >  What's important when fixing regressions
> >  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> > @@ -112,10 +115,16 @@ remember to do what Documentation/process/submitt=
ing-patches.rst,
> >  :ref:`Documentation/process/5.Posting.rst <development_posting>`, and
> >  Documentation/process/stable-kernel-rules.rst already explain in more =
detail:
> > =20
> > - * Point to all places where the issue was reported using "Link:" tags=
::
> > + * Point to all places where the issue was reported using "Closes:" ta=
gs::
> > =20
> > -       Link: https://lore.kernel.org/r/30th.anniversary.repost@klaava.=
Helsinki.FI/
> > -       Link: https://bugzilla.kernel.org/show_bug.cgi?id=3D1234567890
> > +       Closes: https://lore.kernel.org/r/30th.anniversary.repost@klaav=
a.Helsinki.FI/
> > +       Closes: https://bugzilla.kernel.org/show_bug.cgi?id=3D123456789=
0
> > +
> > +   If you are only fixing part of the issue, you may use "Link:" inste=
ad 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.