refs: document the fields of struct ref_value
Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Michael Haggerty committed
Apr 14, 2013 at 14:54 UTC
6c6f58dfd26c0643e38d7ea754b6d4173573a1f6
1 file changed
+12
refs.c
+12
@@ -108,7 +108,19 @@ struct ref_entry;
108
* (ref_entry->flag & REF_DIR) is zero.
109
*/
110
struct ref_value {
111
+ /*
112
+ * The name of the object to which this reference resolves
113
+ * (which may be a tag object). If REF_ISBROKEN, this is
114
+ * null. If REF_ISSYMREF, then this is the name of the object
115
+ * referred to by the last reference in the symlink chain.
116
+ */
117
unsigned char sha1[20];
118
+
119
+ /*
120
+ * If REF_KNOWS_PEELED, then this field holds the peeled value
121
+ * of this reference, or null if the reference is known not to
122
+ * be peelable.
123
+ */
124
unsigned char peeled[20];
125
};
126