mirror of
https://github.com/git/git
synced 2024-08-25 02:35:46 +00:00
0aaf62b6e0
'git-status --ignored' still scans the work tree twice to collect untracked and ignored files, respectively. fill_directory / read_directory already supports collecting untracked and ignored files in a single directory scan. However, the DIR_COLLECT_IGNORED flag to enable this has some git-add specific side-effects (e.g. it doesn't recurse into ignored directories, so listing ignored files with --untracked=all doesn't work). The DIR_SHOW_IGNORED flag doesn't list untracked files and returns ignored files in dir_struct.entries[] (instead of dir_struct.ignored[] as DIR_COLLECT_IGNORED). DIR_SHOW_IGNORED is used all throughout git. We don't want to break the existing API, so lets introduce a new flag DIR_SHOW_IGNORED_TOO that lists untracked as well as ignored files similar to DIR_COLLECT_FILES, but will recurse into sub-directories based on the other flags as DIR_SHOW_IGNORED does. In dir.c::read_directory_recursive, add ignored files to either dir_struct.entries[] or dir_struct.ignored[] based on the flags. Also move the DIR_COLLECT_IGNORED case here so that filling result lists is in a common place. In wt-status.c::wt_status_collect_untracked, use the new flag and read results from dir_struct.ignored[]. Remove the extra fill_directory call. builtin/check-ignore.c doesn't call fill_directory, setting the git-add specific DIR_COLLECT_IGNORED flag has no effect here. Remove for clarity. Update API documentation to reflect the changes. Performance: with this patch, 'git-status --ignored' is typically as fast as 'git-status'. Signed-off-by: Karsten Blees <blees@dcon.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
106 lines
2.7 KiB
Plaintext
106 lines
2.7 KiB
Plaintext
directory listing API
|
|
=====================
|
|
|
|
The directory listing API is used to enumerate paths in the work tree,
|
|
optionally taking `.git/info/exclude` and `.gitignore` files per
|
|
directory into account.
|
|
|
|
Data structure
|
|
--------------
|
|
|
|
`struct dir_struct` structure is used to pass directory traversal
|
|
options to the library and to record the paths discovered. A single
|
|
`struct dir_struct` is used regardless of whether or not the traversal
|
|
recursively descends into subdirectories.
|
|
|
|
The notable options are:
|
|
|
|
`exclude_per_dir`::
|
|
|
|
The name of the file to be read in each directory for excluded
|
|
files (typically `.gitignore`).
|
|
|
|
`flags`::
|
|
|
|
A bit-field of options (the `*IGNORED*` flags are mutually exclusive):
|
|
|
|
`DIR_SHOW_IGNORED`:::
|
|
|
|
Return just ignored files in `entries[]`, not untracked files.
|
|
|
|
`DIR_SHOW_IGNORED_TOO`:::
|
|
|
|
Similar to `DIR_SHOW_IGNORED`, but return ignored files in `ignored[]`
|
|
in addition to untracked files in `entries[]`.
|
|
|
|
`DIR_COLLECT_IGNORED`:::
|
|
|
|
Special mode for git-add. Return ignored files in `ignored[]` and
|
|
untracked files in `entries[]`. Only returns ignored files that match
|
|
pathspec exactly (no wildcards). Does not recurse into ignored
|
|
directories.
|
|
|
|
`DIR_SHOW_OTHER_DIRECTORIES`:::
|
|
|
|
Include a directory that is not tracked.
|
|
|
|
`DIR_HIDE_EMPTY_DIRECTORIES`:::
|
|
|
|
Do not include a directory that is not tracked and is empty.
|
|
|
|
`DIR_NO_GITLINKS`:::
|
|
|
|
If set, recurse into a directory that looks like a Git
|
|
directory. Otherwise it is shown as a directory.
|
|
|
|
The result of the enumeration is left in these fields:
|
|
|
|
`entries[]`::
|
|
|
|
An array of `struct dir_entry`, each element of which describes
|
|
a path.
|
|
|
|
`nr`::
|
|
|
|
The number of members in `entries[]` array.
|
|
|
|
`alloc`::
|
|
|
|
Internal use; keeps track of allocation of `entries[]` array.
|
|
|
|
`ignored[]`::
|
|
|
|
An array of `struct dir_entry`, used for ignored paths with the
|
|
`DIR_SHOW_IGNORED_TOO` and `DIR_COLLECT_IGNORED` flags.
|
|
|
|
`ignored_nr`::
|
|
|
|
The number of members in `ignored[]` array.
|
|
|
|
Calling sequence
|
|
----------------
|
|
|
|
Note: index may be looked at for .gitignore files that are CE_SKIP_WORKTREE
|
|
marked. If you to exclude files, make sure you have loaded index first.
|
|
|
|
* Prepare `struct dir_struct dir` and clear it with `memset(&dir, 0,
|
|
sizeof(dir))`.
|
|
|
|
* To add single exclude pattern, call `add_exclude_list()` and then
|
|
`add_exclude()`.
|
|
|
|
* To add patterns from a file (e.g. `.git/info/exclude`), call
|
|
`add_excludes_from_file()` , and/or set `dir.exclude_per_dir`. A
|
|
short-hand function `setup_standard_excludes()` can be used to set
|
|
up the standard set of exclude settings.
|
|
|
|
* Set options described in the Data Structure section above.
|
|
|
|
* Call `read_directory()`.
|
|
|
|
* Use `dir.entries[]`.
|
|
|
|
* Call `clear_directory()` when none of the contained elements are no longer in use.
|
|
|
|
(JC)
|