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: <20210605191754.28165-1-dwaipayanray1@gmail.com>
 <0c0bdfa2c0c1f2c7ebdcbe7d4a1366c1697ce57a.camel@perches.com> <CAKXUXMyoiEaYaqK9PX3PnUDV94RnVc_A4d6W7JkPOdr_1RCF2g@mail.gmail.com>
In-Reply-To: <CAKXUXMyoiEaYaqK9PX3PnUDV94RnVc_A4d6W7JkPOdr_1RCF2g@mail.gmail.com>
From:   Dwaipayan Ray <dwaipayanray1@gmail.com>
Date:   Mon, 7 Jun 2021 11:23:13 +0530
Message-ID: <CABJPP5A0ZvbWH8rwR_YwF61ZBKGFef-kLBHKH5r5O=mLdiHZSA@mail.gmail.com>
Subject: Re: [PATCH] checkpatch: do not allow using -f/--file option without a filename
To:     Lukas Bulwahn <lukas.bulwahn@gmail.com>
Cc:     Joe Perches <joe@perches.com>,
        Andrew Morton <akpm@linux-foundation.org>,
        Linux Kernel Mailing List <linux-kernel@vger.kernel.org>
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

On Mon, Jun 7, 2021 at 10:41 AM Lukas Bulwahn <lukas.bulwahn@gmail.com> wrote:
>
> On Sat, Jun 5, 2021 at 9:32 PM Joe Perches <joe@perches.com> wrote:
> >
> > On Sun, 2021-06-06 at 00:47 +0530, Dwaipayan Ray wrote:
> > > When checkpatch is run without a filename, it reads from stdin.
> > > But if --file option is used along with that, it may generate
>
> But if the --file option is used...
>
> > > false positives.
> > >
> > > Consider the following test file:
> > > $cat test.c
> > > int x = a - b;
> > >
> > > $cat test.c | ./scripts/checkpatch.pl -f
> > > WARNING: It's generally not useful to have the filename in the file
> > > +int x = a - b;
> > >
> > > This is a false positive and occurs because $realfile is set to "-".
> > > Also since checkpatch relies on the file's extension to run specific
> > > checks for c files, assembly files, etc, most of the checks are
> > > not run as well.
> > >
> > > So it is better to disable -f/--file option when checkpatch is
> > > run without a filename.
> >
> > That's a reasonable commit message, thanks.
> >
>
> That can be shortened to:
>
> Disable -f/--file option when checkpatch is run without a filename.
>
> How about adding a description in the checkpatch Documentation on this
> topic as well, as part of this patch?
>

I can also add it to the next batch of the documentation updates I am
working on. That can list all the flag combinations that's not
allowed. And we can let this patch go independently for now...

Thanks,
Dwaipayan.