diff options
Diffstat (limited to 'include/git2/odb.h')
| -rw-r--r-- | include/git2/odb.h | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/include/git2/odb.h b/include/git2/odb.h index dac9e06a9..1f25db463 100644 --- a/include/git2/odb.h +++ b/include/git2/odb.h @@ -176,13 +176,14 @@ GIT_EXTERN(int) git_odb_exists(git_odb *db, const git_oid *id); * List all objects available in the database * * The callback will be called for each object available in the - * database. Note that the objects are likely to be returned in the - * index order, which would make accessing the objects in that order - * inefficient. + * database. Note that the objects are likely to be returned in the index + * order, which would make accessing the objects in that order inefficient. + * Return a non-zero value from the callback to stop looping. * * @param db database to use * @param cb the callback to call for each object * @param data data to pass to the callback + * @return 0 on success, GIT_EUSER on non-zero callback, or error code */ GIT_EXTERN(int) git_odb_foreach(git_odb *db, int (*cb)(git_oid *oid, void *data), void *data); |