checkpatch.pl: warn on invalid commit id
PATCH v2 1/1 checkpatch.pl: warn on invalid commit id
It can happen that a commit message refers to an invalid commit id, because the referenced hash changed following a rebase, or simply by mistake. Add a check in checkpatch.pl which checks that an hash referenced by a Fixes tag, or just cited in the commit message, is a valid commit id.
$ scripts/checkpatch.pl <<'EOF'
Subject: [PATCH] test commit Sample test commit to test checkpatch.pl Commit 1da177e4c3f4 ("Linux-2.6.12-rc2") really exists, commit 0bba044c4ce7 ("tree") is valid but not a commit, while commit b4cc0b1c0cca ("unknown") is invalid.
EOF
WARNING: Unknown commit id '0bba044c4ce7', maybe rebased or not pulled? #8:
commit 0bba044c4ce7 ("tree") is valid but not a commit,
WARNING: Unknown commit id 'b4cc0b1c0cca', maybe rebased or not pulled? #9:
while commit b4cc0b1c0cca ("unknown") is invalid.
WARNING: Unknown commit id 'f0cacc14cade', maybe rebased or not pulled? #11:
total: 0 errors, 3 warnings, 4 lines checked
--- scripts/checkpatch.pl | 11 +++++++++++ 1 file changed, 11 insertions(+)
scripts/checkpatch.pl +11 -0
@@ -2898,6 +2898,17 @@ sub process { } } +# check for invalid commit id + if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) { + my $id; + my $description; + ($id, $description) = git_commit_info($2, undef, undef); + if (!defined($id)) { + WARN("UNKNOWN_COMMIT_ID", + "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr); + } + } + # ignore non-hunk lines and lines being removed next if (!$hunk_line || $line =~ /^-/);
Signature · 1 line
2.21.0
Joe Perches
maintainerQuoted 4 lines · Matteo Croce
It can happen that a commit message refers to an invalid commit id, because the referenced hash changed following a rebase, or simply by mistake. Add a check in checkpatch.pl which checks that an hash referenced by a Fixes tag, or just cited in the commit message, is a valid commit id.
Thanks Matteo, this seems sensible.
Quoted 52 lines
$ scripts/checkpatch.pl <<'EOF' Subject: [PATCH] test commitSample test commit to test checkpatch.pl Commit
1da177e4c3f4("Linux-2.6.12-rc2") really exists, commit0bba044c4ce7("tree") is valid but not a commit, while commitb4cc0b1c0cca("unknown") is invalid.Fixes f0cacc14cade ("unknown")Fixes 1da177e4c3f4 ("Linux-2.6.12-rc2")EOF
WARNING: Unknown commit id '0bba044c4ce7', maybe rebased or not pulled? #8:
commit0bba044c4ce7("tree") is valid but not a commit,WARNING: Unknown commit id '
b4cc0b1c0cca', maybe rebased or not pulled? #9:
while commitb4cc0b1c0cca("unknown") is invalid.WARNING: Unknown commit id '
f0cacc14cade', maybe rebased or not pulled? #11:Fixes f0cacc14cade ("unknown")total: 0 errors, 3 warnings, 4 lines checked
Signed-off-by Matteo Croce <[email protected]>--- scripts/checkpatch.pl | 11 +++++++++++ 1 file changed, 11 insertions(+)scripts/checkpatch.pl +11
-0@@ -2898,6 +2898,17 @@ sub process { } } +# check for invalid commit id + if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) { + my $id; + my $description; + ($id, $description) = git_commit_info($2, undef, undef); + if (!defined($id)) { + WARN("UNKNOWN_COMMIT_ID", + "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr); + } + } + # ignore non-hunk lines and lines being removed next if (!$hunk_line || $line =~ /^-/);
Quoted 39 lines · On Thu, 11 Jul 2019 02:16:40 +0200 Matteo Croce <[email protected]> wrote:
It can happen that a commit message refers to an invalid commit id, because the referenced hash changed following a rebase, or simply by mistake. Add a check in checkpatch.pl which checks that an hash referenced by a Fixes tag, or just cited in the commit message, is a valid commit id.
$ scripts/checkpatch.pl <<'EOF' Subject: [PATCH] test commitSample test commit to test checkpatch.pl Commit
1da177e4c3f4("Linux-2.6.12-rc2") really exists, commit0bba044c4ce7("tree") is valid but not a commit, while commitb4cc0b1c0cca("unknown") is invalid.Fixes f0cacc14cade ("unknown")Fixes 1da177e4c3f4 ("Linux-2.6.12-rc2")EOF
WARNING: Unknown commit id '0bba044c4ce7', maybe rebased or not pulled? #8:
commit0bba044c4ce7("tree") is valid but not a commit,WARNING: Unknown commit id '
b4cc0b1c0cca', maybe rebased or not pulled? #9:
while commitb4cc0b1c0cca("unknown") is invalid.WARNING: Unknown commit id '
f0cacc14cade', maybe rebased or not pulled? #11:Fixes f0cacc14cade ("unknown")total: 0 errors, 3 warnings, 4 lines checked
...
scripts/checkpatch.pl +1
-0@@ -2898,6 +2898,17 @@ sub process { } } +# check for invalid commit id
scripts/checkpatch.pl sub process { · line 2911
Quoted 10 lines
scripts/checkpatch.pl +10
-0+ if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) { + my $id; + my $description; + ($id, $description) = git_commit_info($2, undef, undef); + if (!defined($id)) { + WARN("UNKNOWN_COMMIT_ID", + "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr); + } + } +
What does it do if we're not operating in a git directory? For example, I work in /usr/src/25 and my git repo is in ../git26.
Also, what happens relatively often is that someone quotes a linux-next or long-term-stable hash. If the user has those trees in the git repo, I assume they won't be informed of the inappropriate hash?
Quoted 3 lines · Andrew Morton
What does it do if we're not operating in a git directory? For example, I work in
/usr/src/25and my git repo is in ../git26.
If .git is not found, the check is disabled
Quoted 4 lines
Also, what happens relatively often is that someone quotes a linux-next or long-term-stable hash. If the user has those trees in the git repo, I assume they won't be informed of the inappropriate hash?
In this case it won't warn, but this should not be a problem, as the hash doesn't change following a merge.
The problem is just if the other tree gets rebased, or if the other tree gets never merged, e.g. stable/linux-*
Cheers,
--
Matteo Croce
per aspera ad upstream
Quoted 6 lines · On Thu, 25 Jul 2019 11:26:04 +0200 Matteo Croce <[email protected]> wrote:
Quoted 3 lines · Andrew Morton
What does it do if we're not operating in a git directory? For example, I work in
/usr/src/25and my git repo is in ../git26.If .git is not found, the check is disabled
We could permit user to set an environment variable to tell checkpatch where the kernel git tree resides.
Quoted 9 lines
Quoted 4 lines
Also, what happens relatively often is that someone quotes a linux-next or long-term-stable hash. If the user has those trees in the git repo, I assume they won't be informed of the inappropriate hash?
In this case it won't warn, but this should not be a problem, as the hash doesn't change following a merge.
The problem is just if the other tree gets rebased, or if the other tree gets never merged, e.g. stable/linux-*
linux-next patches get rebased quite often. I guess this is acceptable
- failing to warn about an error is better than warning about not-an-error.
Quoted 6 lines · Andrew Morton
Quoted 1 line · On Thu, 25 Jul 2019 11:26:04 +0200 Matteo Croce <[email protected]> wrote:
On Thu, Jul 25, 2019 at 5:07 AM Andrew Morton
Quoted 1 line · <[email protected]> wrote:
Quoted 1 line
What does it do if we're not operating in a git directory? For
Quoted 9 lines
example,
Quoted 4 lines
Quoted 2 lines
I work in
/usr/src/25and my git repo is in ../git26.If .git is not found, the check is disabled
We could permit user to set an environment variable to tell checkpatch where the kernel git tree resides.
Maybe GIT_DIR already does it.
Quoted 7 lines
Quoted 1 line
Quoted 1 line
Also, what happens relatively often is that someone quotes a
linux-next
Quoted 1 line
Quoted 1 line
or long-term-stable hash. If the user has those trees in the git
repo,
Quoted 3 lines
Quoted 2 lines
I assume they won't be informed of the inappropriate hash?
Quoted 6 lines
Quoted 4 lines
In this case it won't warn, but this should not be a problem, as the hash doesn't change following a merge.
The problem is just if the other tree gets rebased, or if the other tree gets never merged, e.g. stable/linux-*linux-next patches get rebased quite often.
I see :)
Signature · 2 lines
Matteo Croce per aspera ad upstream
Quoted 7 lines · On Fri, 26 Jul 2019 03:17:32 +0200 Matteo Croce <[email protected]> wrote:
Quoted 5 lines
Quoted 1 line
If .git is not found, the check is disabled
We could permit user to set an environment variable to tell checkpatch where the kernel git tree resides.
Maybe
GIT_DIRalready does it.
Yes, that works. GIT_DIR=<wherever>/.git