summaryrefslogtreecommitdiff
path: root/include/git2
diff options
context:
space:
mode:
Diffstat (limited to 'include/git2')
-rw-r--r--include/git2/refs.h3
1 files changed, 3 insertions, 0 deletions
diff --git a/include/git2/refs.h b/include/git2/refs.h
index dee28cb5b..0dd453e55 100644
--- a/include/git2/refs.h
+++ b/include/git2/refs.h
@@ -433,6 +433,9 @@ typedef int (*git_reference_foreach_name_cb)(const char *name, void *payload);
* passed to this method. Returning a non-zero value from the callback
* will terminate the iteration.
*
+ * Note that the callback function is responsible to call `git_reference_free`
+ * on each reference passed to it.
+ *
* @param repo Repository where to find the refs
* @param callback Function which will be called for every listed ref
* @param payload Additional data to pass to the callback