The ninth batch
[git.git] / refs.h
blob48970dfc7e0f0d6263a3faca9d92aa887a60d0e4
1 #ifndef REFS_H
2 #define REFS_H
4 #include "cache.h"
6 struct object_id;
7 struct ref_store;
8 struct repository;
9 struct strbuf;
10 struct string_list;
11 struct string_list_item;
12 struct worktree;
15 * Resolve a reference, recursively following symbolic refererences.
17 * Return the name of the non-symbolic reference that ultimately pointed
18 * at the resolved object name. The return value, if not NULL, is a
19 * pointer into either a static buffer or the input ref.
21 * If oid is non-NULL, store the referred-to object's name in it.
23 * If the reference cannot be resolved to an object, the behavior
24 * depends on the RESOLVE_REF_READING flag:
26 * - If RESOLVE_REF_READING is set, return NULL.
28 * - If RESOLVE_REF_READING is not set, clear oid and return the name of
29 * the last reference name in the chain, which will either be a non-symbolic
30 * reference or an undefined reference. If this is a prelude to
31 * "writing" to the ref, the return value is the name of the ref
32 * that will actually be created or changed.
34 * If the RESOLVE_REF_NO_RECURSE flag is passed, only resolves one
35 * level of symbolic reference. The value stored in oid for a symbolic
36 * reference will always be null_oid in this case, and the return
37 * value is the reference that the symref refers to directly.
39 * If flags is non-NULL, set the value that it points to the
40 * combination of REF_ISPACKED (if the reference was found among the
41 * packed references), REF_ISSYMREF (if the initial reference was a
42 * symbolic reference), REF_BAD_NAME (if the reference name is ill
43 * formed --- see RESOLVE_REF_ALLOW_BAD_NAME below), and REF_ISBROKEN
44 * (if the ref is malformed or has a bad name). See refs.h for more detail
45 * on each flag.
47 * If ref is not a properly-formatted, normalized reference, return
48 * NULL. If more than MAXDEPTH recursive symbolic lookups are needed,
49 * give up and return NULL.
51 * RESOLVE_REF_ALLOW_BAD_NAME allows resolving refs even when their
52 * name is invalid according to git-check-ref-format(1). If the name
53 * is bad then the value stored in oid will be null_oid and the two
54 * flags REF_ISBROKEN and REF_BAD_NAME will be set.
56 * Even with RESOLVE_REF_ALLOW_BAD_NAME, names that escape the refs/
57 * directory and do not consist of all caps and underscores cannot be
58 * resolved. The function returns NULL for such ref names.
59 * Caps and underscores refers to the special refs, such as HEAD,
60 * FETCH_HEAD and friends, that all live outside of the refs/ directory.
62 #define RESOLVE_REF_READING 0x01
63 #define RESOLVE_REF_NO_RECURSE 0x02
64 #define RESOLVE_REF_ALLOW_BAD_NAME 0x04
66 const char *refs_resolve_ref_unsafe(struct ref_store *refs,
67 const char *refname,
68 int resolve_flags,
69 struct object_id *oid,
70 int *flags);
71 const char *resolve_ref_unsafe(const char *refname, int resolve_flags,
72 struct object_id *oid, int *flags);
74 char *refs_resolve_refdup(struct ref_store *refs,
75 const char *refname, int resolve_flags,
76 struct object_id *oid, int *flags);
77 char *resolve_refdup(const char *refname, int resolve_flags,
78 struct object_id *oid, int *flags);
80 int refs_read_ref_full(struct ref_store *refs, const char *refname,
81 int resolve_flags, struct object_id *oid, int *flags);
82 int read_ref_full(const char *refname, int resolve_flags,
83 struct object_id *oid, int *flags);
84 int read_ref(const char *refname, struct object_id *oid);
87 * Return 0 if a reference named refname could be created without
88 * conflicting with the name of an existing reference. Otherwise,
89 * return a negative value and write an explanation to err. If extras
90 * is non-NULL, it is a list of additional refnames with which refname
91 * is not allowed to conflict. If skip is non-NULL, ignore potential
92 * conflicts with refs in skip (e.g., because they are scheduled for
93 * deletion in the same operation). Behavior is undefined if the same
94 * name is listed in both extras and skip.
96 * Two reference names conflict if one of them exactly matches the
97 * leading components of the other; e.g., "foo/bar" conflicts with
98 * both "foo" and with "foo/bar/baz" but not with "foo/bar" or
99 * "foo/barbados".
101 * extras and skip must be sorted.
104 int refs_verify_refname_available(struct ref_store *refs,
105 const char *refname,
106 const struct string_list *extras,
107 const struct string_list *skip,
108 struct strbuf *err);
110 int refs_ref_exists(struct ref_store *refs, const char *refname);
112 int ref_exists(const char *refname);
114 int should_autocreate_reflog(const char *refname);
116 int is_branch(const char *refname);
118 int refs_init_db(struct strbuf *err);
121 * Return the peeled value of the oid currently being iterated via
122 * for_each_ref(), etc. This is equivalent to calling:
124 * peel_object(oid, &peeled);
126 * with the "oid" value given to the each_ref_fn callback, except
127 * that some ref storage may be able to answer the query without
128 * actually loading the object in memory.
130 int peel_iterated_oid(const struct object_id *base, struct object_id *peeled);
133 * Resolve refname in the nested "gitlink" repository in the specified
134 * submodule (which must be non-NULL). If the resolution is
135 * successful, return 0 and set oid to the name of the object;
136 * otherwise, return a non-zero value.
138 int resolve_gitlink_ref(const char *submodule, const char *refname,
139 struct object_id *oid);
142 * Return true iff abbrev_name is a possible abbreviation for
143 * full_name according to the rules defined by ref_rev_parse_rules in
144 * refs.c.
146 int refname_match(const char *abbrev_name, const char *full_name);
149 * Given a 'prefix' expand it by the rules in 'ref_rev_parse_rules' and add
150 * the results to 'prefixes'
152 struct strvec;
153 void expand_ref_prefix(struct strvec *prefixes, const char *prefix);
155 int expand_ref(struct repository *r, const char *str, int len, struct object_id *oid, char **ref);
156 int repo_dwim_ref(struct repository *r, const char *str, int len,
157 struct object_id *oid, char **ref, int nonfatal_dangling_mark);
158 int repo_dwim_log(struct repository *r, const char *str, int len, struct object_id *oid, char **ref);
159 static inline int dwim_ref(const char *str, int len, struct object_id *oid,
160 char **ref, int nonfatal_dangling_mark)
162 return repo_dwim_ref(the_repository, str, len, oid, ref,
163 nonfatal_dangling_mark);
165 int dwim_log(const char *str, int len, struct object_id *oid, char **ref);
168 * Retrieves the default branch name for newly-initialized repositories.
170 * The return value of `repo_default_branch_name()` is an allocated string. The
171 * return value of `git_default_branch_name()` is a singleton.
173 const char *git_default_branch_name(int quiet);
174 char *repo_default_branch_name(struct repository *r, int quiet);
177 * A ref_transaction represents a collection of reference updates that
178 * should succeed or fail together.
180 * Calling sequence
181 * ----------------
183 * - Allocate and initialize a `struct ref_transaction` by calling
184 * `ref_transaction_begin()`.
186 * - Specify the intended ref updates by calling one or more of the
187 * following functions:
188 * - `ref_transaction_update()`
189 * - `ref_transaction_create()`
190 * - `ref_transaction_delete()`
191 * - `ref_transaction_verify()`
193 * - Then either:
195 * - Optionally call `ref_transaction_prepare()` to prepare the
196 * transaction. This locks all references, checks preconditions,
197 * etc. but doesn't finalize anything. If this step fails, the
198 * transaction has been closed and can only be freed. If this step
199 * succeeds, then `ref_transaction_commit()` is almost certain to
200 * succeed. However, you can still call `ref_transaction_abort()`
201 * if you decide not to commit the transaction after all.
203 * - Call `ref_transaction_commit()` to execute the transaction,
204 * make the changes permanent, and release all locks. If you
205 * haven't already called `ref_transaction_prepare()`, then
206 * `ref_transaction_commit()` calls it for you.
208 * Or
210 * - Call `initial_ref_transaction_commit()` if the ref database is
211 * known to be empty and have no other writers (e.g. during
212 * clone). This is likely to be much faster than
213 * `ref_transaction_commit()`. `ref_transaction_prepare()` should
214 * *not* be called before `initial_ref_transaction_commit()`.
216 * - Then finally, call `ref_transaction_free()` to free the
217 * `ref_transaction` data structure.
219 * At any time before calling `ref_transaction_commit()`, you can call
220 * `ref_transaction_abort()` to abort the transaction, rollback any
221 * locks, and free any associated resources (including the
222 * `ref_transaction` data structure).
224 * Putting it all together, a complete reference update looks like
226 * struct ref_transaction *transaction;
227 * struct strbuf err = STRBUF_INIT;
228 * int ret = 0;
230 * transaction = ref_store_transaction_begin(refs, &err);
231 * if (!transaction ||
232 * ref_transaction_update(...) ||
233 * ref_transaction_create(...) ||
234 * ...etc... ||
235 * ref_transaction_commit(transaction, &err)) {
236 * error("%s", err.buf);
237 * ret = -1;
239 * ref_transaction_free(transaction);
240 * strbuf_release(&err);
241 * return ret;
243 * Error handling
244 * --------------
246 * On error, transaction functions append a message about what
247 * went wrong to the 'err' argument. The message mentions what
248 * ref was being updated (if any) when the error occurred so it
249 * can be passed to 'die' or 'error' as-is.
251 * The message is appended to err without first clearing err.
252 * err will not be '\n' terminated.
254 * Caveats
255 * -------
257 * Note that no locks are taken, and no refs are read, until
258 * `ref_transaction_prepare()` or `ref_transaction_commit()` is
259 * called. So, for example, `ref_transaction_verify()` won't report a
260 * verification failure until the commit is attempted.
262 struct ref_transaction;
265 * Bit values set in the flags argument passed to each_ref_fn() and
266 * stored in ref_iterator::flags. Other bits are for internal use
267 * only:
270 /* Reference is a symbolic reference. */
271 #define REF_ISSYMREF 0x01
273 /* Reference is a packed reference. */
274 #define REF_ISPACKED 0x02
277 * Reference cannot be resolved to an object name: dangling symbolic
278 * reference (directly or indirectly), corrupt reference file,
279 * reference exists but name is bad, or symbolic reference refers to
280 * ill-formatted reference name.
282 #define REF_ISBROKEN 0x04
285 * Reference name is not well formed.
287 * See git-check-ref-format(1) for the definition of well formed ref names.
289 #define REF_BAD_NAME 0x08
292 * The signature for the callback function for the for_each_*()
293 * functions below. The memory pointed to by the refname and oid
294 * arguments is only guaranteed to be valid for the duration of a
295 * single callback invocation.
297 typedef int each_ref_fn(const char *refname,
298 const struct object_id *oid, int flags, void *cb_data);
301 * The same as each_ref_fn, but also with a repository argument that
302 * contains the repository associated with the callback.
304 typedef int each_repo_ref_fn(struct repository *r,
305 const char *refname,
306 const struct object_id *oid,
307 int flags,
308 void *cb_data);
311 * The following functions invoke the specified callback function for
312 * each reference indicated. If the function ever returns a nonzero
313 * value, stop the iteration and return that value. Please note that
314 * it is not safe to modify references while an iteration is in
315 * progress, unless the same callback function invocation that
316 * modifies the reference also returns a nonzero value to immediately
317 * stop the iteration. Returned references are sorted.
319 int refs_head_ref(struct ref_store *refs,
320 each_ref_fn fn, void *cb_data);
321 int refs_for_each_ref(struct ref_store *refs,
322 each_ref_fn fn, void *cb_data);
323 int refs_for_each_ref_in(struct ref_store *refs, const char *prefix,
324 each_ref_fn fn, void *cb_data);
325 int refs_for_each_tag_ref(struct ref_store *refs,
326 each_ref_fn fn, void *cb_data);
327 int refs_for_each_branch_ref(struct ref_store *refs,
328 each_ref_fn fn, void *cb_data);
329 int refs_for_each_remote_ref(struct ref_store *refs,
330 each_ref_fn fn, void *cb_data);
332 /* just iterates the head ref. */
333 int head_ref(each_ref_fn fn, void *cb_data);
335 /* iterates all refs. */
336 int for_each_ref(each_ref_fn fn, void *cb_data);
339 * iterates all refs which have a defined prefix and strips that prefix from
340 * the passed variable refname.
342 int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data);
344 int refs_for_each_fullref_in(struct ref_store *refs, const char *prefix,
345 each_ref_fn fn, void *cb_data,
346 unsigned int broken);
347 int for_each_fullref_in(const char *prefix, each_ref_fn fn, void *cb_data,
348 unsigned int broken);
351 * iterate all refs in "patterns" by partitioning patterns into disjoint sets
352 * and iterating the longest-common prefix of each set.
354 * callers should be prepared to ignore references that they did not ask for.
356 int for_each_fullref_in_prefixes(const char *namespace, const char **patterns,
357 each_ref_fn fn, void *cb_data,
358 unsigned int broken);
360 * iterate refs from the respective area.
362 int for_each_tag_ref(each_ref_fn fn, void *cb_data);
363 int for_each_branch_ref(each_ref_fn fn, void *cb_data);
364 int for_each_remote_ref(each_ref_fn fn, void *cb_data);
365 int for_each_replace_ref(struct repository *r, each_repo_ref_fn fn, void *cb_data);
367 /* iterates all refs that match the specified glob pattern. */
368 int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data);
370 int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
371 const char *prefix, void *cb_data);
373 int head_ref_namespaced(each_ref_fn fn, void *cb_data);
374 int for_each_namespaced_ref(each_ref_fn fn, void *cb_data);
376 /* can be used to learn about broken ref and symref */
377 int refs_for_each_rawref(struct ref_store *refs, each_ref_fn fn, void *cb_data);
378 int for_each_rawref(each_ref_fn fn, void *cb_data);
381 * Normalizes partial refs to their fully qualified form.
382 * Will prepend <prefix> to the <pattern> if it doesn't start with 'refs/'.
383 * <prefix> will default to 'refs/' if NULL.
385 * item.string will be set to the result.
386 * item.util will be set to NULL if <pattern> contains glob characters, or
387 * non-NULL if it doesn't.
389 void normalize_glob_ref(struct string_list_item *item, const char *prefix,
390 const char *pattern);
392 static inline const char *has_glob_specials(const char *pattern)
394 return strpbrk(pattern, "?*[");
397 void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname);
398 void warn_dangling_symrefs(FILE *fp, const char *msg_fmt,
399 const struct string_list *refnames);
402 * Flags for controlling behaviour of pack_refs()
403 * PACK_REFS_PRUNE: Prune loose refs after packing
404 * PACK_REFS_ALL: Pack _all_ refs, not just tags and already packed refs
406 #define PACK_REFS_PRUNE 0x0001
407 #define PACK_REFS_ALL 0x0002
410 * Write a packed-refs file for the current repository.
411 * flags: Combination of the above PACK_REFS_* flags.
413 int refs_pack_refs(struct ref_store *refs, unsigned int flags);
416 * Setup reflog before using. Fill in err and return -1 on failure.
418 int refs_create_reflog(struct ref_store *refs, const char *refname,
419 int force_create, struct strbuf *err);
420 int safe_create_reflog(const char *refname, int force_create, struct strbuf *err);
422 /** Reads log for the value of ref during at_time. **/
423 int read_ref_at(struct ref_store *refs,
424 const char *refname, unsigned int flags,
425 timestamp_t at_time, int cnt,
426 struct object_id *oid, char **msg,
427 timestamp_t *cutoff_time, int *cutoff_tz, int *cutoff_cnt);
429 /** Check if a particular reflog exists */
430 int refs_reflog_exists(struct ref_store *refs, const char *refname);
431 int reflog_exists(const char *refname);
434 * Delete the specified reference. If old_oid is non-NULL, then
435 * verify that the current value of the reference is old_oid before
436 * deleting it. If old_oid is NULL, delete the reference if it
437 * exists, regardless of its old value. It is an error for old_oid to
438 * be null_oid. msg and flags are passed through to
439 * ref_transaction_delete().
441 int refs_delete_ref(struct ref_store *refs, const char *msg,
442 const char *refname,
443 const struct object_id *old_oid,
444 unsigned int flags);
445 int delete_ref(const char *msg, const char *refname,
446 const struct object_id *old_oid, unsigned int flags);
449 * Delete the specified references. If there are any problems, emit
450 * errors but attempt to keep going (i.e., the deletes are not done in
451 * an all-or-nothing transaction). msg and flags are passed through to
452 * ref_transaction_delete().
454 int refs_delete_refs(struct ref_store *refs, const char *msg,
455 struct string_list *refnames, unsigned int flags);
456 int delete_refs(const char *msg, struct string_list *refnames,
457 unsigned int flags);
459 /** Delete a reflog */
460 int refs_delete_reflog(struct ref_store *refs, const char *refname);
461 int delete_reflog(const char *refname);
464 * Callback to process a reflog entry found by the iteration functions (see
465 * below)
467 typedef int each_reflog_ent_fn(
468 struct object_id *old_oid, struct object_id *new_oid,
469 const char *committer, timestamp_t timestamp,
470 int tz, const char *msg, void *cb_data);
472 /* Iterate over reflog entries in the log for `refname`. */
474 /* oldest entry first */
475 int refs_for_each_reflog_ent(struct ref_store *refs, const char *refname,
476 each_reflog_ent_fn fn, void *cb_data);
478 /* youngest entry first */
479 int refs_for_each_reflog_ent_reverse(struct ref_store *refs,
480 const char *refname,
481 each_reflog_ent_fn fn,
482 void *cb_data);
485 * Iterate over reflog entries in the log for `refname` in the main ref store.
488 /* oldest entry first */
489 int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data);
491 /* youngest entry first */
492 int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data);
495 * Calls the specified function for each reflog file until it returns nonzero,
496 * and returns the value. Reflog file order is unspecified.
498 int refs_for_each_reflog(struct ref_store *refs, each_ref_fn fn, void *cb_data);
499 int for_each_reflog(each_ref_fn fn, void *cb_data);
501 #define REFNAME_ALLOW_ONELEVEL 1
502 #define REFNAME_REFSPEC_PATTERN 2
505 * Return 0 iff refname has the correct format for a refname according
506 * to the rules described in Documentation/git-check-ref-format.txt.
507 * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level
508 * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then
509 * allow a single "*" wildcard character in the refspec. No leading or
510 * repeated slashes are accepted.
512 int check_refname_format(const char *refname, int flags);
515 * Apply the rules from check_refname_format, but mutate the result until it
516 * is acceptable, and place the result in "out".
518 void sanitize_refname_component(const char *refname, struct strbuf *out);
520 const char *prettify_refname(const char *refname);
522 char *refs_shorten_unambiguous_ref(struct ref_store *refs,
523 const char *refname, int strict);
524 char *shorten_unambiguous_ref(const char *refname, int strict);
526 /** rename ref, return 0 on success **/
527 int refs_rename_ref(struct ref_store *refs, const char *oldref,
528 const char *newref, const char *logmsg);
529 int rename_ref(const char *oldref, const char *newref,
530 const char *logmsg);
532 /** copy ref, return 0 on success **/
533 int refs_copy_existing_ref(struct ref_store *refs, const char *oldref,
534 const char *newref, const char *logmsg);
535 int copy_existing_ref(const char *oldref, const char *newref,
536 const char *logmsg);
538 int refs_create_symref(struct ref_store *refs, const char *refname,
539 const char *target, const char *logmsg);
540 int create_symref(const char *refname, const char *target, const char *logmsg);
542 enum action_on_err {
543 UPDATE_REFS_MSG_ON_ERR,
544 UPDATE_REFS_DIE_ON_ERR,
545 UPDATE_REFS_QUIET_ON_ERR
549 * Begin a reference transaction. The reference transaction must
550 * be freed by calling ref_transaction_free().
552 struct ref_transaction *ref_store_transaction_begin(struct ref_store *refs,
553 struct strbuf *err);
554 struct ref_transaction *ref_transaction_begin(struct strbuf *err);
557 * Reference transaction updates
559 * The following four functions add a reference check or update to a
560 * ref_transaction. They have some common similar parameters:
562 * transaction -- a pointer to an open ref_transaction, obtained
563 * from ref_transaction_begin().
565 * refname -- the name of the reference to be affected.
567 * new_oid -- the object ID that should be set to be the new value
568 * of the reference. Some functions allow this parameter to be
569 * NULL, meaning that the reference is not changed, or
570 * null_oid, meaning that the reference should be deleted. A
571 * copy of this value is made in the transaction.
573 * old_oid -- the object ID that the reference must have before
574 * the update. Some functions allow this parameter to be NULL,
575 * meaning that the old value of the reference is not checked,
576 * or null_oid, meaning that the reference must not exist
577 * before the update. A copy of this value is made in the
578 * transaction.
580 * flags -- flags affecting the update, passed to
581 * update_ref_lock(). Possible flags: REF_NO_DEREF,
582 * REF_FORCE_CREATE_REFLOG. See those constants for more
583 * information.
585 * msg -- a message describing the change (for the reflog).
587 * err -- a strbuf for receiving a description of any error that
588 * might have occurred.
590 * The functions make internal copies of refname and msg, so the
591 * caller retains ownership of these parameters.
593 * The functions return 0 on success and non-zero on failure. A
594 * failure means that the transaction as a whole has failed and needs
595 * to be rolled back.
599 * The following flags can be passed to ref_transaction_update() etc.
600 * Internally, they are stored in `ref_update::flags`, along with some
601 * internal flags.
605 * Act on the ref directly; i.e., without dereferencing symbolic refs.
606 * If this flag is not specified, then symbolic references are
607 * dereferenced and the update is applied to the referent.
609 #define REF_NO_DEREF (1 << 0)
612 * Force the creation of a reflog for this reference, even if it
613 * didn't previously have a reflog.
615 #define REF_FORCE_CREATE_REFLOG (1 << 1)
618 * Bitmask of all of the flags that are allowed to be passed in to
619 * ref_transaction_update() and friends:
621 #define REF_TRANSACTION_UPDATE_ALLOWED_FLAGS \
622 (REF_NO_DEREF | REF_FORCE_CREATE_REFLOG)
625 * Add a reference update to transaction. `new_oid` is the value that
626 * the reference should have after the update, or `null_oid` if it
627 * should be deleted. If `new_oid` is NULL, then the reference is not
628 * changed at all. `old_oid` is the value that the reference must have
629 * before the update, or `null_oid` if it must not have existed
630 * beforehand. The old value is checked after the lock is taken to
631 * prevent races. If the old value doesn't agree with old_oid, the
632 * whole transaction fails. If old_oid is NULL, then the previous
633 * value is not checked.
635 * See the above comment "Reference transaction updates" for more
636 * information.
638 int ref_transaction_update(struct ref_transaction *transaction,
639 const char *refname,
640 const struct object_id *new_oid,
641 const struct object_id *old_oid,
642 unsigned int flags, const char *msg,
643 struct strbuf *err);
646 * Add a reference creation to transaction. new_oid is the value that
647 * the reference should have after the update; it must not be
648 * null_oid. It is verified that the reference does not exist
649 * already.
651 * See the above comment "Reference transaction updates" for more
652 * information.
654 int ref_transaction_create(struct ref_transaction *transaction,
655 const char *refname,
656 const struct object_id *new_oid,
657 unsigned int flags, const char *msg,
658 struct strbuf *err);
661 * Add a reference deletion to transaction. If old_oid is non-NULL,
662 * then it holds the value that the reference should have had before
663 * the update (which must not be null_oid).
665 * See the above comment "Reference transaction updates" for more
666 * information.
668 int ref_transaction_delete(struct ref_transaction *transaction,
669 const char *refname,
670 const struct object_id *old_oid,
671 unsigned int flags, const char *msg,
672 struct strbuf *err);
675 * Verify, within a transaction, that refname has the value old_oid,
676 * or, if old_oid is null_oid, then verify that the reference
677 * doesn't exist. old_oid must be non-NULL.
679 * See the above comment "Reference transaction updates" for more
680 * information.
682 int ref_transaction_verify(struct ref_transaction *transaction,
683 const char *refname,
684 const struct object_id *old_oid,
685 unsigned int flags,
686 struct strbuf *err);
688 /* Naming conflict (for example, the ref names A and A/B conflict). */
689 #define TRANSACTION_NAME_CONFLICT -1
690 /* All other errors. */
691 #define TRANSACTION_GENERIC_ERROR -2
694 * Perform the preparatory stages of committing `transaction`. Acquire
695 * any needed locks, check preconditions, etc.; basically, do as much
696 * as possible to ensure that the transaction will be able to go
697 * through, stopping just short of making any irrevocable or
698 * user-visible changes. The updates that this function prepares can
699 * be finished up by calling `ref_transaction_commit()` or rolled back
700 * by calling `ref_transaction_abort()`.
702 * On success, return 0 and leave the transaction in "prepared" state.
703 * On failure, abort the transaction, write an error message to `err`,
704 * and return one of the `TRANSACTION_*` constants.
706 * Callers who don't need such fine-grained control over committing
707 * reference transactions should just call `ref_transaction_commit()`.
709 int ref_transaction_prepare(struct ref_transaction *transaction,
710 struct strbuf *err);
713 * Commit all of the changes that have been queued in transaction, as
714 * atomically as possible. On success, return 0 and leave the
715 * transaction in "closed" state. On failure, roll back the
716 * transaction, write an error message to `err`, and return one of the
717 * `TRANSACTION_*` constants
719 int ref_transaction_commit(struct ref_transaction *transaction,
720 struct strbuf *err);
723 * Abort `transaction`, which has been begun and possibly prepared,
724 * but not yet committed.
726 int ref_transaction_abort(struct ref_transaction *transaction,
727 struct strbuf *err);
730 * Like ref_transaction_commit(), but optimized for creating
731 * references when originally initializing a repository (e.g., by "git
732 * clone"). It writes the new references directly to packed-refs
733 * without locking the individual references.
735 * It is a bug to call this function when there might be other
736 * processes accessing the repository or if there are existing
737 * references that might conflict with the ones being created. All
738 * old_oid values must either be absent or null_oid.
740 int initial_ref_transaction_commit(struct ref_transaction *transaction,
741 struct strbuf *err);
744 * Free `*transaction` and all associated data.
746 void ref_transaction_free(struct ref_transaction *transaction);
749 * Lock, update, and unlock a single reference. This function
750 * basically does a transaction containing a single call to
751 * ref_transaction_update(). The parameters to this function have the
752 * same meaning as the corresponding parameters to
753 * ref_transaction_update(). Handle errors as requested by the `onerr`
754 * argument.
756 int refs_update_ref(struct ref_store *refs, const char *msg, const char *refname,
757 const struct object_id *new_oid, const struct object_id *old_oid,
758 unsigned int flags, enum action_on_err onerr);
759 int update_ref(const char *msg, const char *refname,
760 const struct object_id *new_oid, const struct object_id *old_oid,
761 unsigned int flags, enum action_on_err onerr);
763 int parse_hide_refs_config(const char *var, const char *value, const char *);
766 * Check whether a ref is hidden. If no namespace is set, both the first and
767 * the second parameter point to the full ref name. If a namespace is set and
768 * the ref is inside that namespace, the first parameter is a pointer to the
769 * name of the ref with the namespace prefix removed. If a namespace is set and
770 * the ref is outside that namespace, the first parameter is NULL. The second
771 * parameter always points to the full ref name.
773 int ref_is_hidden(const char *, const char *);
775 enum ref_type {
776 REF_TYPE_PER_WORKTREE, /* refs inside refs/ but not shared */
777 REF_TYPE_PSEUDOREF, /* refs outside refs/ in current worktree */
778 REF_TYPE_MAIN_PSEUDOREF, /* pseudo refs from the main worktree */
779 REF_TYPE_OTHER_PSEUDOREF, /* pseudo refs from other worktrees */
780 REF_TYPE_NORMAL, /* normal/shared refs inside refs/ */
783 enum ref_type ref_type(const char *refname);
785 enum expire_reflog_flags {
786 EXPIRE_REFLOGS_DRY_RUN = 1 << 0,
787 EXPIRE_REFLOGS_UPDATE_REF = 1 << 1,
788 EXPIRE_REFLOGS_VERBOSE = 1 << 2,
789 EXPIRE_REFLOGS_REWRITE = 1 << 3
793 * The following interface is used for reflog expiration. The caller
794 * calls reflog_expire(), supplying it with three callback functions,
795 * of the following types. The callback functions define the
796 * expiration policy that is desired.
798 * reflog_expiry_prepare_fn -- Called once after the reference is
799 * locked.
801 * reflog_expiry_should_prune_fn -- Called once for each entry in the
802 * existing reflog. It should return true iff that entry should be
803 * pruned.
805 * reflog_expiry_cleanup_fn -- Called once before the reference is
806 * unlocked again.
808 typedef void reflog_expiry_prepare_fn(const char *refname,
809 const struct object_id *oid,
810 void *cb_data);
811 typedef int reflog_expiry_should_prune_fn(struct object_id *ooid,
812 struct object_id *noid,
813 const char *email,
814 timestamp_t timestamp, int tz,
815 const char *message, void *cb_data);
816 typedef void reflog_expiry_cleanup_fn(void *cb_data);
819 * Expire reflog entries for the specified reference. oid is the old
820 * value of the reference. flags is a combination of the constants in
821 * enum expire_reflog_flags. The three function pointers are described
822 * above. On success, return zero.
824 int refs_reflog_expire(struct ref_store *refs,
825 const char *refname,
826 const struct object_id *oid,
827 unsigned int flags,
828 reflog_expiry_prepare_fn prepare_fn,
829 reflog_expiry_should_prune_fn should_prune_fn,
830 reflog_expiry_cleanup_fn cleanup_fn,
831 void *policy_cb_data);
832 int reflog_expire(const char *refname, const struct object_id *oid,
833 unsigned int flags,
834 reflog_expiry_prepare_fn prepare_fn,
835 reflog_expiry_should_prune_fn should_prune_fn,
836 reflog_expiry_cleanup_fn cleanup_fn,
837 void *policy_cb_data);
839 int ref_storage_backend_exists(const char *name);
841 struct ref_store *get_main_ref_store(struct repository *r);
844 * Submodules
845 * ----------
847 * If you want to iterate the refs of a submodule you first need to add the
848 * submodules object database. You can do this by a code-snippet like
849 * this:
851 * const char *path = "path/to/submodule"
852 * if (add_submodule_odb(path))
853 * die("Error submodule '%s' not populated.", path);
855 * `add_submodule_odb()` will return zero on success. If you
856 * do not do this you will get an error for each ref that it does not point
857 * to a valid object.
859 * Note: As a side-effect of this you cannot safely assume that all
860 * objects you lookup are available in superproject. All submodule objects
861 * will be available the same way as the superprojects objects.
863 * Example:
864 * --------
866 * ----
867 * static int handle_remote_ref(const char *refname,
868 * const unsigned char *sha1, int flags, void *cb_data)
870 * struct strbuf *output = cb_data;
871 * strbuf_addf(output, "%s\n", refname);
872 * return 0;
878 * Return the ref_store instance for the specified submodule. For the
879 * main repository, use submodule==NULL; such a call cannot fail. For
880 * a submodule, the submodule must exist and be a nonbare repository,
881 * otherwise return NULL. If the requested reference store has not yet
882 * been initialized, initialize it first.
884 * For backwards compatibility, submodule=="" is treated the same as
885 * submodule==NULL.
887 struct ref_store *get_submodule_ref_store(const char *submodule);
888 struct ref_store *get_worktree_ref_store(const struct worktree *wt);
890 #endif /* REFS_H */