Re: Make Bjorn's life easier (and grease the path of your patch)

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi Bjorn,

On Thu, Oct 26, 2017 at 05:37:01PM -0500, Bjorn Helgaas wrote:
> 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@xxxxxxxxxxxxxxx	# 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:

  WARNING: Reported-by: should be immediately followed by Closes: with a URL to the report
  #38: 
  Reported-by: Chad Schroeder <CSchroeder@xxxxxxxxxx>
  Tested-by: Chad Schroeder <CSchroeder@xxxxxxxxxx>

  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.

I've pointed other folks to your message so that they know which guidelines
to observe when submitting to linux-pci.  I'd like to encourage you to
update it and (if you like) add it to the tree as a maintainer profile
(see Documentation/maintainer/maintainer-entry-profile.rst) so that it's
even easier to find.

[1] https://lore.kernel.org/linux-pci/20171026223701.GA25649@xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/

Thanks!

Lukas



[Index of Archives]     [DMA Engine]     [Linux Coverity]     [Linux USB]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]     [Greybus]

  Powered by Linux