summaryrefslogtreecommitdiff
path: root/Documentation/git-check-ignore.txt
diff options
context:
space:
mode:
authorDave Williams <dave@opensourcesolutions.co.uk>2013-09-05 16:08:01 (GMT)
committerJunio C Hamano <gitster@pobox.com>2013-09-12 22:40:29 (GMT)
commit8231fa6ae1ef92be73bec5cf0a533a4d8b71d536 (patch)
treed3d67a885c9da97fbf313a14a728fe7e3367816b /Documentation/git-check-ignore.txt
parent57e4c1783f056ce2d50a732c0fccff2a1fe99563 (diff)
downloadgit-8231fa6ae1ef92be73bec5cf0a533a4d8b71d536.zip
git-8231fa6ae1ef92be73bec5cf0a533a4d8b71d536.tar.gz
git-8231fa6ae1ef92be73bec5cf0a533a4d8b71d536.tar.bz2
check-ignore: Add option to ignore index contents
check-ignore currently shows how .gitignore rules would treat untracked paths. Tracked paths do not generate useful output. This prevents debugging of why a path became tracked unexpectedly unless that path is first removed from the index with `git rm --cached <path>`. The option --no-index tells the command to bypass the check for the path being in the index and hence allows tracked paths to be checked too. Whilst this behaviour deviates from the characteristics of `git add` and `git status` its use case is unlikely to cause any user confusion. Test scripts are augmented to check this option against the standard ignores to ensure correct behaviour. Signed-off-by: Dave Williams <dave@opensourcesolutions.co.uk> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-check-ignore.txt')
-rw-r--r--Documentation/git-check-ignore.txt7
1 files changed, 7 insertions, 0 deletions
diff --git a/Documentation/git-check-ignore.txt b/Documentation/git-check-ignore.txt
index d2df487..ee2e091 100644
--- a/Documentation/git-check-ignore.txt
+++ b/Documentation/git-check-ignore.txt
@@ -45,6 +45,13 @@ OPTIONS
not be possible to distinguish between paths which match a
pattern and those which don't.
+--no-index::
+ Don't look in the index when undertaking the checks. This can
+ be used to debug why a path became tracked by e.g. `git add .`
+ and was not ignored by the rules as expected by the user or when
+ developing patterns including negation to match a path previously
+ added with `git add -f`.
+
OUTPUT
------