Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
MIME-Version: 1.0
References: <20200630143525.13869-1-quentin@isovalent.com> <39ba164ba44be848feac831f2f21effca92bfc96.camel@perches.com>
In-Reply-To: <39ba164ba44be848feac831f2f21effca92bfc96.camel@perches.com>
From:   Vadim Bendebury <vbendeb@chromium.org>
Date:   Tue, 30 Jun 2020 10:20:19 -0700
Message-ID: <CAC3GErHpyyA8eQUyP6s_H6csvbKfHXHi50Ky6A1PhU+A6waCeQ@mail.gmail.com>
Subject: Re: [PATCH] checkpatch: prevent reporting C99_COMMENTS error for SPDX
 tag in .c file
To:     Joe Perches <joe@perches.com>
Cc:     Quentin Monnet <quentin@isovalent.com>,
        Andy Whitcroft <apw@canonical.com>,
        Andrew Morton <akpm@linux-foundation.org>,
        linux-kernel@vger.kernel.org
Content-Type: text/plain; charset="UTF-8"
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

On Tue, Jun 30, 2020 at 7:47 AM Joe Perches <joe@perches.com> wrote:
>
> (adding Vadem Bendebury who added the tolerance test)
>
> On Tue, 2020-06-30 at 15:35 +0100, Quentin Monnet wrote:
> > When checkpatch.pl is invoked with "--ignore C99_COMMENT_TOLERANCE", it
> > reports C99-style comments found in the code, by matching on the
> > double-slash pattern "//". This includes the leading slashes before the
> > SPDX tags that are now used in a majority of C files.
> >
> > Such tags are commented with the double-slash on purpose, and should not
> > trigger errors from checkpatch. Let's ignore them when searching for
> > C99-style comments to report.
> >
> > Signed-off-by: Quentin Monnet <quentin@isovalent.com>
>
> I think this unnecessary as perhaps those that want no
> c99 comments likely _really_ want no c99 comments.
>
> > ---
> >  scripts/checkpatch.pl | 5 ++++-
> >  1 file changed, 4 insertions(+), 1 deletion(-)
> >
> > diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> > index 3cacc122c528..67f350c580ea 100755
> > --- a/scripts/checkpatch.pl
> > +++ b/scripts/checkpatch.pl
> > @@ -3983,7 +3983,10 @@ sub process {
> >               }
> >
> >  # no C99 // comments
> > -             if ($line =~ m{//}) {
> > +             if ($line =~ m{//} &&
> > +                 !($rawline =~ m{// SPDX-License-Identifier:} &&
> > +                   $realfile =~ /\.c$/ &&
Do I understand this right that with this change in the check would be
applied to .c files only? .h files should be included.
> > +                   $realline == $checklicenseline)) {
What is the purpose of the above check?
> >                       if (ERROR("C99_COMMENTS",
> >                                 "do not use C99 // comments\n" . $herecurr) &&
> >                           $fix) {
>