Received-SPF: pass (google.com: domain of linux-kernel+bounces-79014-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) client-ip=147.75.80.249;
Precedence: bulk
MIME-Version: 1.0
References: <20240222051539.3001988-3-saravanak@google.com>
 <20240222051539.3001988-4-saravanak@google.com> <ffec7c7b8eb86f573e420e0582075ba1e75d0e54.camel@perches.com>
 <CAGETcx-mNt+_ST0opQ=_M1ZJK1acf8Rr0VqaAUskyig5YwL_dw@mail.gmail.com>
 <e51c5e6fe02bcc5a487cae063fe8f440013d0ca9.camel@perches.com> <CAGETcx8rANkOHhay6iFoXtXtJ8KvoNQBAMpruGENys+L2uHQTQ@mail.gmail.com>
In-Reply-To: <CAGETcx8rANkOHhay6iFoXtXtJ8KvoNQBAMpruGENys+L2uHQTQ@mail.gmail.com>
From: Lukas Bulwahn <lukas.bulwahn@gmail.com>
Date: Fri, 23 Feb 2024 20:05:39 +0100
Message-ID: <CAKXUXMzhpRMmroT9tprvtbFfiv_phpY7iPrE3r4CVuqGzLfeBA@mail.gmail.com>
Subject: Re: [PATCH 2/2] checkpatch: Don't check for unified diff format in
 git sendemail headers
To: Saravana Kannan <saravanak@google.com>
Cc: Joe Perches <joe@perches.com>, Andy Whitcroft <apw@canonical.com>, 
	Dwaipayan Ray <dwaipayanray1@gmail.com>, kernel-team@android.com, 
	linux-kernel@vger.kernel.org
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

On Fri, Feb 23, 2024 at 2:10=E2=80=AFAM Saravana Kannan <saravanak@google.c=
om> wrote:
>
> On Thu, Feb 22, 2024 at 5:01=E2=80=AFPM Joe Perches <joe@perches.com> wro=
te:
> >
> > On Thu, 2024-02-22 at 16:45 -0800, Saravana Kannan wrote:
> > > On Thu, Feb 22, 2024 at 12:54=E2=80=AFAM Joe Perches <joe@perches.com=
> wrote:
> > > >
> > > > On Wed, 2024-02-21 at 21:15 -0800, Saravana Kannan wrote:
> > > > > When checkpatch is used as a git sendemail-validate hook, it's al=
so passed
> > > > > in the email header for sanity check.
> > > >
> > > > Why?
> > > >
> > > > If so, why not use a front-end script to stop/remove
> > > > the file from being scanned by checkpatch?
> > >
> > > Sure, I could do that. But this also makes it easier for people to
> > > start using checkpatch. Or I can put up a git hook wrapper script in
> > > here for people to symlink into their .git/hooks that does this.
> > >
> > > I'd prefer the lazy route of not creating a 1 line wrapper script :)
> >
> > I'd not.  checkpatch is for _patches_.
> > Don't feed stuff to it that isn't patches and expect good results.
>
> Would you be open to being a maintainer if I add a git hook
> sendemail-validate wrapper? It feels silly to add myself as a
> maintainer for a 1-line script. I'd rather give it to you :)
>

I agree with Joe's shrug. We got enough scripts, where very few
(actually: probably nobody) know what they are good for.

However, Saravana, if it helps you, feel free to add a section in the
checkpatch documentation where you describe which workflow you have
and in which files you need to set up what.
So, in case you forget, you will find it in the documentation and
possibly it is also helpful to others---if they read the
documentation, or some AI bot reads the documentation in the future
and then suggests it to someone asking that AI bot---well, that is our
brave new world nowadays...

I will maintain that section in the checkpatch documentation for you,
if you submit the documentation change as a proper patch.

Lukas