diff options
| author | Russell Belfer <rb@github.com> | 2013-12-09 10:17:47 -0800 |
|---|---|---|
| committer | Russell Belfer <rb@github.com> | 2013-12-11 10:57:50 -0800 |
| commit | 373cf6a932a64d1cbe5f5cd8333546dcc2ca0b92 (patch) | |
| tree | db7ea9e143659e4cc6056cfb4467e29adfe81687 /include/git2/index.h | |
| parent | 26c1cb91beccb44425864bd233ed0e35f5801868 (diff) | |
| download | libgit2-373cf6a932a64d1cbe5f5cd8333546dcc2ca0b92.tar.gz | |
Update docs for new callback return value behavior
Diffstat (limited to 'include/git2/index.h')
| -rw-r--r-- | include/git2/index.h | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/include/git2/index.h b/include/git2/index.h index a60db370a..ffefad15d 100644 --- a/include/git2/index.h +++ b/include/git2/index.h @@ -493,7 +493,7 @@ GIT_EXTERN(int) git_index_remove_bypath(git_index *index, const char *path); * item in the working directory immediately *before* it is added to / * updated in the index. Returning zero will add the item to the index, * greater than zero will skip the item, and less than zero will abort the - * scan and cause GIT_EUSER to be returned. + * scan and return that value to the caller. * * @param index an existing index object * @param pathspec array of path patterns @@ -502,7 +502,7 @@ GIT_EXTERN(int) git_index_remove_bypath(git_index *index, const char *path); * gets index of matching pathspec entry); can be NULL; * return 0 to add, >0 to skip, <0 to abort scan. * @param payload payload passed through to callback function - * @return 0 or an error code + * @return 0 on success, negative callback return value, or error code */ GIT_EXTERN(int) git_index_add_all( git_index *index, @@ -524,7 +524,7 @@ GIT_EXTERN(int) git_index_add_all( * gets index of matching pathspec entry); can be NULL; * return 0 to add, >0 to skip, <0 to abort scan. * @param payload payload passed through to callback function - * @return 0 or an error code + * @return 0 on success, negative callback return value, or error code */ GIT_EXTERN(int) git_index_remove_all( git_index *index, @@ -553,7 +553,7 @@ GIT_EXTERN(int) git_index_remove_all( * gets index of matching pathspec entry); can be NULL; * return 0 to add, >0 to skip, <0 to abort scan. * @param payload payload passed through to callback function - * @return 0 or an error code + * @return 0 on success, negative callback return value, or error code */ GIT_EXTERN(int) git_index_update_all( git_index *index, |