Re: [PATCH] scripts, checkpatch.pl, provide a better output message for commit id format errors

From: Joe Perches
Date: Fri Oct 17 2014 - 14:44:17 EST


On Fri, 2014-10-17 at 10:34 -0400, Prarit Bhargava wrote:
> I put together a patch with an incorrect format and the following error
> was returned by checkpatch.pl:
>
> ERROR: Please use 12 or more chars for the git commit ID like: 'Commit
> 09ec54429c6d ("clocksource: Move cycle_last validation to core code")'
> Commit 09ec54429c6d10f87d1f084de53ae2c1c3a81108, clocksource: Move
>
> The message is confusing. Change it to request that the author use the
> example commit ID format.
[]
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
[]
> @@ -2174,7 +2174,7 @@ sub process {
> my $desc = 'commit description';
> ($id, $desc) = git_commit_info($orig_commit, $id, $desc);
> ERROR("GIT_COMMIT_ID",
> - "Please use 12 or more chars for the git commit ID like: '${init_char}ommit $id (\"$desc\")'\n" . $herecurr);
> + "Please format the git commit ID like: '${init_char}ommit $id (\"$desc\")'\n" . $herecurr);
> }
>
> # Check for added, moved or deleted files

This doesn't show that a commit ID may be too short.
Maybe there should be multiple error messages depending
on what is not correct about the original.


--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/