aboutsummaryrefslogtreecommitdiff
path: root/refs.c
diff options
context:
space:
mode:
authorMichael Haggerty <mhagger@alum.mit.edu>2013-04-14 14:54:17 +0200
committerJunio C Hamano <gitster@pobox.com>2013-05-01 15:33:09 -0700
commit6c6f58dfd26c0643e38d7ea754b6d4173573a1f6 (patch)
tree78b9179e5cc3513cd8dd892a63acc71e417c0391 /refs.c
parent89df9c84e478b7e6055a93cf45cf37027d25b3e4 (diff)
downloadgit-6c6f58dfd26c0643e38d7ea754b6d4173573a1f6.tar.gz
git-6c6f58dfd26c0643e38d7ea754b6d4173573a1f6.tar.xz
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>
Diffstat (limited to 'refs.c')
-rw-r--r--refs.c12
1 files changed, 12 insertions, 0 deletions
diff --git a/refs.c b/refs.c
index 6b3511ee0..ed1b4cf9b 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];
};