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

Aditya yashsri421 at gmail.com
Wed Oct 14 17:03:48 UTC 2020


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 at 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 at aculab.com (big endian
>> system concerns)' might be better as 'David.Laight at 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 at 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



More information about the Linux-kernel-mentees mailing list