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]

 



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@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:

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@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.

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@xxxxxxxxxxxxxxx	# (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



[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