summaryrefslogtreecommitdiff
path: root/include/git2/tree.h
diff options
context:
space:
mode:
authorCarlos Martín Nieto <cmn@dwim.me>2012-08-14 11:43:20 -0700
committerCarlos Martín Nieto <cmn@dwim.me>2012-08-14 11:43:20 -0700
commit85f28ba89178f2e7e1613bac81831dea24f32418 (patch)
treeb410b4cd75d055d48cebf76af8a702f5225ce65e /include/git2/tree.h
parent3a6bc301c56933672e5c84e3bb2b62a7491391b0 (diff)
parenta6bf16878a121152f5bddf4d46f641e8f044d278 (diff)
downloadlibgit2-85f28ba89178f2e7e1613bac81831dea24f32418.tar.gz
Merge pull request #873 from carlosmn/tree-walk
git_tree_walk callback return value semantic does not match documentation
Diffstat (limited to 'include/git2/tree.h')
-rw-r--r--include/git2/tree.h5
1 files changed, 3 insertions, 2 deletions
diff --git a/include/git2/tree.h b/include/git2/tree.h
index b91340624..85407d7ac 100644
--- a/include/git2/tree.h
+++ b/include/git2/tree.h
@@ -351,8 +351,9 @@ enum git_treewalk_mode {
* the current (relative) root for the entry and the entry
* data itself.
*
- * If the callback returns a negative value, the passed entry
- * will be skipped on the traversal.
+ * If the callback returns a positive value, the passed entry will be
+ * skipped on the traversal (in pre mode). A negative value stops the
+ * walk.
*
* @param tree The tree to walk
* @param callback Function to call on each tree entry