On Mon, 2022-08-29 at 17:53 +0200, Niklas Söderlund wrote: > Add a warning for fixes tags that does not fall in line with the > standards specified by the community. > > Signed-off-by: Niklas Söderlund <niklas.soderlund@xxxxxxxxxxxx> > Reviewed-by: Simon Horman <simon.horman@xxxxxxxxxxxx> > Reviewed-by: Louis Peens <louis.peens@xxxxxxxxxxxx> > --- > Documentation/dev-tools/checkpatch.rst | 6 ++++ > scripts/checkpatch.pl | 41 ++++++++++++++++++++++++++ > 2 files changed, 47 insertions(+) > > diff --git a/Documentation/dev-tools/checkpatch.rst b/Documentation/dev-tools/checkpatch.rst > index b52452bc2963..8164f362a2fc 100644 > --- a/Documentation/dev-tools/checkpatch.rst > +++ b/Documentation/dev-tools/checkpatch.rst > @@ -612,6 +612,12 @@ Commit message > > See: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes > > + **BAD_FIXES_TAG** > + The fixes line does not fall in line with the standards specified by the > + community. > + > + See: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes > + > > Comparison style > ---------------- > diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl > index 79e759aac543..9b8cdc582fb5 100755 > --- a/scripts/checkpatch.pl > +++ b/scripts/checkpatch.pl > @@ -3140,6 +3140,47 @@ sub process { > } > } > > +# Check Fixes: styles is correct > + if (!$in_header_lines && $line =~ /^fixes:/i) { > + my $orig_commit = ""; > + my $id = "0123456789ab"; > + my $title = "commit title"; > + my $tag_case = 1; > + my $tag_space = 1; > + my $id_length = 1; > + my $id_case = 1; > + my $title_has_quotes = 0; > + > + if ($line =~ /(fixes:)\s+([0-9a-f]{5,})\s+($balanced_parens)/i) { Maybe use fixes:? so the colon is not required in poorly formed uses > + my $tag = $1; > + $orig_commit = $2; > + $title = $3; > + > + $tag_case = 0 if $tag eq "Fixes:"; > + $tag_space = 0 if ($line =~ /^fixes: [0-9a-f]{5,} ($balanced_parens)/i); fixes:? here too Pity there's no simple way to consolidate this git commit test block with the existing git id commit block. > + > + $id_length = 0 if ($orig_commit =~ /^[0-9a-f]{12}$/i); > + $id_case = 0 if ($orig_commit !~ /[A-F]/); > + > + # Always strip leading/trailing parens then double quotes if existing > + $title = substr($title, 1, -1); > + if ($title =~ /^".*"$/) { > + $title = substr($title, 1, -1); > + $title_has_quotes = 1; > + } > + } > + > + ($id, $title) = git_commit_info($orig_commit, $id, > + $title); > + > + if ($tag_case || $tag_space || $id_length || $id_case || > + !$title_has_quotes) { > + WARN("BAD_FIXES_TAG", > + "Please use correct Fixes: style 'Fixes: <12 chars of sha1> (\"<title line>\")' - ie: 'Fixes: $id (\"$title\")'\n" . $herecurr); > + > + } > + } > + > # Check email subject for common tools that don't need to be mentioned > if ($in_header_lines && > $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
