diff options
author | Vicent Marti <tanoku@gmail.com> | 2012-08-06 12:41:08 +0200 |
---|---|---|
committer | Vicent Marti <tanoku@gmail.com> | 2012-08-06 12:41:08 +0200 |
commit | 51e1d8084641bd36416bf6f127b31d47d64cce69 (patch) | |
tree | 1a95e6b4c664020eb4bbff843eead794f3ee3d35 /include/git2/refs.h | |
parent | 7e9f78b5fee2d8f56711a587c35fcba10d370547 (diff) | |
parent | b0d376695e7d3f71fed97d9d08b60661faad7a5a (diff) | |
download | libgit2-51e1d8084641bd36416bf6f127b31d47d64cce69.tar.gz |
Merge remote-tracking branch 'arrbee/tree-walk-fixes' into development
Conflicts:
src/notes.c
src/transports/git.c
src/transports/http.c
src/transports/local.c
tests-clar/odb/foreach.c
Diffstat (limited to 'include/git2/refs.h')
-rw-r--r-- | include/git2/refs.h | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/include/git2/refs.h b/include/git2/refs.h index 8dd8e3116..d92390061 100644 --- a/include/git2/refs.h +++ b/include/git2/refs.h @@ -268,14 +268,15 @@ GIT_EXTERN(int) git_reference_list(git_strarray *array, git_repository *repo, un * * The `callback` function will be called for each of the references * in the repository, and will receive the name of the reference and - * the `payload` value passed to this method. + * the `payload` value passed to this method. Returning a non-zero + * value from the callback will terminate the iteration. * * @param repo Repository where to find the refs * @param list_flags Filtering flags for the reference * listing. * @param callback Function which will be called for every listed ref * @param payload Additional data to pass to the callback - * @return 0 or an error code + * @return 0 on success, GIT_EUSER on non-zero callback, or error code */ GIT_EXTERN(int) git_reference_foreach(git_repository *repo, unsigned int list_flags, int (*callback)(const char *, void *), void *payload); |