undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

refs: document flags constants REF_*

Browse Source 
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>
This commit is contained in:
Michael Haggerty 2013-04-14 14:54:16 +02:00 committed by Junio C Hamano
parent 27ec394a97
commit 89df9c84e4
2 changed files with 24 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
refs.c
View File

@ -157,7 +157,17 @@ struct ref_dir {
struct ref_entry **entries; struct ref_entry **entries;
}; };
/* ISSYMREF=0x01, ISPACKED=0x02, and ISBROKEN=0x04 are public interfaces */ /*
* Bit values for ref_entry::flag. REF_ISSYMREF=0x01,
* REF_ISPACKED=0x02, and REF_ISBROKEN=0x04 are public values; see
* refs.h.
*/
/*
* The field ref_entry->u.value.peeled of this value entry contains
* the correct peeled value for the reference, which might be
* null_sha1 if the reference is not a tag or if it is broken.
*/
#define REF_KNOWS_PEELED 0x08 #define REF_KNOWS_PEELED 0x08
/* ref_entry represents a directory of references */ /* ref_entry represents a directory of references */

13
refs.h
View File

@ -10,8 +10,21 @@ struct ref_lock {
int force_write; int force_write;
}; };
/*
* Bit values set in the flags argument passed to each_ref_fn():
*/
/* Reference is a symbolic reference. */
#define REF_ISSYMREF 0x01 #define REF_ISSYMREF 0x01
/* Reference is a packed reference. */
#define REF_ISPACKED 0x02 #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 #define REF_ISBROKEN 0x04
/* /*