Skip to content

Commit 5aeef5a

Browse files
committed
index: Enhance documentation
1 parent 977e800 commit 5aeef5a

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

include/git2/index.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,9 @@ GIT_EXTERN(int) git_index_set_caps(git_index *index, unsigned int caps);
225225
* Update the contents of an existing index object in memory
226226
* by reading from the hard disk.
227227
*
228+
* If the file doesn't exist on the filesystem, the index
229+
* will be cleared from its current content.
230+
*
228231
* @param index an existing index object
229232
* @return 0 or an error code
230233
*/

0 commit comments

Comments
 (0)