[PATCH] git-check-ignore.txt: Clarify exit codes
- From
Florian Hassanen <florian.hassanen@gmail.com>
- Date
- Dec 11, 2014, 18:42 UTC
- Message-ID
- <1418323355-23935-1-git-send-email-florian.hassanen@gmail.com>
check-ignore disregards whether a path is matched by a positive or negative pattern. Thus for a file that is _not_ ignored, but is captured by negative pattern in .gitignore, the exit code is 0. The docs suggested otherwise.
Clarify docs to explain that only the match matters, not whether the path is actually ignored or not.
Signed-off-by: Florian Hassanen <florian.hassanen@gmail.com> --- Today when working with the check-ignore command, I misunderstood the docs into thinking, that I could use check-ignore's exit code to determine, whether a file is ignored or not - but this is not how the exit code works :( Here is a suggestion, on how to update the docs to describe the exit code's behavior more clearly.
Documentation/git-check-ignore.txt | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/Documentation/git-check-ignore.txt b/Documentation/git-check-ignore.txt index ee2e091..bdd8b7c 100644 --- a/Documentation/git-check-ignore.txt +++ b/Documentation/git-check-ignore.txt @@ -97,10 +97,11 @@ EXIT STATUS ----------- 0:: - One or more of the provided paths is ignored. + At least one of the provided paths matches some (possibly negative) + pattern. 1:: - None of the provided paths are ignored. + None of the provided paths match any pattern. 128:: A fatal error was encountered.
-- 2.1.3