11 * Resolve a reference, recursively following symbolic refererences.
13 * Return the name of the non-symbolic reference that ultimately pointed
14 * at the resolved object name. The return value, if not NULL, is a
15 * pointer into either a static buffer or the input ref.
17 * If sha1 is non-NULL, store the referred-to object's name in it.
19 * If the reference cannot be resolved to an object, the behavior
20 * depends on the RESOLVE_REF_READING flag:
22 * - If RESOLVE_REF_READING is set, return NULL.
24 * - If RESOLVE_REF_READING is not set, clear sha1 and return the name of
25 * the last reference name in the chain, which will either be a non-symbolic
26 * reference or an undefined reference. If this is a prelude to
27 * "writing" to the ref, the return value is the name of the ref
28 * that will actually be created or changed.
30 * If the RESOLVE_REF_NO_RECURSE flag is passed, only resolves one
31 * level of symbolic reference. The value stored in sha1 for a symbolic
32 * reference will always be null_sha1 in this case, and the return
33 * value is the reference that the symref refers to directly.
35 * If flags is non-NULL, set the value that it points to the
36 * combination of REF_ISPACKED (if the reference was found among the
37 * packed references), REF_ISSYMREF (if the initial reference was a
38 * symbolic reference), REF_BAD_NAME (if the reference name is ill
39 * formed --- see RESOLVE_REF_ALLOW_BAD_NAME below), and REF_ISBROKEN
40 * (if the ref is malformed or has a bad name). See refs.h for more detail
43 * If ref is not a properly-formatted, normalized reference, return
44 * NULL. If more than MAXDEPTH recursive symbolic lookups are needed,
45 * give up and return NULL.
47 * RESOLVE_REF_ALLOW_BAD_NAME allows resolving refs even when their
48 * name is invalid according to git-check-ref-format(1). If the name
49 * is bad then the value stored in sha1 will be null_sha1 and the two
50 * flags REF_ISBROKEN and REF_BAD_NAME will be set.
52 * Even with RESOLVE_REF_ALLOW_BAD_NAME, names that escape the refs/
53 * directory and do not consist of all caps and underscores cannot be
54 * resolved. The function returns NULL for such ref names.
55 * Caps and underscores refers to the special refs, such as HEAD,
56 * FETCH_HEAD and friends, that all live outside of the refs/ directory.
58 #define RESOLVE_REF_READING 0x01
59 #define RESOLVE_REF_NO_RECURSE 0x02
60 #define RESOLVE_REF_ALLOW_BAD_NAME 0x04
62 const char *refs_resolve_ref_unsafe(struct ref_store
*refs
,
67 const char *resolve_ref_unsafe(const char *refname
, int resolve_flags
,
68 unsigned char *sha1
, int *flags
);
70 char *refs_resolve_refdup(struct ref_store
*refs
,
71 const char *refname
, int resolve_flags
,
72 unsigned char *sha1
, int *flags
);
73 char *resolve_refdup(const char *refname
, int resolve_flags
,
74 unsigned char *sha1
, int *flags
);
76 int refs_read_ref_full(struct ref_store
*refs
, const char *refname
,
77 int resolve_flags
, unsigned char *sha1
, int *flags
);
78 int read_ref_full(const char *refname
, int resolve_flags
,
79 unsigned char *sha1
, int *flags
);
80 int read_ref(const char *refname
, unsigned char *sha1
);
83 * Return 0 if a reference named refname could be created without
84 * conflicting with the name of an existing reference. Otherwise,
85 * return a negative value and write an explanation to err. If extras
86 * is non-NULL, it is a list of additional refnames with which refname
87 * is not allowed to conflict. If skip is non-NULL, ignore potential
88 * conflicts with refs in skip (e.g., because they are scheduled for
89 * deletion in the same operation). Behavior is undefined if the same
90 * name is listed in both extras and skip.
92 * Two reference names conflict if one of them exactly matches the
93 * leading components of the other; e.g., "foo/bar" conflicts with
94 * both "foo" and with "foo/bar/baz" but not with "foo/bar" or
97 * extras and skip must be sorted.
100 int refs_verify_refname_available(struct ref_store
*refs
,
102 const struct string_list
*extras
,
103 const struct string_list
*skip
,
106 int ref_exists(const char *refname
);
108 int should_autocreate_reflog(const char *refname
);
110 int is_branch(const char *refname
);
112 extern int refs_init_db(struct strbuf
*err
);
115 * If refname is a non-symbolic reference that refers to a tag object,
116 * and the tag can be (recursively) dereferenced to a non-tag object,
117 * store the SHA1 of the referred-to object to sha1 and return 0. If
118 * any of these conditions are not met, return a non-zero value.
119 * Symbolic references are considered unpeelable, even if they
120 * ultimately resolve to a peelable tag.
122 int refs_peel_ref(struct ref_store
*refs
, const char *refname
,
123 unsigned char *sha1
);
124 int peel_ref(const char *refname
, unsigned char *sha1
);
127 * Resolve refname in the nested "gitlink" repository in the specified
128 * submodule (which must be non-NULL). If the resolution is
129 * successful, return 0 and set sha1 to the name of the object;
130 * otherwise, return a non-zero value.
132 int resolve_gitlink_ref(const char *submodule
, const char *refname
,
133 unsigned char *sha1
);
136 * Return true iff abbrev_name is a possible abbreviation for
137 * full_name according to the rules defined by ref_rev_parse_rules in
140 int refname_match(const char *abbrev_name
, const char *full_name
);
142 int expand_ref(const char *str
, int len
, unsigned char *sha1
, char **ref
);
143 int dwim_ref(const char *str
, int len
, unsigned char *sha1
, char **ref
);
144 int dwim_log(const char *str
, int len
, unsigned char *sha1
, char **ref
);
147 * A ref_transaction represents a collection of reference updates that
148 * should succeed or fail together.
153 * - Allocate and initialize a `struct ref_transaction` by calling
154 * `ref_transaction_begin()`.
156 * - Specify the intended ref updates by calling one or more of the
157 * following functions:
158 * - `ref_transaction_update()`
159 * - `ref_transaction_create()`
160 * - `ref_transaction_delete()`
161 * - `ref_transaction_verify()`
165 * - Optionally call `ref_transaction_prepare()` to prepare the
166 * transaction. This locks all references, checks preconditions,
167 * etc. but doesn't finalize anything. If this step fails, the
168 * transaction has been closed and can only be freed. If this step
169 * succeeds, then `ref_transaction_commit()` is almost certain to
170 * succeed. However, you can still call `ref_transaction_abort()`
171 * if you decide not to commit the transaction after all.
173 * - Call `ref_transaction_commit()` to execute the transaction,
174 * make the changes permanent, and release all locks. If you
175 * haven't already called `ref_transaction_prepare()`, then
176 * `ref_transaction_commit()` calls it for you.
180 * - Call `initial_ref_transaction_commit()` if the ref database is
181 * known to be empty and have no other writers (e.g. during
182 * clone). This is likely to be much faster than
183 * `ref_transaction_commit()`. `ref_transaction_prepare()` should
184 * *not* be called before `initial_ref_transaction_commit()`.
186 * - Then finally, call `ref_transaction_free()` to free the
187 * `ref_transaction` data structure.
189 * At any time before calling `ref_transaction_commit()`, you can call
190 * `ref_transaction_abort()` to abort the transaction, rollback any
191 * locks, and free any associated resources (including the
192 * `ref_transaction` data structure).
194 * Putting it all together, a complete reference update looks like
196 * struct ref_transaction *transaction;
197 * struct strbuf err = STRBUF_INIT;
200 * transaction = ref_store_transaction_begin(refs, &err);
201 * if (!transaction ||
202 * ref_transaction_update(...) ||
203 * ref_transaction_create(...) ||
205 * ref_transaction_commit(transaction, &err)) {
206 * error("%s", err.buf);
209 * ref_transaction_free(transaction);
210 * strbuf_release(&err);
216 * On error, transaction functions append a message about what
217 * went wrong to the 'err' argument. The message mentions what
218 * ref was being updated (if any) when the error occurred so it
219 * can be passed to 'die' or 'error' as-is.
221 * The message is appended to err without first clearing err.
222 * err will not be '\n' terminated.
227 * Note that no locks are taken, and no refs are read, until
228 * `ref_transaction_prepare()` or `ref_transaction_commit()` is
229 * called. So, for example, `ref_transaction_verify()` won't report a
230 * verification failure until the commit is attempted.
232 struct ref_transaction
;
235 * Bit values set in the flags argument passed to each_ref_fn() and
236 * stored in ref_iterator::flags. Other bits are for internal use
240 /* Reference is a symbolic reference. */
241 #define REF_ISSYMREF 0x01
243 /* Reference is a packed reference. */
244 #define REF_ISPACKED 0x02
247 * Reference cannot be resolved to an object name: dangling symbolic
248 * reference (directly or indirectly), corrupt reference file,
249 * reference exists but name is bad, or symbolic reference refers to
250 * ill-formatted reference name.
252 #define REF_ISBROKEN 0x04
255 * Reference name is not well formed.
257 * See git-check-ref-format(1) for the definition of well formed ref names.
259 #define REF_BAD_NAME 0x08
262 * The signature for the callback function for the for_each_*()
263 * functions below. The memory pointed to by the refname and sha1
264 * arguments is only guaranteed to be valid for the duration of a
265 * single callback invocation.
267 typedef int each_ref_fn(const char *refname
,
268 const struct object_id
*oid
, int flags
, void *cb_data
);
271 * The following functions invoke the specified callback function for
272 * each reference indicated. If the function ever returns a nonzero
273 * value, stop the iteration and return that value. Please note that
274 * it is not safe to modify references while an iteration is in
275 * progress, unless the same callback function invocation that
276 * modifies the reference also returns a nonzero value to immediately
277 * stop the iteration. Returned references are sorted.
279 int refs_head_ref(struct ref_store
*refs
,
280 each_ref_fn fn
, void *cb_data
);
281 int refs_for_each_ref(struct ref_store
*refs
,
282 each_ref_fn fn
, void *cb_data
);
283 int refs_for_each_ref_in(struct ref_store
*refs
, const char *prefix
,
284 each_ref_fn fn
, void *cb_data
);
285 int refs_for_each_tag_ref(struct ref_store
*refs
,
286 each_ref_fn fn
, void *cb_data
);
287 int refs_for_each_branch_ref(struct ref_store
*refs
,
288 each_ref_fn fn
, void *cb_data
);
289 int refs_for_each_remote_ref(struct ref_store
*refs
,
290 each_ref_fn fn
, void *cb_data
);
292 int head_ref(each_ref_fn fn
, void *cb_data
);
293 int for_each_ref(each_ref_fn fn
, void *cb_data
);
294 int for_each_ref_in(const char *prefix
, each_ref_fn fn
, void *cb_data
);
295 int refs_for_each_fullref_in(struct ref_store
*refs
, const char *prefix
,
296 each_ref_fn fn
, void *cb_data
,
297 unsigned int broken
);
298 int for_each_fullref_in(const char *prefix
, each_ref_fn fn
, void *cb_data
,
299 unsigned int broken
);
300 int for_each_tag_ref(each_ref_fn fn
, void *cb_data
);
301 int for_each_branch_ref(each_ref_fn fn
, void *cb_data
);
302 int for_each_remote_ref(each_ref_fn fn
, void *cb_data
);
303 int for_each_replace_ref(each_ref_fn fn
, void *cb_data
);
304 int for_each_glob_ref(each_ref_fn fn
, const char *pattern
, void *cb_data
);
305 int for_each_glob_ref_in(each_ref_fn fn
, const char *pattern
,
306 const char *prefix
, void *cb_data
);
308 int head_ref_namespaced(each_ref_fn fn
, void *cb_data
);
309 int for_each_namespaced_ref(each_ref_fn fn
, void *cb_data
);
311 /* can be used to learn about broken ref and symref */
312 int refs_for_each_rawref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
);
313 int for_each_rawref(each_ref_fn fn
, void *cb_data
);
315 static inline const char *has_glob_specials(const char *pattern
)
317 return strpbrk(pattern
, "?*[");
320 void warn_dangling_symref(FILE *fp
, const char *msg_fmt
, const char *refname
);
321 void warn_dangling_symrefs(FILE *fp
, const char *msg_fmt
,
322 const struct string_list
*refnames
);
325 * Flags for controlling behaviour of pack_refs()
326 * PACK_REFS_PRUNE: Prune loose refs after packing
327 * PACK_REFS_ALL: Pack _all_ refs, not just tags and already packed refs
329 #define PACK_REFS_PRUNE 0x0001
330 #define PACK_REFS_ALL 0x0002
333 * Write a packed-refs file for the current repository.
334 * flags: Combination of the above PACK_REFS_* flags.
336 int refs_pack_refs(struct ref_store
*refs
, unsigned int flags
);
339 * Flags controlling ref_transaction_update(), ref_transaction_create(), etc.
340 * REF_NODEREF: act on the ref directly, instead of dereferencing
341 * symbolic references.
343 * Other flags are reserved for internal use.
345 #define REF_NODEREF 0x01
346 #define REF_FORCE_CREATE_REFLOG 0x40
349 * Flags that can be passed in to ref_transaction_update
351 #define REF_TRANSACTION_UPDATE_ALLOWED_FLAGS \
353 REF_FORCE_CREATE_REFLOG | \
357 * Setup reflog before using. Fill in err and return -1 on failure.
359 int refs_create_reflog(struct ref_store
*refs
, const char *refname
,
360 int force_create
, struct strbuf
*err
);
361 int safe_create_reflog(const char *refname
, int force_create
, struct strbuf
*err
);
363 /** Reads log for the value of ref during at_time. **/
364 int read_ref_at(const char *refname
, unsigned int flags
,
365 timestamp_t at_time
, int cnt
,
366 unsigned char *sha1
, char **msg
,
367 timestamp_t
*cutoff_time
, int *cutoff_tz
, int *cutoff_cnt
);
369 /** Check if a particular reflog exists */
370 int refs_reflog_exists(struct ref_store
*refs
, const char *refname
);
371 int reflog_exists(const char *refname
);
374 * Delete the specified reference. If old_sha1 is non-NULL, then
375 * verify that the current value of the reference is old_sha1 before
376 * deleting it. If old_sha1 is NULL, delete the reference if it
377 * exists, regardless of its old value. It is an error for old_sha1 to
378 * be NULL_SHA1. msg and flags are passed through to
379 * ref_transaction_delete().
381 int refs_delete_ref(struct ref_store
*refs
, const char *msg
,
383 const unsigned char *old_sha1
,
385 int delete_ref(const char *msg
, const char *refname
,
386 const unsigned char *old_sha1
, unsigned int flags
);
389 * Delete the specified references. If there are any problems, emit
390 * errors but attempt to keep going (i.e., the deletes are not done in
391 * an all-or-nothing transaction). msg and flags are passed through to
392 * ref_transaction_delete().
394 int refs_delete_refs(struct ref_store
*refs
, const char *msg
,
395 struct string_list
*refnames
, unsigned int flags
);
396 int delete_refs(const char *msg
, struct string_list
*refnames
,
399 /** Delete a reflog */
400 int refs_delete_reflog(struct ref_store
*refs
, const char *refname
);
401 int delete_reflog(const char *refname
);
403 /* iterate over reflog entries */
404 typedef int each_reflog_ent_fn(
405 struct object_id
*old_oid
, struct object_id
*new_oid
,
406 const char *committer
, timestamp_t timestamp
,
407 int tz
, const char *msg
, void *cb_data
);
409 int refs_for_each_reflog_ent(struct ref_store
*refs
, const char *refname
,
410 each_reflog_ent_fn fn
, void *cb_data
);
411 int refs_for_each_reflog_ent_reverse(struct ref_store
*refs
,
413 each_reflog_ent_fn fn
,
415 int for_each_reflog_ent(const char *refname
, each_reflog_ent_fn fn
, void *cb_data
);
416 int for_each_reflog_ent_reverse(const char *refname
, each_reflog_ent_fn fn
, void *cb_data
);
419 * Calls the specified function for each reflog file until it returns nonzero,
420 * and returns the value. Reflog file order is unspecified.
422 int refs_for_each_reflog(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
);
423 int for_each_reflog(each_ref_fn fn
, void *cb_data
);
425 #define REFNAME_ALLOW_ONELEVEL 1
426 #define REFNAME_REFSPEC_PATTERN 2
429 * Return 0 iff refname has the correct format for a refname according
430 * to the rules described in Documentation/git-check-ref-format.txt.
431 * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level
432 * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then
433 * allow a single "*" wildcard character in the refspec. No leading or
434 * repeated slashes are accepted.
436 int check_refname_format(const char *refname
, int flags
);
438 const char *prettify_refname(const char *refname
);
440 char *shorten_unambiguous_ref(const char *refname
, int strict
);
442 /** rename ref, return 0 on success **/
443 int refs_rename_ref(struct ref_store
*refs
, const char *oldref
,
444 const char *newref
, const char *logmsg
);
445 int rename_ref(const char *oldref
, const char *newref
, const char *logmsg
);
447 int refs_create_symref(struct ref_store
*refs
, const char *refname
,
448 const char *target
, const char *logmsg
);
449 int create_symref(const char *refname
, const char *target
, const char *logmsg
);
452 UPDATE_REFS_MSG_ON_ERR
,
453 UPDATE_REFS_DIE_ON_ERR
,
454 UPDATE_REFS_QUIET_ON_ERR
458 * Begin a reference transaction. The reference transaction must
459 * be freed by calling ref_transaction_free().
461 struct ref_transaction
*ref_store_transaction_begin(struct ref_store
*refs
,
463 struct ref_transaction
*ref_transaction_begin(struct strbuf
*err
);
466 * Reference transaction updates
468 * The following four functions add a reference check or update to a
469 * ref_transaction. They have some common similar parameters:
471 * transaction -- a pointer to an open ref_transaction, obtained
472 * from ref_transaction_begin().
474 * refname -- the name of the reference to be affected.
476 * new_sha1 -- the SHA-1 that should be set to be the new value of
477 * the reference. Some functions allow this parameter to be
478 * NULL, meaning that the reference is not changed, or
479 * null_sha1, meaning that the reference should be deleted. A
480 * copy of this value is made in the transaction.
482 * old_sha1 -- the SHA-1 value that the reference must have before
483 * the update. Some functions allow this parameter to be NULL,
484 * meaning that the old value of the reference is not checked,
485 * or null_sha1, meaning that the reference must not exist
486 * before the update. A copy of this value is made in the
489 * flags -- flags affecting the update, passed to
490 * update_ref_lock(). Can be REF_NODEREF, which means that
491 * symbolic references should not be followed.
493 * msg -- a message describing the change (for the reflog).
495 * err -- a strbuf for receiving a description of any error that
496 * might have occurred.
498 * The functions make internal copies of refname and msg, so the
499 * caller retains ownership of these parameters.
501 * The functions return 0 on success and non-zero on failure. A
502 * failure means that the transaction as a whole has failed and needs
507 * Add a reference update to transaction. new_sha1 is the value that
508 * the reference should have after the update, or null_sha1 if it
509 * should be deleted. If new_sha1 is NULL, then the reference is not
510 * changed at all. old_sha1 is the value that the reference must have
511 * before the update, or null_sha1 if it must not have existed
512 * beforehand. The old value is checked after the lock is taken to
513 * prevent races. If the old value doesn't agree with old_sha1, the
514 * whole transaction fails. If old_sha1 is NULL, then the previous
515 * value is not checked.
517 * See the above comment "Reference transaction updates" for more
520 int ref_transaction_update(struct ref_transaction
*transaction
,
522 const unsigned char *new_sha1
,
523 const unsigned char *old_sha1
,
524 unsigned int flags
, const char *msg
,
528 * Add a reference creation to transaction. new_sha1 is the value that
529 * the reference should have after the update; it must not be
530 * null_sha1. It is verified that the reference does not exist
533 * See the above comment "Reference transaction updates" for more
536 int ref_transaction_create(struct ref_transaction
*transaction
,
538 const unsigned char *new_sha1
,
539 unsigned int flags
, const char *msg
,
543 * Add a reference deletion to transaction. If old_sha1 is non-NULL,
544 * then it holds the value that the reference should have had before
545 * the update (which must not be null_sha1).
547 * See the above comment "Reference transaction updates" for more
550 int ref_transaction_delete(struct ref_transaction
*transaction
,
552 const unsigned char *old_sha1
,
553 unsigned int flags
, const char *msg
,
557 * Verify, within a transaction, that refname has the value old_sha1,
558 * or, if old_sha1 is null_sha1, then verify that the reference
559 * doesn't exist. old_sha1 must be non-NULL.
561 * See the above comment "Reference transaction updates" for more
564 int ref_transaction_verify(struct ref_transaction
*transaction
,
566 const unsigned char *old_sha1
,
570 /* Naming conflict (for example, the ref names A and A/B conflict). */
571 #define TRANSACTION_NAME_CONFLICT -1
572 /* All other errors. */
573 #define TRANSACTION_GENERIC_ERROR -2
576 * Perform the preparatory stages of committing `transaction`. Acquire
577 * any needed locks, check preconditions, etc.; basically, do as much
578 * as possible to ensure that the transaction will be able to go
579 * through, stopping just short of making any irrevocable or
580 * user-visible changes. The updates that this function prepares can
581 * be finished up by calling `ref_transaction_commit()` or rolled back
582 * by calling `ref_transaction_abort()`.
584 * On success, return 0 and leave the transaction in "prepared" state.
585 * On failure, abort the transaction, write an error message to `err`,
586 * and return one of the `TRANSACTION_*` constants.
588 * Callers who don't need such fine-grained control over committing
589 * reference transactions should just call `ref_transaction_commit()`.
591 int ref_transaction_prepare(struct ref_transaction
*transaction
,
595 * Commit all of the changes that have been queued in transaction, as
596 * atomically as possible. On success, return 0 and leave the
597 * transaction in "closed" state. On failure, roll back the
598 * transaction, write an error message to `err`, and return one of the
599 * `TRANSACTION_*` constants
601 int ref_transaction_commit(struct ref_transaction
*transaction
,
605 * Abort `transaction`, which has been begun and possibly prepared,
606 * but not yet committed.
608 int ref_transaction_abort(struct ref_transaction
*transaction
,
612 * Like ref_transaction_commit(), but optimized for creating
613 * references when originally initializing a repository (e.g., by "git
614 * clone"). It writes the new references directly to packed-refs
615 * without locking the individual references.
617 * It is a bug to call this function when there might be other
618 * processes accessing the repository or if there are existing
619 * references that might conflict with the ones being created. All
620 * old_sha1 values must either be absent or NULL_SHA1.
622 int initial_ref_transaction_commit(struct ref_transaction
*transaction
,
626 * Free `*transaction` and all associated data.
628 void ref_transaction_free(struct ref_transaction
*transaction
);
631 * Lock, update, and unlock a single reference. This function
632 * basically does a transaction containing a single call to
633 * ref_transaction_update(). The parameters to this function have the
634 * same meaning as the corresponding parameters to
635 * ref_transaction_update(). Handle errors as requested by the `onerr`
638 int refs_update_ref(struct ref_store
*refs
, const char *msg
, const char *refname
,
639 const unsigned char *new_sha1
, const unsigned char *old_sha1
,
640 unsigned int flags
, enum action_on_err onerr
);
641 int update_ref(const char *msg
, const char *refname
,
642 const unsigned char *new_sha1
, const unsigned char *old_sha1
,
643 unsigned int flags
, enum action_on_err onerr
);
644 int update_ref_oid(const char *msg
, const char *refname
,
645 const struct object_id
*new_oid
, const struct object_id
*old_oid
,
646 unsigned int flags
, enum action_on_err onerr
);
648 int parse_hide_refs_config(const char *var
, const char *value
, const char *);
651 * Check whether a ref is hidden. If no namespace is set, both the first and
652 * the second parameter point to the full ref name. If a namespace is set and
653 * the ref is inside that namespace, the first parameter is a pointer to the
654 * name of the ref with the namespace prefix removed. If a namespace is set and
655 * the ref is outside that namespace, the first parameter is NULL. The second
656 * parameter always points to the full ref name.
658 int ref_is_hidden(const char *, const char *);
661 REF_TYPE_PER_WORKTREE
,
666 enum ref_type
ref_type(const char *refname
);
668 enum expire_reflog_flags
{
669 EXPIRE_REFLOGS_DRY_RUN
= 1 << 0,
670 EXPIRE_REFLOGS_UPDATE_REF
= 1 << 1,
671 EXPIRE_REFLOGS_VERBOSE
= 1 << 2,
672 EXPIRE_REFLOGS_REWRITE
= 1 << 3
676 * The following interface is used for reflog expiration. The caller
677 * calls reflog_expire(), supplying it with three callback functions,
678 * of the following types. The callback functions define the
679 * expiration policy that is desired.
681 * reflog_expiry_prepare_fn -- Called once after the reference is
684 * reflog_expiry_should_prune_fn -- Called once for each entry in the
685 * existing reflog. It should return true iff that entry should be
688 * reflog_expiry_cleanup_fn -- Called once before the reference is
691 typedef void reflog_expiry_prepare_fn(const char *refname
,
692 const struct object_id
*oid
,
694 typedef int reflog_expiry_should_prune_fn(struct object_id
*ooid
,
695 struct object_id
*noid
,
697 timestamp_t timestamp
, int tz
,
698 const char *message
, void *cb_data
);
699 typedef void reflog_expiry_cleanup_fn(void *cb_data
);
702 * Expire reflog entries for the specified reference. sha1 is the old
703 * value of the reference. flags is a combination of the constants in
704 * enum expire_reflog_flags. The three function pointers are described
705 * above. On success, return zero.
707 int refs_reflog_expire(struct ref_store
*refs
,
709 const unsigned char *sha1
,
711 reflog_expiry_prepare_fn prepare_fn
,
712 reflog_expiry_should_prune_fn should_prune_fn
,
713 reflog_expiry_cleanup_fn cleanup_fn
,
714 void *policy_cb_data
);
715 int reflog_expire(const char *refname
, const unsigned char *sha1
,
717 reflog_expiry_prepare_fn prepare_fn
,
718 reflog_expiry_should_prune_fn should_prune_fn
,
719 reflog_expiry_cleanup_fn cleanup_fn
,
720 void *policy_cb_data
);
722 int ref_storage_backend_exists(const char *name
);
724 struct ref_store
*get_main_ref_store(void);
726 * Return the ref_store instance for the specified submodule. For the
727 * main repository, use submodule==NULL; such a call cannot fail. For
728 * a submodule, the submodule must exist and be a nonbare repository,
729 * otherwise return NULL. If the requested reference store has not yet
730 * been initialized, initialize it first.
732 * For backwards compatibility, submodule=="" is treated the same as
735 struct ref_store
*get_submodule_ref_store(const char *submodule
);
736 struct ref_store
*get_worktree_ref_store(const struct worktree
*wt
);