diff options
author | Elijah Newren <newren@gmail.com> | 2020-04-01 04:17:45 +0000 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2020-04-01 11:11:31 -0700 |
commit | 95c11ecc73f286e0a95d9591ae98f1221efe4633 (patch) | |
tree | 3882ec56f0d1640730cd0cfebe3b239b4322940c /Documentation/RelNotes/2.3.9.txt | |
parent | dir: replace double pathspec matching with single in treat_directory() (diff) | |
download | tgif-95c11ecc73f286e0a95d9591ae98f1221efe4633.tar.xz |
Fix error-prone fill_directory() API; make it only return matches
Traditionally, the expected calling convention for the dir.c API was:
fill_directory(&dir, ..., pathspec)
foreach entry in dir->entries:
if (dir_path_match(entry, pathspec))
process_or_display(entry)
This may have made sense once upon a time, because the fill_directory() call
could use cheap checks to avoid doing full pathspec matching, and an external
caller may have wanted to do other post-processing of the results anyway.
However:
* this structure makes it easy for users of the API to get it wrong
* this structure actually makes it harder to understand
fill_directory() and the functions it uses internally. It has
tripped me up several times while trying to fix bugs and
restructure things.
* relying on post-filtering was already found to produce wrong
results; pathspec matching had to be added internally for multiple
cases in order to get the right results (see commits 404ebceda01c
(dir: also check directories for matching pathspecs, 2019-09-17)
and 89a1f4aaf765 (dir: if our pathspec might match files under a
dir, recurse into it, 2019-09-17))
* it's bad for performance: fill_directory() already has to do lots
of checks and knows the subset of cases where it still needs to do
more checks. Forcing external callers to do full pathspec
matching means they must re-check _every_ path.
So, add the pathspec matching within the fill_directory() internals, and
remove it from external callers.
Signed-off-by: Elijah Newren <newren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/RelNotes/2.3.9.txt')
0 files changed, 0 insertions, 0 deletions