blob: 8c3d433a8a5b1b29f49d82e1c5799e8e3dc6e7a4 [file] [log] [blame]
Daniel Barkalow95fc7512005-06-06 16:31:29 -04001#ifndef REFS_H
2#define REFS_H
3
Ronnie Sahlbergb416af52014-04-16 15:26:44 -07004/*
5 * A ref_transaction represents a collection of ref updates
6 * that should succeed or fail together.
7 *
8 * Calling sequence
9 * ----------------
10 * - Allocate and initialize a `struct ref_transaction` by calling
11 * `ref_transaction_begin()`.
12 *
13 * - List intended ref updates by calling functions like
14 * `ref_transaction_update()` and `ref_transaction_create()`.
15 *
16 * - Call `ref_transaction_commit()` to execute the transaction.
17 * If this succeeds, the ref updates will have taken place and
18 * the transaction cannot be rolled back.
19 *
20 * - At any time call `ref_transaction_free()` to discard the
21 * transaction and free associated resources. In particular,
22 * this rolls back the transaction if it has not been
23 * successfully committed.
24 *
25 * Error handling
26 * --------------
27 *
28 * On error, transaction functions append a message about what
29 * went wrong to the 'err' argument. The message mentions what
30 * ref was being updated (if any) when the error occurred so it
31 * can be passed to 'die' or 'error' as-is.
32 *
33 * The message is appended to err without first clearing err.
34 * err will not be '\n' terminated.
35 */
Michael Haggertycaa40462014-04-07 15:48:10 +020036struct ref_transaction;
37
Michael Haggerty89df9c82013-04-14 14:54:16 +020038/*
39 * Bit values set in the flags argument passed to each_ref_fn():
40 */
41
42/* Reference is a symbolic reference. */
Junio C Hamano98ac34b2011-10-19 13:45:50 -070043#define REF_ISSYMREF 0x01
Michael Haggerty89df9c82013-04-14 14:54:16 +020044
45/* Reference is a packed reference. */
Junio C Hamano98ac34b2011-10-19 13:45:50 -070046#define REF_ISPACKED 0x02
Michael Haggerty89df9c82013-04-14 14:54:16 +020047
48/*
49 * Reference cannot be resolved to an object name: dangling symbolic
Ronnie Sahlbergd0f810f2014-09-03 11:45:43 -070050 * reference (directly or indirectly), corrupt reference file,
51 * reference exists but name is bad, or symbolic reference refers to
52 * ill-formatted reference name.
Michael Haggerty89df9c82013-04-14 14:54:16 +020053 */
Junio C Hamano98ac34b2011-10-19 13:45:50 -070054#define REF_ISBROKEN 0x04
Junio C Hamanof4204ab2006-11-21 23:36:35 -080055
Linus Torvalds8a65ff72005-07-02 20:23:36 -070056/*
Ronnie Sahlbergd0f810f2014-09-03 11:45:43 -070057 * Reference name is not well formed.
58 *
59 * See git-check-ref-format(1) for the definition of well formed ref names.
60 */
61#define REF_BAD_NAME 0x08
62
63/*
Michael Haggerty4f78c242013-05-25 11:08:24 +020064 * The signature for the callback function for the for_each_*()
65 * functions below. The memory pointed to by the refname and sha1
66 * arguments is only guaranteed to be valid for the duration of a
67 * single callback invocation.
Linus Torvalds8a65ff72005-07-02 20:23:36 -070068 */
Michael Haggerty4f78c242013-05-25 11:08:24 +020069typedef int each_ref_fn(const char *refname,
Michael Haggerty2b2a5be2015-05-25 18:38:28 +000070 const struct object_id *oid, int flags, void *cb_data);
71
Michael Haggerty4f78c242013-05-25 11:08:24 +020072/*
73 * The following functions invoke the specified callback function for
74 * each reference indicated. If the function ever returns a nonzero
75 * value, stop the iteration and return that value. Please note that
76 * it is not safe to modify references while an iteration is in
77 * progress, unless the same callback function invocation that
78 * modifies the reference also returns a nonzero value to immediately
79 * stop the iteration.
80 */
Junio C Hamanocb5d7092006-09-20 21:47:42 -070081extern int head_ref(each_ref_fn, void *);
82extern int for_each_ref(each_ref_fn, void *);
Christian Couder2a8177b2009-03-30 05:07:15 +020083extern int for_each_ref_in(const char *, each_ref_fn, void *);
Junio C Hamanocb5d7092006-09-20 21:47:42 -070084extern int for_each_tag_ref(each_ref_fn, void *);
85extern int for_each_branch_ref(each_ref_fn, void *);
86extern int for_each_remote_ref(each_ref_fn, void *);
Christian Couder29268702009-01-23 10:06:38 +010087extern int for_each_replace_ref(each_ref_fn, void *);
Ilari Liusvaarad08bae72010-01-20 11:48:25 +020088extern int for_each_glob_ref(each_ref_fn, const char *pattern, void *);
Ilari Liusvaarab09fe972010-01-20 11:48:26 +020089extern int for_each_glob_ref_in(each_ref_fn, const char *pattern, const char* prefix, void *);
Linus Torvalds8a65ff72005-07-02 20:23:36 -070090
Heiko Voigt9ef6aeb2010-07-07 15:39:12 +020091extern int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
92extern int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
93extern int for_each_ref_in_submodule(const char *submodule, const char *prefix,
94 each_ref_fn fn, void *cb_data);
95extern int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
96extern int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
97extern int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data);
98
Josh Tripletta1bea2c2011-07-05 10:54:44 -070099extern int head_ref_namespaced(each_ref_fn fn, void *cb_data);
100extern int for_each_namespaced_ref(each_ref_fn fn, void *cb_data);
101
Thomas Rast894a9d32010-03-12 18:04:26 +0100102static inline const char *has_glob_specials(const char *pattern)
103{
104 return strpbrk(pattern, "?*[");
105}
106
Junio C Hamanof8948e22009-02-08 23:27:10 -0800107/* can be used to learn about broken ref and symref */
108extern int for_each_rawref(each_ref_fn, void *);
109
Jay Soffian3cf61342009-11-10 00:03:32 -0500110extern void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname);
David Aguilar24d36f12014-08-31 13:11:31 -0700111extern void warn_dangling_symrefs(FILE *fp, const char *msg_fmt, const struct string_list *refnames);
Junio C Hamanof8948e22009-02-08 23:27:10 -0800112
Daniel Barkalowe142a3c2008-04-27 13:39:24 -0400113/*
Michael Haggerty9f69d292013-06-20 10:37:46 +0200114 * Lock the packed-refs file for writing. Flags is passed to
115 * hold_lock_file_for_update(). Return 0 on success.
Ronnie Sahlberg447ff1b2014-06-20 07:42:48 -0700116 * Errno is set to something meaningful on error.
Michael Haggerty9f69d292013-06-20 10:37:46 +0200117 */
118extern int lock_packed_refs(int flags);
119
120/*
121 * Add a reference to the in-memory packed reference cache. This may
122 * only be called while the packed-refs file is locked (see
123 * lock_packed_refs()). To actually write the packed-refs file, call
124 * commit_packed_refs().
Michael Haggerty30249ee2012-01-17 06:50:33 +0100125 */
126extern void add_packed_ref(const char *refname, const unsigned char *sha1);
127
Michael Haggerty32d462c2013-04-22 21:52:32 +0200128/*
Michael Haggerty9f69d292013-06-20 10:37:46 +0200129 * Write the current version of the packed refs cache from memory to
130 * disk. The packed-refs file must already be locked for writing (see
131 * lock_packed_refs()). Return zero on success.
Ronnie Sahlbergd3f66552014-06-20 07:42:53 -0700132 * Sets errno to something meaningful on error.
Michael Haggerty9f69d292013-06-20 10:37:46 +0200133 */
134extern int commit_packed_refs(void);
135
136/*
137 * Rollback the lockfile for the packed-refs file, and discard the
138 * in-memory packed reference cache. (The packed-refs file will be
139 * read anew if it is needed again after this function is called.)
140 */
141extern void rollback_packed_refs(void);
142
143/*
Michael Haggerty32d462c2013-04-22 21:52:32 +0200144 * Flags for controlling behaviour of pack_refs()
145 * PACK_REFS_PRUNE: Prune loose refs after packing
146 * PACK_REFS_ALL: Pack _all_ refs, not just tags and already packed refs
147 */
148#define PACK_REFS_PRUNE 0x0001
149#define PACK_REFS_ALL 0x0002
150
151/*
152 * Write a packed-refs file for the current repository.
153 * flags: Combination of the above PACK_REFS_* flags.
154 */
155int pack_refs(unsigned int flags);
156
Michael Haggerty4a45b2f2014-11-25 09:02:32 +0100157/*
158 * Rewrite the packed-refs file, omitting any refs listed in
159 * 'refnames'. On error, packed-refs will be unchanged, the return
160 * value is nonzero, and a message about the error is written to the
161 * 'err' strbuf.
162 *
163 * The refs in 'refnames' needn't be sorted. `err` must not be NULL.
164 */
165extern int repack_without_refs(struct string_list *refnames,
Ronnie Sahlberg60bca082014-06-20 07:42:49 -0700166 struct strbuf *err);
Jens Lindströmc9e768b2014-05-23 12:29:45 +0200167
Junio C Hamano2c5c66b2011-10-10 15:56:19 -0700168extern int ref_exists(const char *);
Daniel Barkalowe142a3c2008-04-27 13:39:24 -0400169
Ronnie Sahlberge7e0f262014-07-15 16:02:38 -0700170extern int is_branch(const char *refname);
171
Michael Haggerty2312a792013-04-22 21:52:21 +0200172/*
173 * If refname is a non-symbolic reference that refers to a tag object,
174 * and the tag can be (recursively) dereferenced to a non-tag object,
175 * store the SHA1 of the referred-to object to sha1 and return 0. If
176 * any of these conditions are not met, return a non-zero value.
177 * Symbolic references are considered unpeelable, even if they
178 * ultimately resolve to a peelable tag.
179 */
Michael Haggertydfefa932011-12-12 06:38:09 +0100180extern int peel_ref(const char *refname, unsigned char *sha1);
Junio C Hamanocf0adba2006-11-19 13:22:44 -0800181
Ronnie Sahlberg835e3c92014-06-20 07:42:51 -0700182/*
Michael Haggerty31e07f72014-12-12 09:57:01 +0100183 * Flags controlling ref_transaction_update(), ref_transaction_create(), etc.
Ronnie Sahlberg029cdb42014-04-30 09:03:36 -0700184 * REF_NODEREF: act on the ref directly, instead of dereferencing
185 * symbolic references.
186 *
Michael Haggerty581d4e02015-02-12 12:12:12 +0100187 * Other flags are reserved for internal use.
Ronnie Sahlberg835e3c92014-06-20 07:42:51 -0700188 */
Sven Verdoolaege68db31c2007-05-09 12:33:20 +0200189#define REF_NODEREF 0x01
Shawn Pearce4bd18c42006-05-17 05:55:02 -0400190
Ronnie Sahlbergbd3b02d2014-06-20 07:42:50 -0700191/*
192 * Setup reflog before using. Set errno to something meaningful on failure.
193 */
Nguyễn Thái Ngọc Duy1a83c242014-11-30 15:24:28 +0700194int log_ref_setup(const char *refname, struct strbuf *logfile);
Erick Mattos859c3012010-05-21 21:28:36 -0300195
Shawn Pearced556fae2006-05-17 05:56:09 -0400196/** Reads log for the value of ref during at_time. **/
David Aguilarc41a87d2014-09-18 20:45:37 -0700197extern int read_ref_at(const char *refname, unsigned int flags,
198 unsigned long at_time, int cnt,
Michael Haggertydfefa932011-12-12 06:38:09 +0100199 unsigned char *sha1, char **msg,
200 unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt);
Shawn Pearced556fae2006-05-17 05:56:09 -0400201
Ronnie Sahlberg4da58832014-05-06 15:45:52 -0700202/** Check if a particular reflog exists */
203extern int reflog_exists(const char *refname);
204
205/** Delete a reflog */
206extern int delete_reflog(const char *refname);
207
Junio C Hamano2ff81662006-12-18 01:18:16 -0800208/* iterate over reflog entries */
Johannes Schindelin883d60f2007-01-08 01:59:54 +0100209typedef int each_reflog_ent_fn(unsigned char *osha1, unsigned char *nsha1, const char *, unsigned long, int, const char *, void *);
Michael Haggertydfefa932011-12-12 06:38:09 +0100210int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data);
Junio C Hamano98f85ff2013-03-08 13:27:37 -0800211int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data);
Junio C Hamano2ff81662006-12-18 01:18:16 -0800212
Nicolas Pitreeb8381c2007-02-03 13:25:43 -0500213/*
214 * Calls the specified function for each reflog file until it returns nonzero,
215 * and returns the value
216 */
217extern int for_each_reflog(each_ref_fn, void *);
218
Michael Haggerty8d9c5012011-09-15 23:10:25 +0200219#define REFNAME_ALLOW_ONELEVEL 1
220#define REFNAME_REFSPEC_PATTERN 2
221
222/*
Michael Haggertydfefa932011-12-12 06:38:09 +0100223 * Return 0 iff refname has the correct format for a refname according
224 * to the rules described in Documentation/git-check-ref-format.txt.
225 * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level
Michael Haggerty8d9c5012011-09-15 23:10:25 +0200226 * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then
227 * allow a "*" wildcard character in place of one of the name
Jonathan Niederf3cc52d2014-09-26 12:22:22 -0700228 * components. No leading or repeated slashes are accepted.
Michael Haggerty8d9c5012011-09-15 23:10:25 +0200229 */
Michael Haggertydfefa932011-12-12 06:38:09 +0100230extern int check_refname_format(const char *refname, int flags);
Daniel Barkalow95fc7512005-06-06 16:31:29 -0400231
Felipe Contreras4577e482009-05-14 00:22:04 +0300232extern const char *prettify_refname(const char *refname);
Michael Haggertydfefa932011-12-12 06:38:09 +0100233extern char *shorten_unambiguous_ref(const char *refname, int strict);
Daniel Barkalowa9c37a72009-03-08 21:06:05 -0400234
Lars Hjemlic976d412006-11-28 15:47:40 +0100235/** rename ref, return 0 on success **/
Lars Hjemli678d0f42006-11-30 03:16:56 +0100236extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);
Lars Hjemlic976d412006-11-28 15:47:40 +0100237
Michael Haggerty7f820bd2011-12-12 06:38:18 +0100238/**
239 * Resolve refname in the nested "gitlink" repository that is located
240 * at path. If the resolution is successful, return 0 and set sha1 to
241 * the name of the object; otherwise, return a non-zero value.
242 */
243extern int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1);
Linus Torvalds0ebde322007-04-09 21:14:26 -0700244
Michael Haggertyf4124112014-04-07 15:47:56 +0200245enum action_on_err {
246 UPDATE_REFS_MSG_ON_ERR,
247 UPDATE_REFS_DIE_ON_ERR,
248 UPDATE_REFS_QUIET_ON_ERR
249};
250
Michael Haggertycaa40462014-04-07 15:48:10 +0200251/*
252 * Begin a reference transaction. The reference transaction must
Ronnie Sahlberg33f9fc52014-06-20 07:42:43 -0700253 * be freed by calling ref_transaction_free().
Michael Haggertycaa40462014-04-07 15:48:10 +0200254 */
Ronnie Sahlberg93a644e2014-05-19 10:42:34 -0700255struct ref_transaction *ref_transaction_begin(struct strbuf *err);
Michael Haggertycaa40462014-04-07 15:48:10 +0200256
257/*
Michael Haggertyd1dd7212015-02-17 18:00:23 +0100258 * Reference transaction updates
259 *
260 * The following four functions add a reference check or update to a
261 * ref_transaction. They have some common similar parameters:
262 *
263 * transaction -- a pointer to an open ref_transaction, obtained
264 * from ref_transaction_begin().
265 *
266 * refname -- the name of the reference to be affected.
267 *
268 * flags -- flags affecting the update, passed to
269 * update_ref_lock(). Can be REF_NODEREF, which means that
270 * symbolic references should not be followed.
271 *
272 * msg -- a message describing the change (for the reflog).
273 *
274 * err -- a strbuf for receiving a description of any error that
275 * might have occured.
276 *
277 * The functions make internal copies of refname and msg, so the
278 * caller retains ownership of these parameters.
279 *
280 * The functions return 0 on success and non-zero on failure. A
281 * failure means that the transaction as a whole has failed and needs
282 * to be rolled back.
Michael Haggertycaa40462014-04-07 15:48:10 +0200283 */
284
Michael Haggertycaa40462014-04-07 15:48:10 +0200285/*
Michael Haggerty16180332015-02-17 18:00:21 +0100286 * Add a reference update to transaction. new_sha1 is the value that
287 * the reference should have after the update, or null_sha1 if it
288 * should be deleted. If new_sha1 is NULL, then the reference is not
289 * changed at all. old_sha1 is the value that the reference must have
290 * before the update, or null_sha1 if it must not have existed
291 * beforehand. The old value is checked after the lock is taken to
292 * prevent races. If the old value doesn't agree with old_sha1, the
293 * whole transaction fails. If old_sha1 is NULL, then the previous
294 * value is not checked.
295 *
Michael Haggertyd1dd7212015-02-17 18:00:23 +0100296 * See the above comment "Reference transaction updates" for more
297 * information.
Michael Haggertycaa40462014-04-07 15:48:10 +0200298 */
Ronnie Sahlberg8e348002014-06-20 07:43:00 -0700299int ref_transaction_update(struct ref_transaction *transaction,
300 const char *refname,
301 const unsigned char *new_sha1,
302 const unsigned char *old_sha1,
Michael Haggerty1d147bd2015-02-17 18:00:15 +0100303 unsigned int flags, const char *msg,
Ronnie Sahlberg8e348002014-06-20 07:43:00 -0700304 struct strbuf *err);
Michael Haggertycaa40462014-04-07 15:48:10 +0200305
306/*
Michael Haggertyd1dd7212015-02-17 18:00:23 +0100307 * Add a reference creation to transaction. new_sha1 is the value that
308 * the reference should have after the update; it must not be
309 * null_sha1. It is verified that the reference does not exist
Michael Haggertycaa40462014-04-07 15:48:10 +0200310 * already.
Michael Haggertyd1dd7212015-02-17 18:00:23 +0100311 *
312 * See the above comment "Reference transaction updates" for more
313 * information.
Michael Haggertycaa40462014-04-07 15:48:10 +0200314 */
Ronnie Sahlbergb416af52014-04-16 15:26:44 -0700315int ref_transaction_create(struct ref_transaction *transaction,
316 const char *refname,
317 const unsigned char *new_sha1,
Michael Haggertyfec14ec2015-02-17 18:00:13 +0100318 unsigned int flags, const char *msg,
Ronnie Sahlbergb416af52014-04-16 15:26:44 -0700319 struct strbuf *err);
Michael Haggertycaa40462014-04-07 15:48:10 +0200320
321/*
Michael Haggertyd1dd7212015-02-17 18:00:23 +0100322 * Add a reference deletion to transaction. If old_sha1 is non-NULL,
323 * then it holds the value that the reference should have had before
324 * the update (which must not be null_sha1).
325 *
326 * See the above comment "Reference transaction updates" for more
327 * information.
Michael Haggertycaa40462014-04-07 15:48:10 +0200328 */
Ronnie Sahlberg8c8bdc02014-04-16 15:27:45 -0700329int ref_transaction_delete(struct ref_transaction *transaction,
330 const char *refname,
331 const unsigned char *old_sha1,
Michael Haggertyfb5a6bb2015-02-17 18:00:16 +0100332 unsigned int flags, const char *msg,
Ronnie Sahlberg8c8bdc02014-04-16 15:27:45 -0700333 struct strbuf *err);
Michael Haggertycaa40462014-04-07 15:48:10 +0200334
335/*
Michael Haggerty16180332015-02-17 18:00:21 +0100336 * Verify, within a transaction, that refname has the value old_sha1,
337 * or, if old_sha1 is null_sha1, then verify that the reference
Michael Haggertyd1dd7212015-02-17 18:00:23 +0100338 * doesn't exist. old_sha1 must be non-NULL.
339 *
340 * See the above comment "Reference transaction updates" for more
341 * information.
Michael Haggerty16180332015-02-17 18:00:21 +0100342 */
343int ref_transaction_verify(struct ref_transaction *transaction,
344 const char *refname,
345 const unsigned char *old_sha1,
346 unsigned int flags,
347 struct strbuf *err);
348
349/*
Michael Haggertycaa40462014-04-07 15:48:10 +0200350 * Commit all of the changes that have been queued in transaction, as
Ronnie Sahlberg28e6a972014-05-16 14:14:38 -0700351 * atomically as possible.
352 *
353 * Returns 0 for success, or one of the below error codes for errors.
Michael Haggertycaa40462014-04-07 15:48:10 +0200354 */
Ronnie Sahlberg28e6a972014-05-16 14:14:38 -0700355/* Naming conflict (for example, the ref names A and A/B conflict). */
356#define TRANSACTION_NAME_CONFLICT -1
357/* All other errors. */
358#define TRANSACTION_GENERIC_ERROR -2
Michael Haggertycaa40462014-04-07 15:48:10 +0200359int ref_transaction_commit(struct ref_transaction *transaction,
Ronnie Sahlbergdb7516a2014-04-30 12:22:42 -0700360 struct strbuf *err);
Michael Haggertycaa40462014-04-07 15:48:10 +0200361
Ronnie Sahlberg026bd1d2014-06-20 07:42:42 -0700362/*
363 * Free an existing transaction and all associated data.
364 */
365void ref_transaction_free(struct ref_transaction *transaction);
366
Michael Haggerty4b7b5202015-02-17 18:00:22 +0100367/**
368 * Lock, update, and unlock a single reference. This function
369 * basically does a transaction containing a single call to
370 * ref_transaction_update(). The parameters to this function have the
371 * same meaning as the corresponding parameters to
372 * ref_transaction_update(). Handle errors as requested by the `onerr`
373 * argument.
374 */
375int update_ref(const char *msg, const char *refname,
376 const unsigned char *new_sha1, const unsigned char *old_sha1,
Michael Haggertyfec14ec2015-02-17 18:00:13 +0100377 unsigned int flags, enum action_on_err onerr);
Carlos Rica3d9f0372007-09-05 03:38:24 +0200378
Junio C Hamanodaebaa72013-01-18 16:08:30 -0800379extern int parse_hide_refs_config(const char *var, const char *value, const char *);
380extern int ref_is_hidden(const char *);
381
Michael Haggertyfa5b1832014-12-12 09:56:59 +0100382enum expire_reflog_flags {
383 EXPIRE_REFLOGS_DRY_RUN = 1 << 0,
384 EXPIRE_REFLOGS_UPDATE_REF = 1 << 1,
385 EXPIRE_REFLOGS_VERBOSE = 1 << 2,
386 EXPIRE_REFLOGS_REWRITE = 1 << 3
387};
388
389/*
390 * The following interface is used for reflog expiration. The caller
391 * calls reflog_expire(), supplying it with three callback functions,
392 * of the following types. The callback functions define the
393 * expiration policy that is desired.
394 *
395 * reflog_expiry_prepare_fn -- Called once after the reference is
396 * locked.
397 *
398 * reflog_expiry_should_prune_fn -- Called once for each entry in the
399 * existing reflog. It should return true iff that entry should be
400 * pruned.
401 *
402 * reflog_expiry_cleanup_fn -- Called once before the reference is
403 * unlocked again.
404 */
405typedef void reflog_expiry_prepare_fn(const char *refname,
406 const unsigned char *sha1,
407 void *cb_data);
408typedef int reflog_expiry_should_prune_fn(unsigned char *osha1,
409 unsigned char *nsha1,
410 const char *email,
411 unsigned long timestamp, int tz,
412 const char *message, void *cb_data);
413typedef void reflog_expiry_cleanup_fn(void *cb_data);
414
415/*
416 * Expire reflog entries for the specified reference. sha1 is the old
417 * value of the reference. flags is a combination of the constants in
418 * enum expire_reflog_flags. The three function pointers are described
419 * above. On success, return zero.
420 */
421extern int reflog_expire(const char *refname, const unsigned char *sha1,
422 unsigned int flags,
423 reflog_expiry_prepare_fn prepare_fn,
424 reflog_expiry_should_prune_fn should_prune_fn,
425 reflog_expiry_cleanup_fn cleanup_fn,
426 void *policy_cb_data);
427
Daniel Barkalow95fc7512005-06-06 16:31:29 -0400428#endif /* REFS_H */