[PATCH v2 03/25] ref_iterator_begin_fn(): fix docstring
- From
Michael Haggerty <mhagger@alum.mit.edu>
- Date
- May 22, 2017, 14:17 UTC
- Message-ID
- <7df9b378009b633e72a98ba6e5f2250718f1ce19.1495460199.git.mhagger@alum.mit.edu>
- In-Reply-To
- <cover.1495460199.git.mhagger@alum.mit.edu>
The iterator returned by this function only includes references whose names start with the whole prefix, not all of those in `find_containing_dir(prefix)` as the old docstring claimed. This docstring was probably copy-pasted from old ref-cache code, which had the old specification. But now, `cache_ref_iterator_begin()` (from which the files reference iterator gets its values) automatically wraps its output using `prefix_ref_iterator_begin()` when necessary, so it has the stricter behavior.
Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu> --- refs/refs-internal.h | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/refs/refs-internal.h b/refs/refs-internal.h index b6b291cf00..7020e51cb7 100644 --- a/refs/refs-internal.h +++ b/refs/refs-internal.h @@ -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,
-- 2.11.0