diff options
| author |  Michael Haggerty <mhagger@alum.mit.edu> | 2017-05-22 16:17:33 +0200 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2017-05-23 14:29:52 +0900 |
| commit | e186057138666058a2c67c3389509c9430d95b24 (patch) | |
| tree | eda0756a9f0981dd7e05c0669f89bdf28f47bc1c /refs/refs-internal.h | |
| parent | refs.h: clarify docstring for the ref_transaction_update()-related fns (diff) | |
| download | tgif-e186057138666058a2c67c3389509c9430d95b24.tar.xz | |
ref_iterator_begin_fn(): fix docstring
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>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'refs/refs-internal.h')
| -rw-r--r-- | refs/refs-internal.h | 7 |
1 files 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, |