Messages in this thread | | | Subject | Re: [PATCH] checkpatch: use $root/.git when seeding camel case | From | Jacob Keller <> | Date | Mon, 22 Jun 2020 16:56:08 -0700 |
| |
On 6/22/2020 3:11 PM, Joe Perches wrote: > On Mon, 2020-06-22 at 14:58 -0700, Jacob Keller wrote: >> When seeding the camel case file, checkpatch.pl uses the $root directory >> in order to find the acceptable list of allowed camel case words. >> >> However, if the current directory is a git repository, checkpatch.pl >> attempts to seed using the local git directory. >> >> This is problematic if checkpatch.pl is passed a --root and is being run >> from within another git repository. Rather than seeding from the >> provided root tree, checkpatch.pl will seed using the local files. If >> the current git repository isn't a kernel tree, this can lead to >> unexpected warnings about camel case issues. >> >> Always honor the $root parameter when seeding camelcase files by using >> "$root/.git" and changing directory to the $root before invoking git. > [] >> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl > [] >> @@ -919,8 +919,8 @@ sub seed_camelcase_includes { >> >> $camelcase_seeded = 1; >> >> - if (-e ".git") { >> - my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`; >> + if (-e "$root/.git") { >> + my $git_last_include_commit = `cd $root && ${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`; >> chomp $git_last_include_commit; >> $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; >> } else { >> @@ -947,9 +947,10 @@ sub seed_camelcase_includes { >> return; >> } >> >> - if (-e ".git") { >> - $files = `${git_command} ls-files "include/*.h"`; >> + if (-e "$root/.git") { >> + $files = `cd $root && ${git_command} ls-files "include/*.h"`; >> @include_files = split('\n', $files); >> + @include_files = map("$root/$_", @include_files); >> } >> >> foreach my $file (@include_files) { > > checkpatch has 4 uses of ${git_command} > > Maybe git_command should be changed instead. > So, in part, I'm not 100% sure. In our use case, it depends on what git is being used for.
Something like "checkpatch.pl -g HEAD", we would like to target the local repository. Where as camelcase, we'd like to target the --root repository.
What if, instead of this, we opt to use the local .git for camelcase only when $root is non-empty? That way, if --root is applied, camcel case seeding always uses --root, rather than the local tree.
Something like:
if (-e ".git" && $root eq "") for this block, so then we fall through to the non-git style instead?
> I wonder how this interacts with the GIT_DIR environment variable. >
Probably poorly. I suspect it would end up looking at GIT_DIR instead of $root/.git, despite the cd.
Thanks, Jake
| |