Bogus error in checkpatch.pl

Bogus error in checkpatch.pl

[Pranith Kumar]

I receive an ERROR when running checkpatch.pl on a patch containing
the following line:

Commit 615cc2c9cf95 "Documentation/memory-barriers.txt: fix important typo re

saying that the commit ID should be 12 or more characters when the
commit ID is indeed 12 characters. I tried fixing it, but my perl is
not up-to-par.

Please fix! Thanks.

-- 
Pranith

Re: Bogus error in checkpatch.pl

[Joe Perches]

On Wed, 2014-09-03 at 00:03 -0400, Pranith Kumar wrote:
> I receive an ERROR when running checkpatch.pl on a patch containing
> the following line:
> 
> Commit 615cc2c9cf95 "Documentation/memory-barriers.txt: fix important typo re
> 
> saying that the commit ID should be 12 or more characters when the
> commit ID is indeed 12 characters. I tried fixing it, but my perl is
> not up-to-par.

You need to use parentheses around the description like:
	commit <commitid> ("commit description")

For your case:

Commit 615cc2c9cf95 ("Documentation/memory-barriers.txt: fix important
typo re memory barriers")

Re: Bogus error in checkpatch.pl

[Pranith Kumar]

Hi Joe,

On Wed, Sep 3, 2014 at 12:25 AM, Joe Perches <joe@perches.com> wrote:
>
> You need to use parentheses around the description like:
>         commit <commitid> ("commit description")
>
> For your case:
>
> Commit 615cc2c9cf95 ("Documentation/memory-barriers.txt: fix important
> typo re memory barriers")
>

Ah, OK. But the error message does not say anything about missing
paranetheses and only stresses on chars in the id:

$ ./scripts/checkpatch.pl
patch_dir/0001-doc-memory-barriers.txt-Correct-example-for-reorderi.patch
ERROR: Please use 12 or more chars for the git commit ID like: 'Commit
615cc2c9cf95 ("Documentation/memory-barriers.txt: fix important typo
re memory barriers")'
#8:
Commit 615cc2c9cf95 "Documentation/memory-barriers.txt: fix important typo re


Is it possible to make it a bit clearer, perhaps?

Thanks!
-- 
Pranith

Re: Bogus error in checkpatch.pl

[Joe Perches]

On Wed, 2014-09-03 at 00:29 -0400, Pranith Kumar wrote:
> Hi Joe,

Hello Pranith.

> On Wed, Sep 3, 2014 at 12:25 AM, Joe Perches <joe@perches.com> wrote:
> > You need to use parentheses around the description like:
> >         commit <commitid> ("commit description")
> > For your case:
> > Commit 615cc2c9cf95 ("Documentation/memory-barriers.txt: fix important
> > typo re memory barriers")
> Ah, OK. But the error message does not say anything about missing
> paranetheses and only stresses on chars in the id:
> 
> $ ./scripts/checkpatch.pl
> patch_dir/0001-doc-memory-barriers.txt-Correct-example-for-reorderi.patch
> ERROR: Please use 12 or more chars for the git commit ID like: 'Commit
> 615cc2c9cf95 ("Documentation/memory-barriers.txt: fix important typo
> re memory barriers")'
> #8:
> Commit 615cc2c9cf95 "Documentation/memory-barriers.txt: fix important typo re
> Is it possible to make it a bit clearer, perhaps?

Maybe.  Suggest a modified message.

Re: Bogus error in checkpatch.pl

[Pranith Kumar]

On 09/03/2014 01:34 AM, Joe Perches wrote:
> Maybe.  Suggest a modified message.
>

How about the following?

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index b602ed2..bcc384e 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -2143,7 +2143,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 use 12 or more chars for the git commit ID and parentheses for the commit message like: '${init_char}ommit $id (\"$desc\")'\n" . $herecurr);
                }
 
 # Check for added, moved or deleted files