summaryrefslogtreecommitdiff
path: root/Documentation/technical/api-directory-listing.txt
diff options
context:
space:
mode:
authorJameson Miller <jamill@microsoft.com>2017-10-30 17:21:39 (GMT)
committerJunio C Hamano <gitster@pobox.com>2017-10-31 02:54:21 (GMT)
commit1b2bc3912a183c88ccd70050a359a2b6bbacca7d (patch)
treeeff303f257c8debd6849cd1f57584f0583867365 /Documentation/technical/api-directory-listing.txt
parent07966ed19ed6936442bdb9cf40f315369e78bd0d (diff)
downloadgit-1b2bc3912a183c88ccd70050a359a2b6bbacca7d.zip
git-1b2bc3912a183c88ccd70050a359a2b6bbacca7d.tar.gz
git-1b2bc3912a183c88ccd70050a359a2b6bbacca7d.tar.bz2
status: document options to show matching ignored files
Signed-off-by: Jameson Miller <jamill@microsoft.com> 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.txt27
1 files changed, 23 insertions, 4 deletions
diff --git a/Documentation/technical/api-directory-listing.txt b/Documentation/technical/api-directory-listing.txt
index 6c77b49..7fae00f 100644
--- a/Documentation/technical/api-directory-listing.txt
+++ b/Documentation/technical/api-directory-listing.txt
@@ -22,16 +22,20 @@ The notable options are:
`flags`::
- A bit-field of options (the `*IGNORED*` flags are mutually exclusive):
+ A bit-field of options:
`DIR_SHOW_IGNORED`:::
- Return just ignored files in `entries[]`, not untracked files.
+ Return just ignored files in `entries[]`, not untracked
+ files. This flag is mutually exclusive with
+ `DIR_SHOW_IGNORED_TOO`.
`DIR_SHOW_IGNORED_TOO`:::
- Similar to `DIR_SHOW_IGNORED`, but return ignored files in `ignored[]`
- in addition to untracked files in `entries[]`.
+ Similar to `DIR_SHOW_IGNORED`, but return ignored files in
+ `ignored[]` in addition to untracked files in
+ `entries[]`. This flag is mutually exclusive with
+ `DIR_SHOW_IGNORED`.
`DIR_KEEP_UNTRACKED_CONTENTS`:::
@@ -39,6 +43,21 @@ The notable options are:
untracked contents of untracked directories are also returned in
`entries[]`.
+`DIR_SHOW_IGNORED_TOO_MODE_MATCHING`:::
+
+ Only has meaning if `DIR_SHOW_IGNORED_TOO` is also set; if
+ this is set, returns ignored files and directories that match
+ an exclude pattern. If a directory matches an exclude pattern,
+ then the directory is returned and the contained paths are
+ not. A directory that does not match an exclude pattern will
+ not be returned even if all of its contents are ignored. In
+ this case, the contents are returned as individual entries.
++
+If this is set, files and directories that explicity match an ignore
+pattern are reported. Implicity ignored directories (directories that
+do not match an ignore pattern, but whose contents are all ignored)
+are not reported, instead all of the contents are reported.
+
`DIR_COLLECT_IGNORED`:::
Special mode for git-add. Return ignored files in `ignored[]` and