From 6c6f58dfd26c0643e38d7ea754b6d4173573a1f6 Mon Sep 17 00:00:00 2001 From: Michael Haggerty Date: Sun, 14 Apr 2013 14:54:17 +0200 Subject: refs: document the fields of struct ref_value Signed-off-by: Michael Haggerty Signed-off-by: Junio C Hamano --- refs.c | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/refs.c b/refs.c index 6b3511ee0b..ed1b4cf9b6 100644 --- a/refs.c +++ b/refs.c @@ -108,7 +108,19 @@ struct ref_entry; * (ref_entry->flag & REF_DIR) is zero. */ struct ref_value { + /* + * The name of the object to which this reference resolves + * (which may be a tag object). If REF_ISBROKEN, this is + * null. If REF_ISSYMREF, then this is the name of the object + * referred to by the last reference in the symlink chain. + */ unsigned char sha1[20]; + + /* + * If REF_KNOWS_PEELED, then this field holds the peeled value + * of this reference, or null if the reference is known not to + * be peelable. + */ unsigned char peeled[20]; }; -- cgit v1.2.3