unpack-trees: rename 'is_excluded_from_list()'
The first consumer of pattern-matching filenames was the .gitignore feature. In that context, storing a list of patterns as a 'struct exclude_list' makes sense. However, the sparse-checkout feature then adopted these structures and methods, but with the opposite meaning: these patterns match the files that should be included! Now that this library is renamed to use 'struct pattern_list' and 'struct pattern', we can now rename the method used by the sparse-checkout feature to determine which paths should appear in the working directory. The method is_excluded_from_list() is only used by the sparse-checkout logic in unpack-trees and list-objects-filter. The confusing part is that it returned 1 for "excluded" (i.e. it matches the list of exclusions) but that really manes that the path matched the list of patterns for _inclusion_ in the working directory. Rename the method to be path_matches_pattern_list() and have it return an explicit 'enum pattern_match_result'. Here, the values MATCHED = 1, UNMATCHED = 0, and UNDECIDED = -1 agree with the previous integer values. This shift allows future consumers to better understand what the retur values mean, and provides more type checking for handling those values. Signed-off-by: Derrick Stolee <dstolee@microsoft.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:

committed by
Junio C Hamano

parent
65edd96aec
commit
468ce99b77
21
dir.h
21
dir.h
@ -230,10 +230,23 @@ int read_directory(struct dir_struct *, struct index_state *istate,
|
||||
const char *path, int len,
|
||||
const struct pathspec *pathspec);
|
||||
|
||||
int is_excluded_from_list(const char *pathname, int pathlen,
|
||||
const char *basename, int *dtype,
|
||||
struct pattern_list *pl,
|
||||
struct index_state *istate);
|
||||
enum pattern_match_result {
|
||||
UNDECIDED = -1,
|
||||
NOT_MATCHED = 0,
|
||||
MATCHED = 1,
|
||||
};
|
||||
|
||||
/*
|
||||
* Scan the list of patterns to determine if the ordered list
|
||||
* of patterns matches on 'pathname'.
|
||||
*
|
||||
* Return 1 for a match, 0 for not matched and -1 for undecided.
|
||||
*/
|
||||
enum pattern_match_result path_matches_pattern_list(const char *pathname,
|
||||
int pathlen,
|
||||
const char *basename, int *dtype,
|
||||
struct pattern_list *pl,
|
||||
struct index_state *istate);
|
||||
struct dir_entry *dir_add_ignored(struct dir_struct *dir,
|
||||
struct index_state *istate,
|
||||
const char *pathname, int len);
|
||||
|
Reference in New Issue
Block a user