resolve_ref(): expand documentation
[git/git.git] / refs.h
CommitLineData
95fc7512
DB
1#ifndef REFS_H
2#define REFS_H
3
4bd18c43 4struct ref_lock {
434cd0cd 5 char *ref_name;
1655707c 6 char *orig_ref_name;
c33d5174 7 struct lock_file *lk;
4bd18c43
SP
8 unsigned char old_sha1[20];
9 int lock_fd;
732232a1 10 int force_write;
4bd18c43
SP
11};
12
f4204ab9
JH
13#define REF_ISSYMREF 01
14#define REF_ISPACKED 02
15
8a65ff76
LT
16/*
17 * Calls the specified function for each ref file until it returns nonzero,
18 * and returns the value
19 */
8da19775 20typedef int each_ref_fn(const char *refname, const unsigned char *sha1, int flags, void *cb_data);
cb5d709f
JH
21extern int head_ref(each_ref_fn, void *);
22extern int for_each_ref(each_ref_fn, void *);
2a8177b6 23extern int for_each_ref_in(const char *, each_ref_fn, void *);
cb5d709f
JH
24extern int for_each_tag_ref(each_ref_fn, void *);
25extern int for_each_branch_ref(each_ref_fn, void *);
26extern int for_each_remote_ref(each_ref_fn, void *);
29268700 27extern int for_each_replace_ref(each_ref_fn, void *);
d08bae7e 28extern int for_each_glob_ref(each_ref_fn, const char *pattern, void *);
b09fe971 29extern int for_each_glob_ref_in(each_ref_fn, const char *pattern, const char* prefix, void *);
8a65ff76 30
9ef6aeb0
HV
31extern int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
32extern int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
33extern int for_each_ref_in_submodule(const char *submodule, const char *prefix,
34 each_ref_fn fn, void *cb_data);
35extern int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
36extern int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
37extern int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
38
a1bea2c1
JT
39extern int head_ref_namespaced(each_ref_fn fn, void *cb_data);
40extern int for_each_namespaced_ref(each_ref_fn fn, void *cb_data);
41
894a9d33
TR
42static inline const char *has_glob_specials(const char *pattern)
43{
44 return strpbrk(pattern, "?*[");
45}
46
f8948e2f
JH
47/* can be used to learn about broken ref and symref */
48extern int for_each_rawref(each_ref_fn, void *);
49
3cf6134a 50extern void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname);
f8948e2f 51
e142a3c6
DB
52/*
53 * Extra refs will be listed by for_each_ref() before any actual refs
54 * for the duration of this process or until clear_extra_refs() is
55 * called. Only extra refs added before for_each_ref() is called will
56 * be listed on a given call of for_each_ref().
57 */
58extern void add_extra_ref(const char *refname, const unsigned char *sha1, int flags);
59extern void clear_extra_refs(void);
c17b2294 60extern int ref_exists(char *);
e142a3c6 61
cf0adba7
JH
62extern int peel_ref(const char *, unsigned char *);
63
4bd18c43 64/** Locks a "refs/" ref returning the lock on success and NULL on failure. **/
4431fcc4 65extern struct ref_lock *lock_ref_sha1(const char *ref, const unsigned char *old_sha1);
4bd18c43
SP
66
67/** Locks any ref (for 'HEAD' type refs). */
68db31cc
SV
68#define REF_NODEREF 0x01
69extern struct ref_lock *lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1, int flags);
95fc7512 70
435fc852
BC
71/** Close the file descriptor owned by a lock and return the status */
72extern int close_ref(struct ref_lock *lock);
73
74/** Close and commit the ref locked by the lock */
75extern int commit_ref(struct ref_lock *lock);
76
4bd18c43 77/** Release any lock taken but not written. **/
e5f38ec3 78extern void unlock_ref(struct ref_lock *lock);
95fc7512 79
4bd18c43
SP
80/** Writes sha1 into the ref specified by the lock. **/
81extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg);
95fc7512 82
859c3017 83/** Setup reflog before using. **/
157aaea5 84int log_ref_setup(const char *ref_name, char *logfile, int bufsize);
859c3017 85
d556fae2 86/** Reads log for the value of ref during at_time. **/
16d7cc90 87extern int read_ref_at(const char *ref, unsigned long at_time, int cnt, unsigned char *sha1, char **msg, unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt);
d556fae2 88
2ff81662 89/* iterate over reflog entries */
883d60fa
JS
90typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *);
91int for_each_reflog_ent(const char *ref, each_reflog_ent_fn fn, void *cb_data);
101d15e0 92int for_each_recent_reflog_ent(const char *ref, each_reflog_ent_fn fn, long, void *cb_data);
2ff81662 93
eb8381c8
NP
94/*
95 * Calls the specified function for each reflog file until it returns nonzero,
96 * and returns the value
97 */
98extern int for_each_reflog(each_ref_fn, void *);
99
8d9c5010
MH
100#define REFNAME_ALLOW_ONELEVEL 1
101#define REFNAME_REFSPEC_PATTERN 2
102
103/*
104 * Return 0 iff ref has the correct format for a refname according to
105 * the rules described in Documentation/git-check-ref-format.txt. If
106 * REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level
107 * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then
108 * allow a "*" wildcard character in place of one of the name
a40e6fb6 109 * components. No leading or repeated slashes are accepted.
8d9c5010
MH
110 */
111extern int check_refname_format(const char *ref, int flags);
95fc7512 112
4577e483 113extern const char *prettify_refname(const char *refname);
6e7b3309 114extern char *shorten_unambiguous_ref(const char *ref, int strict);
a9c37a72 115
c976d415 116/** rename ref, return 0 on success **/
678d0f4c 117extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);
c976d415 118
0ebde32c
LT
119/** resolve ref in nested "gitlink" repository */
120extern int resolve_gitlink_ref(const char *name, const char *refname, unsigned char *result);
121
3d9f037c
CR
122/** lock a ref and then write its file */
123enum action_on_err { MSG_ON_ERR, DIE_ON_ERR, QUIET_ON_ERR };
124int update_ref(const char *action, const char *refname,
125 const unsigned char *sha1, const unsigned char *oldval,
126 int flags, enum action_on_err onerr);
127
95fc7512 128#endif /* REFS_H */