Merge commit 'refs/top-bases/master'
[git/gitweb.git] / Documentation / technical / api-directory-listing.txt
blob5bbd18f0206604416c3833b7541a5b55b7e63976
1 directory listing API
2 =====================
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.
8 Data structure
9 --------------
11 `struct dir_struct` structure is used to pass directory traversal
12 options to the library and to record the paths discovered.  The notable
13 options are:
15 `exclude_per_dir`::
17         The name of the file to be read in each directory for excluded
18         files (typically `.gitignore`).
20 `collect_ignored`::
22         Include paths that are to be excluded in the result.
24 `show_ignored`::
26         The traversal is for finding just ignored files, not unignored
27         files.
29 `show_other_directories`::
31         Include a directory that is not tracked.
33 `hide_empty_directories`::
35         Do not include a directory that is not tracked and is empty.
37 `no_gitlinks`::
39         If set, recurse into a directory that looks like a git
40         directory.  Otherwise it is shown as a directory.
42 The result of the enumeration is left in these fields::
44 `entries[]`::
46         An array of `struct dir_entry`, each element of which describes
47         a path.
49 `nr`::
51         The number of members in `entries[]` array.
53 `alloc`::
55         Internal use; keeps track of allocation of `entries[]` array.
58 Calling sequence
59 ----------------
61 * Prepare `struct dir_struct dir` and clear it with `memset(&dir, 0,
62   sizeof(dir))`.
64 * Call `add_exclude()` to add single exclude pattern,
65   `add_excludes_from_file()` to add patterns from a file
66   (e.g. `.git/info/exclude`), and/or set `dir.exclude_per_dir`.  A
67   short-hand function `setup_standard_excludes()` can be used to set up
68   the standard set of exclude settings.
70 * Set options described in the Data Structure section above.
72 * Call `read_directory()`.
74 * Use `dir.entries[]`.
76 (JC)