| Message ID | 20230314-doc-checkpatch-closes-tag-v3-3-d1bdcf31c71c@tessares.net (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | docs & checkpatch: allow Closes tags with links | expand |
On Thu, 2023-03-30 at 20:13 +0200, Matthieu Baerts wrote: > As a follow-up of a previous patch modifying the documentation to > allow using the "Closes:" tag, checkpatch.pl is updated accordingly. > > checkpatch.pl now no longer complain when the "Closes:" tag is used by > itself or after the "Reported-by:" tag. > > Fixes: 76f381bb77a0 ("checkpatch: warn when unknown tags are used for links") > Fixes: d7f1d71e5ef6 ("checkpatch: warn when Reported-by: is not followed by Link:") I don't think this _fixes_ anything. I believe it's merely a new capability. > Closes: https://github.com/multipath-tcp/mptcp_net-next/issues/373 > Signed-off-by: Matthieu Baerts <matthieu.baerts@tessares.net> > --- > v3: > - split into 2 patches: the previous one adds a list with all the > "link" tags. This one only allows the "Closes" tag. (Joe Perches) > - "Closes" is no longer printed between parenthesis. (Thorsten > Leemhuis) > --- > scripts/checkpatch.pl | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl > index 9d092ff4fc16..ca58c734ff22 100755 > --- a/scripts/checkpatch.pl > +++ b/scripts/checkpatch.pl > @@ -620,7 +620,7 @@ our $signature_tags = qr{(?xi: > Cc: > )}; > > -our @link_tags = qw(Link); > +our @link_tags = qw(Link Closes); > > #Create a search and print patterns for all these strings to be used directly below > our $link_tags_search = ""; >
Hi Joe, Thank you for this review. On 31/03/2023 00:43, Joe Perches wrote: > On Thu, 2023-03-30 at 20:13 +0200, Matthieu Baerts wrote: >> As a follow-up of a previous patch modifying the documentation to >> allow using the "Closes:" tag, checkpatch.pl is updated accordingly. >> >> checkpatch.pl now no longer complain when the "Closes:" tag is used by >> itself or after the "Reported-by:" tag. >> >> Fixes: 76f381bb77a0 ("checkpatch: warn when unknown tags are used for links") >> Fixes: d7f1d71e5ef6 ("checkpatch: warn when Reported-by: is not followed by Link:") > > I don't think this _fixes_ anything. > I believe it's merely a new capability. When we first saw the new warnings checkpatch.pl was producing on a pre Linux 6.3-rc1, we thought it was an issue with checkpatch: the "Closes:" tag with a URL has been used for years without any complaints from checkpatch and people as far as I know. At some point we had to stop using it to please checkpatch and that's why we thought something had to be fixed: we initially [1] thought the "Closes:" tag case had been forgotten when the two mentioned commits had been created. But I'm fine to see these "Fixes" tags removed, I understand the "Closes:" tags were tolerated before but just not documented. Do I send a v4 without these two "Fixes" tags? It means only the v6.3 would not accept "Closes:" tags but we can work around that. [1] https://lore.kernel.org/all/a27480c5-c3d4-b302-285e-323df0349b8f@tessares.net/ Cheers, Matt
diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl index 9d092ff4fc16..ca58c734ff22 100755 --- a/scripts/checkpatch.pl +++ b/scripts/checkpatch.pl @@ -620,7 +620,7 @@ our $signature_tags = qr{(?xi: Cc: )}; -our @link_tags = qw(Link); +our @link_tags = qw(Link Closes); #Create a search and print patterns for all these strings to be used directly below our $link_tags_search = "";
As a follow-up of a previous patch modifying the documentation to allow using the "Closes:" tag, checkpatch.pl is updated accordingly. checkpatch.pl now no longer complain when the "Closes:" tag is used by itself or after the "Reported-by:" tag. Fixes: 76f381bb77a0 ("checkpatch: warn when unknown tags are used for links") Fixes: d7f1d71e5ef6 ("checkpatch: warn when Reported-by: is not followed by Link:") Closes: https://github.com/multipath-tcp/mptcp_net-next/issues/373 Signed-off-by: Matthieu Baerts <matthieu.baerts@tessares.net> --- v3: - split into 2 patches: the previous one adds a list with all the "link" tags. This one only allows the "Closes" tag. (Joe Perches) - "Closes" is no longer printed between parenthesis. (Thorsten Leemhuis) --- scripts/checkpatch.pl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)