Merge branch 'mk/complete-tcsh'
[gitweb.git] / Documentation / technical / api-directory-listing.txt
index add6f435b59e3df095e507d8a5d4f911cee9d3b2..944fc39fac8b26ceaee781fe4a18b9ba2d78ac9d 100644 (file)
@@ -9,37 +9,40 @@ Data structure
 --------------
 
 `struct dir_struct` structure is used to pass directory traversal
-options to the library and to record the paths discovered.  The notable
-options are:
+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`).
 
-`collect_ignored`::
+`flags`::
 
-       Include paths that are to be excluded in the result.
+       A bit-field of options:
 
-`show_ignored`::
+`DIR_SHOW_IGNORED`:::
 
        The traversal is for finding just ignored files, not unignored
        files.
 
-`show_other_directories`::
+`DIR_SHOW_OTHER_DIRECTORIES`:::
 
        Include a directory that is not tracked.
 
-`hide_empty_directories`::
+`DIR_HIDE_EMPTY_DIRECTORIES`:::
 
        Do not include a directory that is not tracked and is empty.
 
-`no_gitlinks`::
+`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::
+The result of the enumeration is left in these fields:
 
 `entries[]`::