refs: make explicit that ref_iterator_peel returns boolean

Use -1 as error return value throughout. This removes spurious differences in the GIT_TRACE_REFS output, depending on the ref storage backend active. Before, the cached ref_iterator (but only that iterator!) would return peel_object() output directly. No callers relied on the peel_status values beyond success/failure. All calls to these functions go through peel_iterated_oid(), which returns peel_object() as a fallback, but also squashing the error values. The iteration interface already passes REF_ISSYMREF and REF_ISBROKEN through the flags argument, so the additional error values in enum peel_status provide no value. The ref iteration interface provides a separate peel() function because certain formats (eg. packed-refs and reftable) can store the peeled object next to the tag SHA1. Passing the peeled SHA1 as an optional argument to each_ref_fn maps more naturally to the implementation of ref databases. Changing the code in this way is left for a future refactoring. Signed-off-by: Han-Wen Nienhuys <hanwen@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Han-Wen Nienhuys committed May 19, 2021 at 15:31 UTC 617480d75bdca266d4549e4047452c633ddb7a52
4 files changed +6 -3
refs.c
+1 -1
@@ -2010,7 +2010,7 @@ int peel_iterated_oid(const struct object_id *base, struct object_id *peeled)
2010 oideq(current_ref_iter->oid, base)))
2011 return ref_iterator_peel(current_ref_iter, peeled);
2012
2013 - return peel_object(base, peeled);
2013 + return peel_object(base, peeled) ? -1 : 0;
2014 }
2015
2016 int refs_create_symref(struct ref_store *refs,
refs/packed-backend.c
+1 -1
@@ -889,7 +889,7 @@ static int packed_ref_iterator_peel(struct ref_iterator *ref_iterator,
889 } else if ((iter->base.flags & (REF_ISBROKEN | REF_ISSYMREF))) {
890 return -1;
891 } else {
892 - return !!peel_object(&iter->oid, peeled);
892 + return peel_object(&iter->oid, peeled) ? -1 : 0;
893 }
894 }
895
refs/ref-cache.c
+1 -1
@@ -491,7 +491,7 @@ static int cache_ref_iterator_advance(struct ref_iterator *ref_iterator)
491 static int cache_ref_iterator_peel(struct ref_iterator *ref_iterator,
492 struct object_id *peeled)
493 {
494 - return peel_object(ref_iterator->oid, peeled);
494 + return peel_object(ref_iterator->oid, peeled) ? -1 : 0;
495 }
496
497 static int cache_ref_iterator_abort(struct ref_iterator *ref_iterator)
refs/refs-internal.h
+3
@@ -453,6 +453,9 @@ void base_ref_iterator_free(struct ref_iterator *iter);
453 */
454 typedef int ref_iterator_advance_fn(struct ref_iterator *ref_iterator);
455
456 +/*
457 + * Peels the current ref, returning 0 for success or -1 for failure.
458 + */
459 typedef int ref_iterator_peel_fn(struct ref_iterator *ref_iterator,
460 struct object_id *peeled);
461