2019-03-15 01:03:31

by Jacob Keller

[permalink] [raw]
Subject: [PATCH] checkpatch: fix camel case seeding when run with --root

checkpatch.pl avoids warning about camel case of some definitions by
seeding a file that tracks all of the currently committed camel case
definitions.

To build this seed file, checkpatch.pl decides between using git or the
--root parameter.

This works as long as you don't run checkpatch.pl from within
a different git tree that is not the Linux kernel.

In this case, the check for ".git" will return true, and checkpatch will
attempt to seed a camel case file using the current directory. This
works fine if --root is not provided, but can result in an incorrect
camel case seed file resulting in false positive warnings.

Fix this by checking for $root/.git instead, so that we use the --root
parameter properly when seeding the camel case list.

Additionally, when generating the list of files to be checked, prefix
the $root path so that the correct file will be found.

These changes allow checkpatch.pl to honor the --root parameter even if
being run from within another git repository.

Signed-off-by: Jacob Keller <[email protected]>
---

I sent this a long time ago, https://patchwork.ozlabs.org/patch/663831/ but
it was never noticed or reviewed.

I thought I'd dredge it back up and write a better description of the
problem and the fix.

scripts/checkpatch.pl | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index d0001fd1112d..358add495e18 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -903,8 +903,8 @@ sub seed_camelcase_includes {

$camelcase_seeded = 1;

- if (-e ".git") {
- my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
+ if (-e "$root/.git") {
+ my $git_last_include_commit = `cd $root && git log --no-merges --pretty=format:"%h%n" -1 -- include`;
chomp $git_last_include_commit;
$camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
} else {
@@ -931,9 +931,10 @@ sub seed_camelcase_includes {
return;
}

- if (-e ".git") {
- $files = `git ls-files "include/*.h"`;
+ if (-e "$root/.git") {
+ $files = `cd $root && git ls-files "include/*.h"`;
@include_files = split('\n', $files);
+ @include_files = map("$root/$_", @include_files);
}

foreach my $file (@include_files) {
--
2.18.0.219.gaf81d287a9da