checkpatch: fix can't check for too long invalid commit id
Subsystems (2)
PATCH 1/1 checkpatch: fix can't check for too long invalid commit id
The current UNKNOWN_COMMIT_ID doesn't check for 41+ length commit id, and although GIT_COMMIT_ID will check for 41+ length commit id, but it willn't warn anything about it due to 41+ length commit will never be defined.
This patch moves the unknown commit id check for normal commit description to GIT_COMMIT_ID, and uses ERROR instead of WARN, because unknown commit id is total useless to track change history in changelog, it deserves the ERROR.
---
After this patch, in another patch 'checkpatch: add support to check 'Fixes:' tag format', I will delete UNKNOWN_COMMIT_ID, because we don't need it anymore after GIT_COMMIT_ID could do the same check as UNKNOWN_COMMIT_ID for 'Fixes:' tag.
scripts/checkpatch.pl | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-)
scripts/checkpatch.pl +12 -2
@@ -2865,8 +2865,18 @@ sub process { ($id, $description) = git_commit_info($orig_commit, $id, $orig_desc); + if (!defined($id)) { + if ($long) { + ERROR("GIT_COMMIT_ID", + "Unknown commit id '$orig_commit' is too long, maybe misspelled?\n" . $herecurr); + } else { + ERROR("GIT_COMMIT_ID", + "Unknown commit id '$orig_commit', maybe rebased or not pulled?\n" . $herecurr); + } + } + if (defined($id) && - ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) { + ($short || $space || $case || ($orig_desc ne $description) || !$hasparens)) { ERROR("GIT_COMMIT_ID", "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr); }
@@ -2969,7 +2979,7 @@ sub process { } # check for invalid commit id - if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) { + if ($in_commit_log && $line =~ /(^fixes:)\s+([0-9a-f]{6,40})\b/i) { my $id; my $description; ($id, $description) = git_commit_info($2, undef, undef);
Signature · 1 line
1.8.5.6.2.g3d8a54e.dirty
Joe Perches
maintainerQuoted 11 lines · Wang YanQing
The current
UNKNOWN_COMMIT_IDdoesn't check for 41+ length commit id, and althoughGIT_COMMIT_IDwill check for 41+ length commit id, but it willn't warn anything about it due to 41+ length commit will never be defined.This patch moves the unknown commit id check for normal commit description to
GIT_COMMIT_ID, and uses ERROR instead of WARN, because unknown commit id is total useless to track change history in changelog, it deserves the ERROR.Signed-off-by Wang YanQing <[email protected]>
Hi again. Trivial notes:
scripts/checkpatch.pl
Quoted 1 line
scripts/checkpatch.pl +0
-0
[]
scripts/checkpatch.pl sub process { · line 2871
Quoted 8 lines
scripts/checkpatch.pl +4
-0@@ -2865,8 +2865,18 @@ sub process { ($id, $description) = git_commit_info($orig_commit, $id, $orig_desc); + if (!defined($id)) { + if ($long) { + ERROR("GIT_COMMIT_ID", + "Unknown commit id '$orig_commit' is too long, maybe misspelled?\n" . $herecurr);
checkpatch always uses tab indentation.
Please convert from 4 spaces to 1
tab and reindent the rest.
"misspelled" word choice may not be the best here as a SHA-1 isn't really something that is spelled.
Perhaps something like:
"Invalid commit id '$orig_commit' length '" . length($orig_commit) . "' exceeds allowed maximum of 40\n",
Though maybe a recommended maximum of some constant should be used.
my $recommended_sha_length = 12;
scripts/checkpatch.pl sub process { · line 2982
Quoted 6 lines
scripts/checkpatch.pl +1
-1@@ -2969,7 +2979,7 @@ sub process { } # check for invalid commit id - if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) { + if ($in_commit_log && $line =~ /(^fixes:)\s+([0-9a-f]{6,40})\b/i) {
Likely this capture group around Fixes: isn't necessary any more.
scripts/checkpatch.pl sub process { · line 2985
Quoted 3 lines
scripts/checkpatch.pl +0
-0my $id; my $description; ($id, $description) = git_commit_info($2, undef, undef);
$1 ?