Merge branch 'fg/submodule-non-ascii-path' into maint

diff --git a/Documentation/technical/api-directory-listing.txt b/Documentation/technical/api-directory-listing.txt
index 9d3e3527e4f2b149170352e35a2fae32670a3478..7f8e78d916c0b38ed6757aee6578a53cab30d9d0 100644 (file)
--- a/Documentation/technical/api-directory-listing.txt
+++ b/Documentation/technical/api-directory-listing.txt
@@ -22,12 +22,23 @@ The notable options are:
 
 `flags`::
 
-       A bit-field of options:
+       A bit-field of options (the `*IGNORED*` flags are mutually exclusive):
 
 `DIR_SHOW_IGNORED`:::
 
-       The traversal is for finding just ignored files, not unignored
-       files.
+       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_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`:::
 
@@ -39,7 +50,7 @@ The notable options are:
 
 `DIR_NO_GITLINKS`:::
 
-       If set, recurse into a directory that looks like a git
+       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:
@@ -57,6 +68,14 @@ The result of the enumeration is left in these fields:
 
        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
 ----------------