Re: [Linux-kernel-mentees] [PATCH v2] checkpatch: fix missing whitespace in formatted email

From: Lukas Bulwahn <lukas.bulwahn@gmail.com>
To: Dwaipayan Ray <dwaipayanray1@gmail.com>
Cc: linux-kernel-mentees@lists.linuxfoundation.org,
	Aditya Srivastava <yashsri421@gmail.com>
Subject: Re: [Linux-kernel-mentees] [PATCH v2] checkpatch: fix missing whitespace in formatted email
Date: Tue, 13 Oct 2020 08:29:03 +0200 (CEST)	[thread overview]
Message-ID: <alpine.DEB.2.21.2010130824530.14590@felia> (raw)
In-Reply-To: <CABJPP5Ay1KHXYUzo1gkMrP9vmhX81g12L3ZQmPrec2ydujYxog@mail.gmail.com>

On Tue, 13 Oct 2020, Dwaipayan Ray wrote:

> On Tue, Oct 13, 2020 at 11:46 AM Lukas Bulwahn <lukas.bulwahn@gmail.com> wrote:
> >
> >
> >
> > On Tue, 13 Oct 2020, Dwaipayan Ray wrote:
> >
> > > Commit 0c01921e56f9 ("checkpatch: add new warnings to author signoff
> > > checks.") introduced new checks for author sign off. The format_email
> > > procedure was modified to add comment blocks to the formatted email. But
> > > no space was added between the email address and mail comment.
> > >
> > > This causes wrong email formatting in cases where the email is in the form
> > > "author@example.com (Comment block)". The space between the address and
> > > comment block is removed, which causes incorrect parsing of the
> > > formatted email.
> > >
> > > An evaluation on checkpatch brought up this case. For example,
> > > on commit 1129d31b55d5 ("ima: Fix ima digest hash table key calculation"),
> > > the following warning was reported:
> > >
> > > WARNING:BAD_SIGN_OFF: email address 'David.Laight@aculab.com (big endian
> > > system concerns)' might be better as 'David.Laight@aculab.com(big endian
> > > system concerns)'
> > >
> > > Add a single space in between the address and comment when the
> > > extracted comment is not empty.
> > >
> >
> > Dwaipayan, looks good to me.
> >
> > So, how about a 'Fixes:' tag?
> >
> > Aditya, can you rerun your evaluation with this fix patch applied on top?
> >
> > Then, we need a comparison for:
> > 1. completely before vs. after the two patches, and
> > 2. after the first patch vs. after the two patches (to see that the fix
> > works)
> >
> > More support on evaluation from others interested to become mentees are of
> > course welcome.
> >
> > Lukas
> 
> Sure I will add the tag.
> Do I send it to LKML after this or after more evaluation?
> I did run on some of the newly generated bad sign off warnings and
> they seem to be fixed.
>

Go send it out; we will run the evaluation just as sanity checking...

Remember that currently the merge window of the next release is ongoing;
so, Joe will probably review and ack, but Andrew Morton might only pick it 
up in a few weeks (after the hot phase of the merge window).

Maybe a fix will be picked up faster though. We will see.

Lukas
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees