Commit 99bb98c0e8abb97b1daa3aff0307b93ed9291c08

Edward Thomson 2018-07-16T11:18:13

Merge pull request #4722 from boogisha/path-is-ignored-git-analogy ignore: improve `git_ignore_path_is_ignored` description Git analogy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
diff --git a/include/git2/ignore.h b/include/git2/ignore.h
index d0c1877..f5143f3 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