index: Enhance documentation

This commit is contained in:
nulltoken 2013-10-04 13:49:26 +02:00
parent 34b8eafcae
commit 6445ae994c

View File

@ -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 * Update the contents of an existing index object in memory
* by reading from the hard disk. * 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 * @param index an existing index object
* @return 0 or an error code * @return 0 or an error code
*/ */