Update draft release notes for 2.0
[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
98aee92d
BK
13/**
14 * Information needed for a single ref update. Set new_sha1 to the
15 * new value or to zero to delete the ref. To check the old value
16 * while locking the ref, set have_old to 1 and set old_sha1 to the
17 * value or to zero to ensure the ref does not exist before update.
18 */
19struct ref_update {
20 const char *ref_name;
21 unsigned char new_sha1[20];
22 unsigned char old_sha1[20];
23 int flags; /* REF_NODEREF? */
24 int have_old; /* 1 if old_sha1 is valid, 0 otherwise */
25};
26
89df9c84
MH
27/*
28 * Bit values set in the flags argument passed to each_ref_fn():
29 */
30
31/* Reference is a symbolic reference. */
98ac34b2 32#define REF_ISSYMREF 0x01
89df9c84
MH
33
34/* Reference is a packed reference. */
98ac34b2 35#define REF_ISPACKED 0x02
89df9c84
MH
36
37/*
38 * Reference cannot be resolved to an object name: dangling symbolic
39 * reference (directly or indirectly), corrupt reference file, or
40 * symbolic reference refers to ill-formatted reference name.
41 */
98ac34b2 42#define REF_ISBROKEN 0x04
f4204ab9 43
8a65ff76 44/*
4f78c24c
MH
45 * The signature for the callback function for the for_each_*()
46 * functions below. The memory pointed to by the refname and sha1
47 * arguments is only guaranteed to be valid for the duration of a
48 * single callback invocation.
49 */
50typedef int each_ref_fn(const char *refname,
51 const unsigned char *sha1, int flags, void *cb_data);
52
53/*
54 * The following functions invoke the specified callback function for
55 * each reference indicated. If the function ever returns a nonzero
56 * value, stop the iteration and return that value. Please note that
57 * it is not safe to modify references while an iteration is in
58 * progress, unless the same callback function invocation that
59 * modifies the reference also returns a nonzero value to immediately
60 * stop the iteration.
8a65ff76 61 */
cb5d709f
JH
62extern int head_ref(each_ref_fn, void *);
63extern int for_each_ref(each_ref_fn, void *);
2a8177b6 64extern int for_each_ref_in(const char *, each_ref_fn, void *);
cb5d709f
JH
65extern int for_each_tag_ref(each_ref_fn, void *);
66extern int for_each_branch_ref(each_ref_fn, void *);
67extern int for_each_remote_ref(each_ref_fn, void *);
29268700 68extern int for_each_replace_ref(each_ref_fn, void *);
d08bae7e 69extern int for_each_glob_ref(each_ref_fn, const char *pattern, void *);
b09fe971 70extern int for_each_glob_ref_in(each_ref_fn, const char *pattern, const char* prefix, void *);
8a65ff76 71
9ef6aeb0
HV
72extern int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
73extern int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
74extern int for_each_ref_in_submodule(const char *submodule, const char *prefix,
75 each_ref_fn fn, void *cb_data);
76extern int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
77extern int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
78extern int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
79
a1bea2c1
JT
80extern int head_ref_namespaced(each_ref_fn fn, void *cb_data);
81extern int for_each_namespaced_ref(each_ref_fn fn, void *cb_data);
82
894a9d33
TR
83static inline const char *has_glob_specials(const char *pattern)
84{
85 return strpbrk(pattern, "?*[");
86}
87
f8948e2f
JH
88/* can be used to learn about broken ref and symref */
89extern int for_each_rawref(each_ref_fn, void *);
90
3cf6134a 91extern void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname);
f8948e2f 92
30249ee6 93/*
9f69d297
MH
94 * Lock the packed-refs file for writing. Flags is passed to
95 * hold_lock_file_for_update(). Return 0 on success.
96 */
97extern int lock_packed_refs(int flags);
98
99/*
100 * Add a reference to the in-memory packed reference cache. This may
101 * only be called while the packed-refs file is locked (see
102 * lock_packed_refs()). To actually write the packed-refs file, call
103 * commit_packed_refs().
30249ee6
MH
104 */
105extern void add_packed_ref(const char *refname, const unsigned char *sha1);
106
9f69d297
MH
107/*
108 * Write the current version of the packed refs cache from memory to
109 * disk. The packed-refs file must already be locked for writing (see
110 * lock_packed_refs()). Return zero on success.
111 */
112extern int commit_packed_refs(void);
113
114/*
115 * Rollback the lockfile for the packed-refs file, and discard the
116 * in-memory packed reference cache. (The packed-refs file will be
117 * read anew if it is needed again after this function is called.)
118 */
119extern void rollback_packed_refs(void);
120
32d462ce
MH
121/*
122 * Flags for controlling behaviour of pack_refs()
123 * PACK_REFS_PRUNE: Prune loose refs after packing
124 * PACK_REFS_ALL: Pack _all_ refs, not just tags and already packed refs
125 */
126#define PACK_REFS_PRUNE 0x0001
127#define PACK_REFS_ALL 0x0002
128
129/*
130 * Write a packed-refs file for the current repository.
131 * flags: Combination of the above PACK_REFS_* flags.
132 */
133int pack_refs(unsigned int flags);
134
2c5c66be 135extern int ref_exists(const char *);
e142a3c6 136
2312a793
MH
137/*
138 * If refname is a non-symbolic reference that refers to a tag object,
139 * and the tag can be (recursively) dereferenced to a non-tag object,
140 * store the SHA1 of the referred-to object to sha1 and return 0. If
141 * any of these conditions are not met, return a non-zero value.
142 * Symbolic references are considered unpeelable, even if they
143 * ultimately resolve to a peelable tag.
144 */
dfefa935 145extern int peel_ref(const char *refname, unsigned char *sha1);
cf0adba7 146
4bd18c43 147/** Locks a "refs/" ref returning the lock on success and NULL on failure. **/
dfefa935 148extern struct ref_lock *lock_ref_sha1(const char *refname, const unsigned char *old_sha1);
4bd18c43
SP
149
150/** Locks any ref (for 'HEAD' type refs). */
68db31cc 151#define REF_NODEREF 0x01
dfefa935
MH
152extern struct ref_lock *lock_any_ref_for_update(const char *refname,
153 const unsigned char *old_sha1,
9bbb0fa1 154 int flags, int *type_p);
95fc7512 155
435fc852
BC
156/** Close the file descriptor owned by a lock and return the status */
157extern int close_ref(struct ref_lock *lock);
158
159/** Close and commit the ref locked by the lock */
160extern int commit_ref(struct ref_lock *lock);
161
4bd18c43 162/** Release any lock taken but not written. **/
e5f38ec3 163extern void unlock_ref(struct ref_lock *lock);
95fc7512 164
4bd18c43
SP
165/** Writes sha1 into the ref specified by the lock. **/
166extern int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1, const char *msg);
95fc7512 167
859c3017 168/** Setup reflog before using. **/
157aaea5 169int log_ref_setup(const char *ref_name, char *logfile, int bufsize);
859c3017 170
d556fae2 171/** Reads log for the value of ref during at_time. **/
dfefa935
MH
172extern int read_ref_at(const char *refname, unsigned long at_time, int cnt,
173 unsigned char *sha1, char **msg,
174 unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt);
d556fae2 175
2ff81662 176/* iterate over reflog entries */
883d60fa 177typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *);
dfefa935 178int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data);
98f85ff4 179int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data);
2ff81662 180
eb8381c8
NP
181/*
182 * Calls the specified function for each reflog file until it returns nonzero,
183 * and returns the value
184 */
185extern int for_each_reflog(each_ref_fn, void *);
186
8d9c5010
MH
187#define REFNAME_ALLOW_ONELEVEL 1
188#define REFNAME_REFSPEC_PATTERN 2
dce4bab6 189#define REFNAME_DOT_COMPONENT 4
8d9c5010
MH
190
191/*
dfefa935
MH
192 * Return 0 iff refname has the correct format for a refname according
193 * to the rules described in Documentation/git-check-ref-format.txt.
194 * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level
8d9c5010
MH
195 * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then
196 * allow a "*" wildcard character in place of one of the name
dce4bab6
MH
197 * components. No leading or repeated slashes are accepted. If
198 * REFNAME_DOT_COMPONENT is set in flags, then allow refname
199 * components to start with "." (but not a whole component equal to
200 * "." or "..").
8d9c5010 201 */
dfefa935 202extern int check_refname_format(const char *refname, int flags);
95fc7512 203
4577e483 204extern const char *prettify_refname(const char *refname);
dfefa935 205extern char *shorten_unambiguous_ref(const char *refname, int strict);
a9c37a72 206
c976d415 207/** rename ref, return 0 on success **/
678d0f4c 208extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);
c976d415 209
7f820bd9
MH
210/**
211 * Resolve refname in the nested "gitlink" repository that is located
212 * at path. If the resolution is successful, return 0 and set sha1 to
213 * the name of the object; otherwise, return a non-zero value.
214 */
215extern int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1);
0ebde32c 216
3d9f037c
CR
217/** lock a ref and then write its file */
218enum action_on_err { MSG_ON_ERR, DIE_ON_ERR, QUIET_ON_ERR };
219int update_ref(const char *action, const char *refname,
220 const unsigned char *sha1, const unsigned char *oldval,
221 int flags, enum action_on_err onerr);
222
98aee92d
BK
223/**
224 * Lock all refs and then perform all modifications.
225 */
226int update_refs(const char *action, const struct ref_update **updates,
227 int n, enum action_on_err onerr);
228
daebaa78
JH
229extern int parse_hide_refs_config(const char *var, const char *value, const char *);
230extern int ref_is_hidden(const char *);
231
95fc7512 232#endif /* REFS_H */