refs: introduce an iterator interface

diff --git a/refs.h b/refs.h
index 6d515a4671e85ad24842dd84d648cef492de9e81..442c1a5db8147262bf2894f3bc47b67683f838b6 100644 (file)
--- a/refs.h
+++ b/refs.h
@@ -141,7 +141,9 @@ int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
 struct ref_transaction;
 
 /*
- * Bit values set in the flags argument passed to each_ref_fn():
+ * Bit values set in the flags argument passed to each_ref_fn() and
+ * stored in ref_iterator::flags. Other bits are for internal use
+ * only:
  */
 
 /* Reference is a symbolic reference. */