checkpatch: add dedicated checker for 'Fixes:' tag
Subsystems (2)
PATCH v2 1/1 checkpatch: add dedicated checker for 'Fixes:' tag
According to submitting-patches.rst, 'Fixes:' tag has a little stricter condition about the one line summary:
"
Do not split the tag across multiple
lines, tags are exempt from the "wrap at 75 columns" rule in order to simplify parsing scripts
"
And the current 'Fixes:' checker in "# Check for git id commit length and improperly formed commit descriptions" doesn't check for invalid commit id length, so this patch adds dedicated checker to fix these issues.
--- scripts/checkpatch.pl | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-)
v1-v2:
1: Reword commit log (Markus Elfring).
2: Allow more than 12 characters of SHA-1 id (Markus Elfring). 3: Update the error message according to reflect the second update. 4: Add missing (?:...).
scripts/checkpatch.pl +8 -1
@@ -2820,7 +2820,7 @@ sub process { ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i || ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i && $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i && - $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) { + $line !~ /^\s*fixes:\s*(?:[0-9a-f]{6,40})\s*(?:.*)/i))) { my $init_char = "c"; my $orig_commit = ""; my $short = 1;
@@ -2979,6 +2979,13 @@ sub process { } } + if ($in_commit_log && $line =~ /^\s*fixes:\s*([0-9a-f]{6,40})\s*(.*)/i) { + if (length($1) < 12 || $2 !~ /^\(\"(?:.*)\"\)$/i) { + ERROR("FIXES_TAG", + "please use the 'Fixes:' tag with at least the first 12 characters of the SHA-1 ID, and the one line summary(no across multiple lines)\n" . $herecurr); + } + } + # ignore non-hunk lines and lines being removed next if (!$hunk_line || $line =~ /^-/);
Signature · 1 line
1.8.5.6.2.g3d8a54e.dirty
Quoted 1 line
According to
submitting-patches.rst, …
I find that the reference to this document can trigger further considerations also for this evolving change description.
Quoted 5 lines
"
Do not split the tag across multiple
lines, tags are exempt from the "wrap at 75 columns" rule in order to simplify parsing scripts
"
Can it be nicer to use typographic quotation characters together with ellipses?
Quoted 2 lines
And the current 'Fixes:' checker in "# Check for git id commit length and improperly formed commit descriptions" doesn't check for invalid commit id
Should this “link” refer to a known check name?
Quoted 1 line
length, so this patch adds dedicated checker to fix these issues.
Would you care to transform this information into an imperative wording?
…
Quoted 2 lines
+++
b/scripts/checkpatch.pl(quoted diff) +0
-0@@ -2820,7 +2820,7 @@ sub process {
…
scripts/checkpatch.pl sub process { · line 2823
Quoted 2 lines
scripts/checkpatch.pl +1
-1- $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) { + $line !~ /^\s*fixes:\s*(?:[0-9a-f]{6,40})\s*(?:.*)/i))) {
I guess that the clarification around the relevance of word boundaries will become also more interesting.
Will it become relevant to check if a provided change identification can actually be resolved to the desired commit?
Quoted 1 line
(quoted diff) +0
-0@@ -2979,6 +2979,13 @@ sub process {
…
scripts/checkpatch.pl sub process { · line 2985
Quoted 2 lines
scripts/checkpatch.pl +2
-0+ ERROR("FIXES_TAG", + "please use the 'Fixes:' tag with at least the first 12 characters of the SHA-1 ID, and the one line summary(no across multiple lines)\n" . $herecurr);
* How do you think about to start this message with the word “Please”?
* Is the text “summary(no across” still questionable?
* Will there be a need to explicitly describe the data format for the summary specification also at this place?
Regards,
Markus