summaryrefslogtreecommitdiff
path: root/include/git2/ignore.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/git2/ignore.h')
-rw-r--r--include/git2/ignore.h7
1 files changed, 4 insertions, 3 deletions
diff --git a/include/git2/ignore.h b/include/git2/ignore.h
index e18615edd..592c96e65 100644
--- a/include/git2/ignore.h
+++ b/include/git2/ignore.h
@@ -41,9 +41,10 @@ GIT_EXTERN(int) git_ignore_add_rule(
/**
* Clear ignore rules that were explicitly added.
*
- * Clears the internal ignore rules that have been set up. This will not
- * turn off the rules in .gitignore files that actually exist in the
- * filesystem.
+ * Resets to the default internal ignore rules. This will not turn off
+ * rules in .gitignore files that actually exist in the filesystem.
+ *
+ * The default internal ignores ignore ".", ".." and ".git" entries.
*
* @param repo The repository to remove ignore rules from.
* @return 0 on success