Re: [PATCH 1/1] checkpatch: remove false warning for commit reference

Andy Whitcroft
2016-10-24T18:46:28Z

On Mon, Oct 24, 2016 at 11:39:45AM -0700, Joe Perches wrote:
> On Mon, 2016-10-24 at 19:22 +0200, Heinrich Schuchardt wrote:
> > On 10/23/2016 10:37 PM, Joe Perches wrote:
> > > On Sun, 2016-10-23 at 09:34 +0200, Heinrich Schuchardt wrote:
> > > > Checkpatch warns of an incorrect commit reference style
> > > > for any hexadecimal number of 12 digits and more.
> > > >
> > > > Numbers of 12 digits are not necessarily commit ids.
> > > >
> > > > For an example provoking the problem see
> > > > https://patchwork.kernel.org/patch/9170897/
> > > >
> > > > Checkpatch should only warn if the number refers to an
> > > > existing commit.
> > >
> > > That seems sensible.
> > >
> > > > Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
> > > > ---
> > > > scripts/checkpatch.pl | 5 ++++-
> > > > 1 file changed, 4 insertions(+), 1 deletion(-)
> > > >
> > > > diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> > >
> > > []
> > > > @@ -848,6 +848,7 @@ sub git_commit_info {
> > > > # echo "commit $(cut -c 1-12,41-)"
> > > > # done
> > > > } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
> > > > + $id = undef;
> > >
> > > OK
> > >
> > > > } else {
> > > > $id = substr($lines[0], 0, 12);
> > > > $desc = substr($lines[0], 41);
> > > > @@ -2577,7 +2578,9 @@ sub process {
> > > > ($id, $description) = git_commit_info($orig_commit,
> > > > $id, $orig_desc);
> > > >
> > > > - if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
> > > > + if ($id && ($short || $long || $space || $case
> > > > + || ($orig_desc ne $description)
> > > > + || !$hasparens)) {
> > >
> > > I'd prefer
> > > if (defined($id) &&
> >
> > For $id = 0 or $id = "" this would make a difference.
> > Surely I can update the patch like this to make the test more readable.
> >
> > > ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
> > >
> > > and not wrap the tests.
> >
> > Putting defined($id) on a line of its own is fine.
> >
> > Not wrapping the tests will produce a line of over 80 characters and
> > give a warning in scripts/checkpatch.pl.
> >
> > The script should respect the standards it imposes on others.
>
> Nope.
>
> I never bother using checkpatch on checkpatch.
> perl is unreadable enough with having to wrap long and
> complex regexes on 80 columns.

More specifically checkpatch is primarily checking C language construction
to keep the style of the Linux kernel consistent. The rules were never
really intended to apply to perl or other languages. We have long leant
towards longer lines in checkpatch for some kind of readability, as much
as you can have in "systactic sugar overload" language.

-apw