summaryrefslogtreecommitdiff
path: root/Documentation/technical/api-directory-listing.txt
diff options
context:
space:
mode:
authorAdam Spiers <git@adamspiers.org>2012-12-27 02:32:21 (GMT)
committerJunio C Hamano <gitster@pobox.com>2012-12-28 20:07:45 (GMT)
commit95a68344afcaf229765921c70458ee76add342dc (patch)
tree7d70e44472e4f344214b6819d209c724e778fa4c /Documentation/technical/api-directory-listing.txt
parentf1a7082f2a05b6b187fad9c661e2c872f8b477f5 (diff)
downloadgit-95a68344afcaf229765921c70458ee76add342dc.zip
git-95a68344afcaf229765921c70458ee76add342dc.tar.gz
git-95a68344afcaf229765921c70458ee76add342dc.tar.bz2
Improve documentation and comments regarding directory traversal API
traversal API has a few potentially confusing properties. These comments clarify a few key aspects and will hopefully make it easier to understand for other newcomers in the future. Signed-off-by: Adam Spiers <git@adamspiers.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/technical/api-directory-listing.txt')
-rw-r--r--Documentation/technical/api-directory-listing.txt9
1 files changed, 6 insertions, 3 deletions
diff --git a/Documentation/technical/api-directory-listing.txt b/Documentation/technical/api-directory-listing.txt
index 0356d25..944fc39 100644
--- a/Documentation/technical/api-directory-listing.txt
+++ b/Documentation/technical/api-directory-listing.txt
@@ -9,8 +9,11 @@ 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`::
@@ -39,7 +42,7 @@ options are:
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[]`::