checkpatch: try to avoid poor patch subject lines

JoePerches · torvalds · commit a2fe16b9d878 · 2015-02-13T21:21:40.000-08:00
Naming the tool that found an issue in the subject line isn't very useful.
 Emit a warning when a common tool (currently checkpatch, sparse or
smatch) is in the subject line.

Signed-off-by: Joe Perches &lt;joe@perches.com&gt;
Suggested-by: Al Viro &lt;viro@ZenIV.linux.org.uk&gt;
Acked-by: Dan Carpenter &lt;dan.carpenter@oracle.com&gt;
Acked-by: Greg Kroah-Hartman &lt;gregkh@linuxfoundation.org&gt;
Signed-off-by: Andrew Morton &lt;akpm@linux-foundation.org&gt;
Signed-off-by: Linus Torvalds &lt;torvalds@linux-foundation.org&gt;
diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
@@ -2170,6 +2170,13 @@ sub process {
 			}
 		}
 
+# Check email subject for common tools that don't need to be mentioned
+		if ($in_header_lines &&
+		    $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
+			WARN("EMAIL_SUBJECT",
+			     "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
+		}
+
 # Check for old stable address
 		if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
 			ERROR("STABLE_ADDRESS",

Original file line number	Diff line number	Diff line change
`@@ -2170,6 +2170,13 @@ sub process {`
`2170`	`2170`	`}`
`2171`	`2171`	`}`
`2172`	`2172`
	`2173`	`+# Check email subject for common tools that don't need to be mentioned`
	`2174`	`+ if ($in_header_lines &&`
	`2175`	`+ $line =~ /^Subject:.*\b(?:checkpatch\|sparse\|smatch)\b[^:]/i) {`
	`2176`	`+ WARN("EMAIL_SUBJECT",`
	`2177`	`+ "A patch subject line should describe the change not the tool that found it\n" . $herecurr);`
	`2178`	`+ }`
	`2179`	`+`
`2173`	`2180`	`# Check for old stable address`
`2174`	`2181`	`if ($line =~ /^\scc:\s.<?\bstable\@kernel\.org\b>?.$/i) {`
`2175`	`2182`	`ERROR("STABLE_ADDRESS",`