From: Han-Wen Nienhuys via GitGitGadget Date: Thu, 06 Feb 2020 22:55:54 GMT Subject: [PATCH v4 3/5] refs: document how ref_iterator_advance_fn should handle symrefs Message-ID: In-Reply-To: From: Han-Wen Nienhuys Signed-off-by: Han-Wen Nienhuys --- refs/refs-internal.h | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/refs/refs-internal.h b/refs/refs-internal.h index ff2436c0fb..1d7a485220 100644 --- a/refs/refs-internal.h +++ b/refs/refs-internal.h @@ -438,6 +438,11 @@ void base_ref_iterator_free(struct ref_iterator *iter); /* Virtual function declarations for ref_iterators: */ +/* + * backend-specific implementation of ref_iterator_advance. + * For symrefs, the function should set REF_ISSYMREF, and it should also dereference + * the symref to provide the OID referent. + */ typedef int ref_iterator_advance_fn(struct ref_iterator *ref_iterator); typedef int ref_iterator_peel_fn(struct ref_iterator *ref_iterator, -- gitgitgadget