linux-kernel-mentees.lists.linuxfoundation.org archive mirror
 help / color / mirror / Atom feed
From: Aditya <yashsri421@gmail.com>
To: Lukas Bulwahn <lukas.bulwahn@gmail.com>,
	Dwaipayan Ray <dwaipayanray1@gmail.com>
Cc: linux-kernel-mentees@lists.linuxfoundation.org
Subject: Re: [Linux-kernel-mentees] [PATCH v2] checkpatch: fix missing whitespace in formatted email
Date: Wed, 14 Oct 2020 22:33:48 +0530	[thread overview]
Message-ID: <ebc09f62-7ba3-0965-e999-0ca33156f40f@gmail.com> (raw)
In-Reply-To: <alpine.DEB.2.21.2010130811050.14590@felia>


On 13/10/20 11:46 am, Lukas Bulwahn 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
>  
>> Signed-off-by: Dwaipayan Ray <dwaipayanray1@gmail.com>
>> ---
>>  scripts/checkpatch.pl | 4 +++-
>>  1 file changed, 3 insertions(+), 1 deletion(-)
>>
>> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
>> index fab38b493cef..f1a4e61917eb 100755
>> --- a/scripts/checkpatch.pl
>> +++ b/scripts/checkpatch.pl
>> @@ -1221,7 +1221,9 @@ sub format_email {
>>  	} else {
>>  		$formatted_email = "$name$name_comment <$address>";
>>  	}
>> -	$formatted_email .= "$comment";
>> +	if ("$comment" ne "") {
>> +		$formatted_email .= " $comment";
>> +	}
>>  	return $formatted_email;
>>  }
>>  
>> -- 
>> 2.27.0
>>
>>
Hi Sir

I have analyzed the reports using this patch and made comparison. The links are as follows:

1. completely before vs. after this patch: https://github.com/AdityaSrivast/kernel-tasks/blob/master/Task2/reports/analysis/relative_change/before_v_second/summary_relative.txt
2. after the first patch vs. after the two patches: https://github.com/AdityaSrivast/kernel-tasks/blob/master/Task2/reports/analysis/relative_change/first_v_second/summary_relative.txt

Kindly let me know if you have any questions.

Aditya

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

  parent reply	other threads:[~2020-10-14 17:04 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-10-13  6:07 [Linux-kernel-mentees] [PATCH v2] checkpatch: fix missing whitespace in formatted email Dwaipayan Ray
2020-10-13  6:16 ` Lukas Bulwahn
2020-10-13  6:20   ` Dwaipayan Ray
2020-10-13  6:29     ` Lukas Bulwahn
2020-10-14 17:03   ` Aditya [this message]
2020-10-17  5:38     ` Aditya
2020-10-18  7:43       ` Lukas Bulwahn
2020-10-19  9:26         ` Aditya
2020-10-19 10:42           ` Lukas Bulwahn
2020-10-13  6:36 Dwaipayan Ray
2020-10-13  6:57 ` Joe Perches
2020-10-13  7:35   ` Dwaipayan Ray

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=ebc09f62-7ba3-0965-e999-0ca33156f40f@gmail.com \
    --to=yashsri421@gmail.com \
    --cc=dwaipayanray1@gmail.com \
    --cc=linux-kernel-mentees@lists.linuxfoundation.org \
    --cc=lukas.bulwahn@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).