4 The directory listing API is used to enumerate paths in the work tree,
5 optionally taking `.git/info/exclude` and `.gitignore` files per
6 directory into account.
11 `struct dir_struct` structure is used to pass directory traversal
12 options to the library and to record the paths discovered. A single
13 `struct dir_struct` is used regardless of whether or not the traversal
14 recursively descends into subdirectories.
16 The notable options are:
20 The name of the file to be read in each directory for excluded
21 files (typically `.gitignore`).
25 A bit-field of options:
29 The traversal is for finding just ignored files, not unignored
32 `DIR_SHOW_OTHER_DIRECTORIES`:::
34 Include a directory that is not tracked.
36 `DIR_HIDE_EMPTY_DIRECTORIES`:::
38 Do not include a directory that is not tracked and is empty.
42 If set, recurse into a directory that looks like a git
43 directory. Otherwise it is shown as a directory.
45 The result of the enumeration is left in these fields:
49 An array of `struct dir_entry`, each element of which describes
54 The number of members in `entries[]` array.
58 Internal use; keeps track of allocation of `entries[]` array.
64 Note: index may be looked at for .gitignore files that are CE_SKIP_WORKTREE
65 marked. If you to exclude files, make sure you have loaded index first.
67 * Prepare `struct dir_struct dir` and clear it with `memset(&dir, 0,
70 * Call `add_exclude()` to add single exclude pattern,
71 `add_excludes_from_file()` to add patterns from a file
72 (e.g. `.git/info/exclude`), and/or set `dir.exclude_per_dir`. A
73 short-hand function `setup_standard_excludes()` can be used to set up
74 the standard set of exclude settings.
76 * Set options described in the Data Structure section above.
78 * Call `read_directory()`.
80 * Use `dir.entries[]`.