summaryrefslogtreecommitdiff
path: root/refs/ref-cache.h
diff options
context:
space:
mode:
Diffstat (limited to 'refs/ref-cache.h')
-rw-r--r--refs/ref-cache.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/refs/ref-cache.h b/refs/ref-cache.h
index 794f000..a082bfb 100644
--- a/refs/ref-cache.h
+++ b/refs/ref-cache.h
@@ -245,7 +245,8 @@ struct ref_entry *find_ref_entry(struct ref_dir *dir, const char *refname);
* Start iterating over references in `cache`. If `prefix` is
* specified, only include references whose names start with that
* prefix. If `prime_dir` is true, then fill any incomplete
- * directories before beginning the iteration.
+ * directories before beginning the iteration. The output is ordered
+ * by refname.
*/
struct ref_iterator *cache_ref_iterator_begin(struct ref_cache *cache,
const char *prefix,