Merge pull request libgit2#4722 from boogisha/path-is-ignored-git-analogy

ethomson · web-flow · commit 99bb98c0e8ab · 2018-07-16T11:18:13.000+01:00
ignore: improve `git_ignore_path_is_ignored` description Git analogy
diff --git 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

Original file line number	Diff line number	Diff line change
`@@ -59,8 +59,8 @@ GIT_EXTERN(int) git_ignore_clear_internal_rules(`
`59`	`59`	`* given file. This indicates if the file would be ignored regardless of`
`60`	`60`	`* whether the file is already in the index or committed to the repository.`
`61`	`61`	`*`
`62`		`- * One way to think of this is if you were to do "git add ." on the`
`63`		`- * directory containing the file, would it be added or not?`
	`62`	`+ * One way to think of this is if you were to do "git check-ignore --no-index"`
	`63`	`+ * on the given file, would it be shown or not?`
`64`	`64`	`*`
`65`	`65`	`* @param ignored boolean returning 0 if the file is not ignored, 1 if it is`
`66`	`66`	`* @param repo a repository object`