summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEdward Thomson <ethomson@edwardthomson.com>2018-07-16 11:18:13 +0100
committerGitHub <noreply@github.com>2018-07-16 11:18:13 +0100
commit99bb98c0e8abb97b1daa3aff0307b93ed9291c08 (patch)
treec7577afd9e5febe9fb2e63eed9f4317072f56cc4
parentee3baed1788f3e94ab6cfd550ee35667af764f45 (diff)
parent9cab93c0a01efd16297fb9beb29d9b059f8b5ff4 (diff)
downloadlibgit2-99bb98c0e8abb97b1daa3aff0307b93ed9291c08.tar.gz
Merge pull request #4722 from boogisha/path-is-ignored-git-analogy
ignore: improve `git_ignore_path_is_ignored` description Git analogy
-rw-r--r--include/git2/ignore.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/include/git2/ignore.h b/include/git2/ignore.h
index d0c1877a8..f5143f3ad 100644
--- a/include/git2/ignore.h
+++ b/include/git2/ignore.h
@@ -59,8 +59,8 @@ GIT_EXTERN(int) git_ignore_clear_internal_rules(
* given file. This indicates if the file would be ignored regardless of
* whether the file is already in the index or committed to the repository.
*
- * One way to think of this is if you were to do "git add ." on the
- * directory containing the file, would it be added or not?
+ * One way to think of this is if you were to do "git check-ignore --no-index"
+ * on the given file, would it be shown or not?
*
* @param ignored boolean returning 0 if the file is not ignored, 1 if it is
* @param repo a repository object