Commit 6445ae994c8be706c58e441c1af2cddd0632b96e

nulltoken 2013-10-04T13:49:26

index: Enhance documentation

1
2
3
4
5
6
7
8
9
10
11
12
13
14
diff --git a/include/git2/index.h b/include/git2/index.h
index 131d049..8064a62 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
  */