ref_iterator_begin_fn(): fix docstring
[gitweb.git] / refs / refs-internal.h
index b6b291cf00e5cf0403b4168eca90d5f67bd65c0d..7020e51cb7c0a321e28591f6c397cfc3d15e0398 100644 (file)
@@ -515,9 +515,10 @@ typedef int rename_ref_fn(struct ref_store *ref_store,
                          const char *logmsg);
 
 /*
- * Iterate over the references in the specified ref_store that are
- * within find_containing_dir(prefix). If prefix is NULL or the empty
- * string, iterate over all references in the submodule.
+ * Iterate over the references in `ref_store` whose names start with
+ * `prefix`. `prefix` is matched as a literal string, without regard
+ * for path separators. If prefix is NULL or the empty string, iterate
+ * over all references in `ref_store`.
  */
 typedef struct ref_iterator *ref_iterator_begin_fn(
                struct ref_store *ref_store,