summaryrefslogtreecommitdiff
path: root/include/git2/index.h
diff options
context:
space:
mode:
authornulltoken <emeric.fermas@gmail.com>2013-10-04 13:49:26 +0200
committernulltoken <emeric.fermas@gmail.com>2013-10-04 13:49:26 +0200
commit6445ae994c8be706c58e441c1af2cddd0632b96e (patch)
treeb8c375ad3825d07722110d4e6cf53d23f6ade140 /include/git2/index.h
parent34b8eafcaea7fc12f91691195c9b7289038c4abb (diff)
downloadlibgit2-6445ae994c8be706c58e441c1af2cddd0632b96e.tar.gz
index: Enhance documentation
Diffstat (limited to 'include/git2/index.h')
-rw-r--r--include/git2/index.h3
1 files changed, 3 insertions, 0 deletions
diff --git a/include/git2/index.h b/include/git2/index.h
index 131d04945..8064a62ff 100644
--- a/include/git2/index.h
+++ b/include/git2/index.h
@@ -225,6 +225,9 @@ GIT_EXTERN(int) git_index_set_caps(git_index *index, unsigned int caps);
* Update the contents of an existing index object in memory
* by reading from the hard disk.
*
+ * If the file doesn't exist on the filesystem, the index
+ * will be cleared from its current content.
+ *
* @param index an existing index object
* @return 0 or an error code
*/