[PATCH] checkpatch: warn on found Change-Id lines

From: Olof Johansson
Date: Mon Oct 10 2011 - 01:57:10 EST


Some external projects use repo, which uses a special-format Change-Id
field in the commit message for some internal bookkeeping (to re-associate
patches back to review entries, etc). Sometimes they sneak into patches
going upstream, which is embarrassing for the developer, and annoying
for the maintainer.

Add checking for these to checkpatch, to catch them before
posting. Provide a way to disable the check to keep checkpatch useful
for intra-project use.

Signed-off-by: Olof Johansson <olof@xxxxxxxxx>
---

scripts/checkpatch.pl | 8 ++++++++
1 files changed, 8 insertions(+), 0 deletions(-)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 3dfc471..bac1c93 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -18,6 +18,7 @@ my $quiet = 0;
my $tree = 1;
my $chk_signoff = 1;
my $chk_patch = 1;
+my $chk_changeid = 1;
my $tst_only;
my $emacs = 0;
my $terse = 0;
@@ -45,6 +46,7 @@ Options:
-q, --quiet quiet
--no-tree run without a kernel tree
--no-signoff do not check for 'Signed-off-by' line
+ --no-change-id don't complain about 'Change-Id' lines
--patch treat FILE as patchfile (default)
--emacs emacs compile window format
--terse one line per report
@@ -99,6 +101,7 @@ GetOptions(
'q|quiet+' => \$quiet,
'tree!' => \$tree,
'signoff!' => \$chk_signoff,
+ 'change-id!' => \$chk_changeid,
'patch!' => \$chk_patch,
'emacs!' => \$emacs,
'terse!' => \$terse,
@@ -341,6 +344,7 @@ sub deparenthesize {
}

$chk_signoff = 0 if ($file);
+$chk_changeid = 0 if ($file);

my @dep_includes = ();
my @dep_functions = ();
@@ -1578,6 +1582,10 @@ sub process {
}
}
}
+# Check for Change-Id lines:
+ if ($line =~ /^\s*change-id:/i && $chk_changeid) {
+ ERROR("CHANGE_ID", "Found Change-Id line\n", $herecurr);
+ }

# Check for wrappage within a valid hunk of the file
if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
--
1.7.4.1

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