summaryrefslogtreecommitdiff
path: root/refs.h
diff options
context:
space:
mode:
authorMichael Haggerty <mhagger@alum.mit.edu>2013-04-14 14:54:16 +0200
committerJunio C Hamano <gitster@pobox.com>2013-05-01 15:33:09 -0700
commit89df9c84e478b7e6055a93cf45cf37027d25b3e4 (patch)
tree06f7b57c0af1cffea6ea39edb80ce04f7ac642d8 /refs.h
parent27ec394a9701675762f02e9af464be2c297c6cf1 (diff)
downloadgit-89df9c84e478b7e6055a93cf45cf37027d25b3e4.tar.gz
refs: document flags constants REF_*
Document the bits that can appear in the "flags" parameter passed to an each_ref_function and/or in the ref_entry::flag field. Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'refs.h')
-rw-r--r--refs.h13
1 files changed, 13 insertions, 0 deletions
diff --git a/refs.h b/refs.h
index d6c2fe2dfb..f111024a18 100644
--- a/refs.h
+++ b/refs.h
@@ -10,8 +10,21 @@ struct ref_lock {
int force_write;
};
+/*
+ * Bit values set in the flags argument passed to each_ref_fn():
+ */
+
+/* Reference is a symbolic reference. */
#define REF_ISSYMREF 0x01
+
+/* Reference is a packed reference. */
#define REF_ISPACKED 0x02
+
+/*
+ * Reference cannot be resolved to an object name: dangling symbolic
+ * reference (directly or indirectly), corrupt reference file, or
+ * symbolic reference refers to ill-formatted reference name.
+ */
#define REF_ISBROKEN 0x04
/*