summaryrefslogtreecommitdiff
path: root/include/git2/config.h
diff options
context:
space:
mode:
authorRussell Belfer <rb@github.com>2013-12-09 10:17:47 -0800
committerRussell Belfer <rb@github.com>2013-12-11 10:57:50 -0800
commit373cf6a932a64d1cbe5f5cd8333546dcc2ca0b92 (patch)
treedb7ea9e143659e4cc6056cfb4467e29adfe81687 /include/git2/config.h
parent26c1cb91beccb44425864bd233ed0e35f5801868 (diff)
downloadlibgit2-373cf6a932a64d1cbe5f5cd8333546dcc2ca0b92.tar.gz
Update docs for new callback return value behavior
Diffstat (limited to 'include/git2/config.h')
-rw-r--r--include/git2/config.h6
1 files changed, 3 insertions, 3 deletions
diff --git a/include/git2/config.h b/include/git2/config.h
index 3ab58f1a7..f650f1b41 100644
--- a/include/git2/config.h
+++ b/include/git2/config.h
@@ -450,13 +450,13 @@ GIT_EXTERN(int) git_config_delete_multivar(git_config *cfg, const char *name, co
*
* The callback receives the normalized name and value of each variable
* in the config backend, and the data pointer passed to this function.
- * As soon as one of the callback functions returns something other than 0,
- * this function stops iterating and returns `GIT_EUSER`.
+ * If the callback returns a non-zero value, the function stops iterating
+ * and returns that value to the caller.
*
* @param cfg where to get the variables from
* @param callback the function to call on each variable
* @param payload the data to pass to the callback
- * @return 0 on success, GIT_EUSER on non-zero callback, or error code
+ * @return 0 on success, non-zero callback return value, or error code
*/
GIT_EXTERN(int) git_config_foreach(
const git_config *cfg,