dir
: fix treatment of negated pathspecs
Reported-by: John Millikin
Signed-off-by: Elijah Newren
do_match_pathspec()
started life as match_pathspec_depth_1()
and for correctness was only supposed to be called from match_pathspec_depth()
. match_pathspec_depth()
was later renamed to match_pathspec()
, so the invariant we expect today is that do_match_pathspec()
has no direct callers outside of match_pathspec()
.
Unfortunately, this intention was lost with the renames of the two functions, and additional calls to do_match_pathspec()
were added in commits
- 75a6315f74 ("
ls-files
: add pathspec matching for submodules", 2016-10-07, Git v2.11.0-rc0 -- merge listed in batch #11)
- 89a1f4aaf7 ("
dir
: if our pathspec might match files under a dir, recurse into it", 2019-09-17, Git v2.24.0-rc0).
Of course, do_match_pathspec()
had an important advantge over match_pathspec()
-- match_pathspec()
would hardcode flags to one of two values, and these new callers needed to pass some other value for flags.
Also, although calling do_match_pathspec()
directly was incorrect, there likely wasn't any difference in the observable end output, because the bug just meant that fill_diretory()
would recurse into unneeded directories.
Since subsequent does-this-path-match checks on individual paths under the directory would cause those extra paths to be filtered out, the only difference from using the wrong function was unnecessary computation.
The second of those bad calls to do_match_pathspec()
was involved -- via either direct movement or via copying+editing -- into a number of later refactors.
See commits
- 777b420347 ("
dir
: synchronize treat_leading_path()
and read_directory_recursive()
", 2019-12-19, Git v2.25.0-rc0 -- merge)
- 8d92fb2927 ("
dir
: replace exponential algorithm with a linear one", 2020-04-01, Git v2.27.0-rc0 -- merge listed in batch #5)
- 95c11ecc73 ("Fix error-prone
fill_directory()
API; make it only return matches", 2020-04-01, Git v2.27.0-rc0 -- merge listed in batch #5)
The last of those introduced the usage of do_match_pathspec()
on an individual file, and thus resulted in individual paths being returned that shouldn't be.
The problem with calling do_match_pathspec()
instead of match_pathspec()
is that any negated patterns such as :!unwanted_path
will be ignored.
Add a new match_pathspec_with_flags()
function to fulfill the needs of specifying special flags while still correctly checking negated patterns, add a big comment above do_match_pathspec()
to prevent others from misusing it, and correct current callers of do_match_pathspec()
to instead use either match_pathspec()
or match_pathspec_with_flags()
.
One final note is that DO_MATCH_LEADING_PATHSPEC
needs special consideration when working with DO_MATCH_EXCLUDE
.
The point of DO_MATCH_LEADING_PATHSPEC
is that if we have a pathspec like
*/Makefile
and we are checking a directory path like
src/module/component
that we want to consider it a match so that we recurse into the directory because it might have a file named Makefile
somewhere below.
However, when we are using an exclusion pattern, i.e. we have a pathspec like
:(exclude)*/Makefile
we do NOT want to say that a directory path like
src/module/component
is a (negative) match.
While there might be a file named Makefile
somewhere below that directory, there could also be other files and we cannot pre-emptively rule all the files under that directory out; we need to recurse and then check individual files.
Adjust the DO_MATCH_LEADING_PATHSPEC
logic to only get activated for positive pathspecs.
!f() { git log ... | path/to/filter-log.pl "$@" | git log --stdin --no-walk; f
,甚至将管道部分包装到脚本中。 - Cascabelfind
来过滤掉我不想看到的目录的提交。如果我想忽略对根级目录SiteConfig
进行的提交的日志条目,那么我会这样说:git log \
find . -type d -mindepth 1 -maxdepth 1 ! -name *SiteConfig`` - Noah Sussmangit log --oneline --format=%s -- . ":!sub"
将会工作(使用 **路径规范魔法:(exclude)
及其简写形式:!
**)。 - VonC