linux-kernel - [RFC PATCH] checkpatch: Warn on patch subjects with "checkpatch"

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <1407861421.3141.21.camel@joe-AO725>
Date:	Tue, 12 Aug 2014 09:37:01 -0700
From:	Joe Perches <joe@...ches.com>
To:	Andrew Morton <akpm@...ux-foundation.org>
Cc:	gregkh@...uxfoundation.org, swetland@...gle.com,
	ccross@...roid.com, linux-kernel@...r.kernel.org,
	devel@...verdev.osuosl.org, Phong Tran <tranmanphong@...il.com>
Subject: [RFC PATCH] checkpatch: Warn on patch subjects with "checkpatch"

I think patch subject lines with "checkpatch" in
them are almost never really useful.

Maybe a new checkpatch test to see if a subject line
is perhaps less than informational should be added.

Something like:
---
 scripts/checkpatch.pl | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 31a731e..a690515 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -2048,6 +2048,13 @@ sub process {
 			$in_commit_log = 0;
 		}
 
+# Check patch subject lines for "checkpatch" (but not checkpatch:)
+		if ($in_header_lines &&
+		    $line =~ /^\s*subject:.*\bcheckpatch(?!(?:\.pl)?:)\b/i) {
+			WARN("BAD_PATCH_SUBJECT",
+			     "Patch subjects with 'checkpatch' are not generally useful.  Describe the change, not the tool that suggests the change.\n" . $herecurr);
+		}
+
 # Check signature styles
 		if (!$in_header_lines &&
 		    $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {


--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/