lkml.org 
[lkml]   [2019]   [Jul]   [24]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH v2] checkpatch.pl: warn on invalid commit id
On Thu, 11 Jul 2019 02:16:40 +0200 Matteo Croce <mcroce@redhat.com> 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 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.
>
> Fixes: f0cacc14cade ("unknown")
> Fixes: 1da177e4c3f4 ("Linux-2.6.12-rc2")
> 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:
> Fixes: f0cacc14cade ("unknown")
>
> total: 0 errors, 3 warnings, 4 lines checked
>
> ...
>
> --- a/scripts/checkpatch.pl
> +++ b/scripts/checkpatch.pl
> @@ -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);
> + }
> + }
> +

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?

\
 
 \ /
  Last update: 2019-07-25 05:07    [W:0.882 / U:0.044 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site