read_packed_refs(): ensure that references are ordered when read

diff --git a/refs/ref-cache.h b/refs/ref-cache.h
index 794f000fd31ebad3ce340ffd9af3fc843b089479..a082bfb06c8c420ee5bc4cb81c8b3624f1ba76bc 100644 (file)
--- 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,