Skip to contentSkip to conversation

checkpatch: formatted email should have a whitespace separating address and comment

PATCH In review Dwaipayan Ray 2 participants 4 messages Oct 12, 2020 Checkpatch

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 checkpatch: formatted email should have a whitespace separating address and comment

commit 0c01921 ("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 email address and the mail comment.

This caused issues in some cases where the email was in the form of "[email protected] (Comment block)". The formatted email removed the space at the end of address.

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 '[email protected] (big endian system concerns)' might be better as '[email protected](big endian system concerns)'

Resolved this by adding a single space in between the address and comment when the extracted comment is not empty.

---
 scripts/checkpatch.pl | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
scripts/checkpatch.pl +3 -1
index 124ff9432b51..6000addf1af3 100755
@@ -1201,7 +1201,9 @@ sub format_email {
 	} else {
 		$formatted_email = "$name$name_comment <$address>";
 	}
-	$formatted_email .= "$comment";
+	if ("$comment" ne "") {
+		$formatted_email .= " $comment";
+	}
 	return $formatted_email;
 }
 
Signature · 6 lines
2.27.0

_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
#1 lore raw
Quoted 42 lines · Dwaipayan Ray

commit 0c01921 ("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 email address and the mail comment.

This caused issues in some cases where the email was in the form of "[email protected] (Comment block)". The formatted email removed the space at the end of address.

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 '[email protected] (big endian system concerns)' might be better as '[email protected](big endian system concerns)'

Resolved this by adding a single space in between the address and comment when the extracted comment is not empty.

---
 scripts/checkpatch.pl | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
scripts/checkpatch.pl +3 -2
index 124ff9432b51..6000addf1af3 100755
@@ -1201,7 +1201,9 @@ sub format_email {
        } else {
                $formatted_email = "$name$name_comment <$address>";
        }
-       $formatted_email .= "$comment";
+       if ("$comment" ne "") {
+               $formatted_email .= " $comment";
+       }
        return $formatted_email;
 }
 
--
Quoted 2 lines

2.27.0

Found this issue while looking through the checkpatch records.

Investigated this after looking into Aditya's summary at
https://lore.kernel.org/linux-kernel-mentees/[email protected]/
and definitely the space bug was affecting and causing some issues.

If it's alright, could I quickly send it over to Joe?

Thanks,
Dwaipayan.
_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees

#2 lore raw

The commit message header should be in imperative and it should be shorter. I think something up to sixty characters is preferred.

Lukas

Quoted 52 lines · Dwaipayan Ray
Quoted 6 lines · Dwaipayan Ray

commit 0c01921 ("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 email address and the mail comment.

Quoted 6 lines

This caused issues in some cases where the email was in the form of "[email protected] (Comment block)". The formatted email removed the space at the end of address.

An evaluation on checkpatch brought up this case. For example, on commit 1129d31b55d5 ("ima: Fix ima digest hash table key

calculation"),

Quoted 30 lines

the following warning was reported:

WARNING:BAD_SIGN_OFF: email address '[email protected] (big endian system concerns)' might be better as '[email protected](big endian system concerns)'

Resolved this by adding a single space in between the address and comment when the extracted comment is not empty.

---
 scripts/checkpatch.pl | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
scripts/checkpatch.pl +3 -2
index 124ff9432b51..6000addf1af3 100755
@@ -1201,7 +1201,9 @@ sub format_email {
        } else {
                $formatted_email = "$name$name_comment <$address>";
        }
-       $formatted_email .= "$comment";
+       if ("$comment" ne "") {
+               $formatted_email .= " $comment";
+       }
        return $formatted_email;
 }
 
--
Quoted 2 lines

2.27.0

Found this issue while looking through the checkpatch records.

Investigated this after looking into Aditya's summary at

Quoted 8 lines

https://lore.kernel.org/linux-kernel-mentees/[email protected]/
and definitely the space bug was affecting and causing some issues.

If it's alright, could I quickly send it over to Joe?

Thanks,
Dwaipayan.

_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees