LKML Archive mirror
 help / color / mirror / Atom feed
From: "Karel Balej" <balejk@matfyz.cz>
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>
Subject: Re: [PATCH docs-next v2] docs: handling-regressions.rst: recommend using "Closes:" tags
Date: Sun, 12 May 2024 10:48:15 +0200	[thread overview]
Message-ID: <D17JB1SPR5SK.1B6BRVVU2Q6XN@matfyz.cz> (raw)
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.
> > 
> > Also fix a typo.
> > 
> > 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:
>
> >  
> >  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.

  reply	other threads:[~2024-05-12  8:48 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-05-10 18:34 [PATCH docs-next v2] docs: handling-regressions.rst: recommend using "Closes:" tags Karel Balej
2024-05-12  7:47 ` Thorsten Leemhuis
2024-05-12  8:48   ` Karel Balej [this message]
2024-05-13  6:49     ` Thorsten Leemhuis

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=D17JB1SPR5SK.1B6BRVVU2Q6XN@matfyz.cz \
    --to=balejk@matfyz.cz \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux@leemhuis.info \
    --cc=regressions@lists.linux.dev \
    --cc=workflows@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).