summaryrefslogtreecommitdiff
path: root/Documentation/technical/api-directory-listing.txt
blob: 6c77b4920c92a0b327fb88d2b461ec0d918ec99a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
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_KEEP_UNTRACKED_CONTENTS`:::
 
	Only has meaning if `DIR_SHOW_IGNORED_TOO` is also set; if this is set, the
	untracked contents of untracked directories are also returned 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)