All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Krzysztof Wilczyński" <kw@linux.com>
To: Lukas Wunner <lukas@wunner.de>
Cc: Bjorn Helgaas <helgaas@kernel.org>, linux-pci@vger.kernel.org
Subject: Re: Make Bjorn's life easier (and grease the path of your patch)
Date: Fri, 22 Sep 2023 03:44:58 +0900	[thread overview]
Message-ID: <20230921184458.GA3964991@rocinante> (raw)
In-Reply-To: <20230921151401.GA25512@wunner.de>

Hello,

[...]
> > This is a list of things I look at when reviewing patches.
> [...]
> > Write the changelog:
> [...]
> >   - Order tags as suggested by Ingo [1] (extended):
> > 
> >       Fixes:
> >       Link:
> >       Reported-by:
> >       Tested-by:
> >       Signed-off-by: (author)
> >       Signed-off-by: (chain)
> >       Reviewed-by:
> >       Acked-by:
> >       Cc: stable@vger.kernel.org	# 3.4+
> >       Cc: (other)
> 
> I've used your message from 2017 [1] as a reference on how to order tags
> but today discovered that checkpatch.pl has a new rule which is sort of
> at odds with your preferred style:

I think, it's time for a resend and a refresh of this message. :)

>   WARNING: Reported-by: should be immediately followed by Closes: with a URL to the report
>   #38: 
>   Reported-by: Chad Schroeder <CSchroeder@sonifi.com>
>   Tested-by: Chad Schroeder <CSchroeder@sonifi.com>
> 
>   total: 0 errors, 1 warnings, 15 lines checked
> 
> I'm not sure where to insert the Closes tag, checkpatch wants it immediately
> after the Reported-by, but since Closes is like Link, I'd assume that you'd
> prefer it to precede the Reported-by.

This is what I have settled with:

  Fixes:
  Closes:
  Suggested-by:
  Link:
  Reported-by:
  Tested-by:
  Co-developed-by: (co-author)
  Signed-off-by: (co-author)
  Signed-off-by: (author)
  Signed-off-by: (chain)
  Reviewed-by:
  Acked-by:
  Cc: stable@vger.kernel.org	# (version)
  Cc: (other)

The above is a combination of Bjorn's take on Ingo's original suggestion
that incorporates elements from the official kernel documentation[1].

1. https://www.kernel.org/doc/html/latest/process/submitting-patches.html

	Krzysztof

      parent reply	other threads:[~2023-09-21 18:54 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-10-26 22:37 Make Bjorn's life easier (and grease the path of your patch) Bjorn Helgaas
2023-09-21 15:14 ` Lukas Wunner
2023-09-21 16:27   ` Bjorn Helgaas
2023-09-21 18:44   ` Krzysztof Wilczyński [this message]

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=20230921184458.GA3964991@rocinante \
    --to=kw@linux.com \
    --cc=helgaas@kernel.org \
    --cc=linux-pci@vger.kernel.org \
    --cc=lukas@wunner.de \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.