undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

dir: add a usage note to exclude_per_dir

Browse Source 
As evidenced by the fix a couple commits ago, places in the code using
exclude_per_dir are likely buggy and should be adapted to call
setup_standard_excludes() instead.  Unfortunately, the usage of
exclude_per_dir has been hardcoded into the arguments ls-files accepts,
so we cannot actually remove it.  Add a note that it is deprecated and
no other callers should use it directly.

Signed-off-by: Elijah Newren <newren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Elijah Newren 2023-02-27 15:28:11 +00:00 committed by Junio C Hamano
parent 5fdf285e62
commit 59e009bf15
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
dir.h
View File

@ -295,8 +295,12 @@ struct dir_struct {
struct untracked_cache *untracked;
/**
* The name of the file to be read in each directory for excluded files
* (typically `.gitignore`).
* Deprecated: ls-files is the only allowed caller; all other callers
* should leave this as NULL; it pre-dated the
* setup_standard_excludes() mechanism that replaces this.
*
* This field tracks the name of the file to be read in each directory
* for excluded files (typically `.gitignore`).
*/
const char *exclude_per_dir;