Start the post 2.27 cycle
[git.git] / refs.h
bloba92d2c74c8306a25c0b6eab7624a06adae37a1b8
1 #ifndef REFS_H
2 #define REFS_H
4 struct object_id;
5 struct ref_store;
6 struct repository;
7 struct strbuf;
8 struct string_list;
9 struct string_list_item;
10 struct worktree;
13 * Resolve a reference, recursively following symbolic refererences.
15 * Return the name of the non-symbolic reference that ultimately pointed
16 * at the resolved object name. The return value, if not NULL, is a
17 * pointer into either a static buffer or the input ref.
19 * If oid is non-NULL, store the referred-to object's name in it.
21 * If the reference cannot be resolved to an object, the behavior
22 * depends on the RESOLVE_REF_READING flag:
24 * - If RESOLVE_REF_READING is set, return NULL.
26 * - If RESOLVE_REF_READING is not set, clear oid and return the name of
27 * the last reference name in the chain, which will either be a non-symbolic
28 * reference or an undefined reference. If this is a prelude to
29 * "writing" to the ref, the return value is the name of the ref
30 * that will actually be created or changed.
32 * If the RESOLVE_REF_NO_RECURSE flag is passed, only resolves one
33 * level of symbolic reference. The value stored in oid for a symbolic
34 * reference will always be null_oid in this case, and the return
35 * value is the reference that the symref refers to directly.
37 * If flags is non-NULL, set the value that it points to the
38 * combination of REF_ISPACKED (if the reference was found among the
39 * packed references), REF_ISSYMREF (if the initial reference was a
40 * symbolic reference), REF_BAD_NAME (if the reference name is ill
41 * formed --- see RESOLVE_REF_ALLOW_BAD_NAME below), and REF_ISBROKEN
42 * (if the ref is malformed or has a bad name). See refs.h for more detail
43 * on each flag.
45 * If ref is not a properly-formatted, normalized reference, return
46 * NULL. If more than MAXDEPTH recursive symbolic lookups are needed,
47 * give up and return NULL.
49 * RESOLVE_REF_ALLOW_BAD_NAME allows resolving refs even when their
50 * name is invalid according to git-check-ref-format(1). If the name
51 * is bad then the value stored in oid will be null_oid and the two
52 * flags REF_ISBROKEN and REF_BAD_NAME will be set.
54 * Even with RESOLVE_REF_ALLOW_BAD_NAME, names that escape the refs/
55 * directory and do not consist of all caps and underscores cannot be
56 * resolved. The function returns NULL for such ref names.
57 * Caps and underscores refers to the special refs, such as HEAD,
58 * FETCH_HEAD and friends, that all live outside of the refs/ directory.
60 #define RESOLVE_REF_READING 0x01
61 #define RESOLVE_REF_NO_RECURSE 0x02
62 #define RESOLVE_REF_ALLOW_BAD_NAME 0x04
64 const char *refs_resolve_ref_unsafe(struct ref_store *refs,
65 const char *refname,
66 int resolve_flags,
67 struct object_id *oid,
68 int *flags);
69 const char *resolve_ref_unsafe(const char *refname, int resolve_flags,
70 struct object_id *oid, int *flags);
72 char *refs_resolve_refdup(struct ref_store *refs,
73 const char *refname, int resolve_flags,
74 struct object_id *oid, int *flags);
75 char *resolve_refdup(const char *refname, int resolve_flags,
76 struct object_id *oid, int *flags);
78 int refs_read_ref_full(struct ref_store *refs, const char *refname,
79 int resolve_flags, struct object_id *oid, int *flags);
80 int read_ref_full(const char *refname, int resolve_flags,
81 struct object_id *oid, int *flags);
82 int read_ref(const char *refname, struct object_id *oid);
85 * Return 0 if a reference named refname could be created without
86 * conflicting with the name of an existing reference. Otherwise,
87 * return a negative value and write an explanation to err. If extras
88 * is non-NULL, it is a list of additional refnames with which refname
89 * is not allowed to conflict. If skip is non-NULL, ignore potential
90 * conflicts with refs in skip (e.g., because they are scheduled for
91 * deletion in the same operation). Behavior is undefined if the same
92 * name is listed in both extras and skip.
94 * Two reference names conflict if one of them exactly matches the
95 * leading components of the other; e.g., "foo/bar" conflicts with
96 * both "foo" and with "foo/bar/baz" but not with "foo/bar" or
97 * "foo/barbados".
99 * extras and skip must be sorted.
102 int refs_verify_refname_available(struct ref_store *refs,
103 const char *refname,
104 const struct string_list *extras,
105 const struct string_list *skip,
106 struct strbuf *err);
108 int ref_exists(const char *refname);
110 int should_autocreate_reflog(const char *refname);
112 int is_branch(const char *refname);
114 int refs_init_db(struct strbuf *err);
117 * If refname is a non-symbolic reference that refers to a tag object,
118 * and the tag can be (recursively) dereferenced to a non-tag object,
119 * store the object ID of the referred-to object to oid and return 0.
120 * If any of these conditions are not met, return a non-zero value.
121 * Symbolic references are considered unpeelable, even if they
122 * ultimately resolve to a peelable tag.
124 int refs_peel_ref(struct ref_store *refs, const char *refname,
125 struct object_id *oid);
126 int peel_ref(const char *refname, struct object_id *oid);
129 * Resolve refname in the nested "gitlink" repository in the specified
130 * submodule (which must be non-NULL). If the resolution is
131 * successful, return 0 and set oid to the name of the object;
132 * otherwise, return a non-zero value.
134 int resolve_gitlink_ref(const char *submodule, const char *refname,
135 struct object_id *oid);
138 * Return true iff abbrev_name is a possible abbreviation for
139 * full_name according to the rules defined by ref_rev_parse_rules in
140 * refs.c.
142 int refname_match(const char *abbrev_name, const char *full_name);
145 * Given a 'prefix' expand it by the rules in 'ref_rev_parse_rules' and add
146 * the results to 'prefixes'
148 struct argv_array;
149 void expand_ref_prefix(struct argv_array *prefixes, const char *prefix);
151 int expand_ref(struct repository *r, const char *str, int len, struct object_id *oid, char **ref);
152 int repo_dwim_ref(struct repository *r, const char *str, int len, struct object_id *oid, char **ref);
153 int repo_dwim_log(struct repository *r, const char *str, int len, struct object_id *oid, char **ref);
154 int dwim_ref(const char *str, int len, struct object_id *oid, char **ref);
155 int dwim_log(const char *str, int len, struct object_id *oid, char **ref);
158 * A ref_transaction represents a collection of reference updates that
159 * should succeed or fail together.
161 * Calling sequence
162 * ----------------
164 * - Allocate and initialize a `struct ref_transaction` by calling
165 * `ref_transaction_begin()`.
167 * - Specify the intended ref updates by calling one or more of the
168 * following functions:
169 * - `ref_transaction_update()`
170 * - `ref_transaction_create()`
171 * - `ref_transaction_delete()`
172 * - `ref_transaction_verify()`
174 * - Then either:
176 * - Optionally call `ref_transaction_prepare()` to prepare the
177 * transaction. This locks all references, checks preconditions,
178 * etc. but doesn't finalize anything. If this step fails, the
179 * transaction has been closed and can only be freed. If this step
180 * succeeds, then `ref_transaction_commit()` is almost certain to
181 * succeed. However, you can still call `ref_transaction_abort()`
182 * if you decide not to commit the transaction after all.
184 * - Call `ref_transaction_commit()` to execute the transaction,
185 * make the changes permanent, and release all locks. If you
186 * haven't already called `ref_transaction_prepare()`, then
187 * `ref_transaction_commit()` calls it for you.
189 * Or
191 * - Call `initial_ref_transaction_commit()` if the ref database is
192 * known to be empty and have no other writers (e.g. during
193 * clone). This is likely to be much faster than
194 * `ref_transaction_commit()`. `ref_transaction_prepare()` should
195 * *not* be called before `initial_ref_transaction_commit()`.
197 * - Then finally, call `ref_transaction_free()` to free the
198 * `ref_transaction` data structure.
200 * At any time before calling `ref_transaction_commit()`, you can call
201 * `ref_transaction_abort()` to abort the transaction, rollback any
202 * locks, and free any associated resources (including the
203 * `ref_transaction` data structure).
205 * Putting it all together, a complete reference update looks like
207 * struct ref_transaction *transaction;
208 * struct strbuf err = STRBUF_INIT;
209 * int ret = 0;
211 * transaction = ref_store_transaction_begin(refs, &err);
212 * if (!transaction ||
213 * ref_transaction_update(...) ||
214 * ref_transaction_create(...) ||
215 * ...etc... ||
216 * ref_transaction_commit(transaction, &err)) {
217 * error("%s", err.buf);
218 * ret = -1;
220 * ref_transaction_free(transaction);
221 * strbuf_release(&err);
222 * return ret;
224 * Error handling
225 * --------------
227 * On error, transaction functions append a message about what
228 * went wrong to the 'err' argument. The message mentions what
229 * ref was being updated (if any) when the error occurred so it
230 * can be passed to 'die' or 'error' as-is.
232 * The message is appended to err without first clearing err.
233 * err will not be '\n' terminated.
235 * Caveats
236 * -------
238 * Note that no locks are taken, and no refs are read, until
239 * `ref_transaction_prepare()` or `ref_transaction_commit()` is
240 * called. So, for example, `ref_transaction_verify()` won't report a
241 * verification failure until the commit is attempted.
243 struct ref_transaction;
246 * Bit values set in the flags argument passed to each_ref_fn() and
247 * stored in ref_iterator::flags. Other bits are for internal use
248 * only:
251 /* Reference is a symbolic reference. */
252 #define REF_ISSYMREF 0x01
254 /* Reference is a packed reference. */
255 #define REF_ISPACKED 0x02
258 * Reference cannot be resolved to an object name: dangling symbolic
259 * reference (directly or indirectly), corrupt reference file,
260 * reference exists but name is bad, or symbolic reference refers to
261 * ill-formatted reference name.
263 #define REF_ISBROKEN 0x04
266 * Reference name is not well formed.
268 * See git-check-ref-format(1) for the definition of well formed ref names.
270 #define REF_BAD_NAME 0x08
273 * The signature for the callback function for the for_each_*()
274 * functions below. The memory pointed to by the refname and oid
275 * arguments is only guaranteed to be valid for the duration of a
276 * single callback invocation.
278 typedef int each_ref_fn(const char *refname,
279 const struct object_id *oid, int flags, void *cb_data);
282 * The same as each_ref_fn, but also with a repository argument that
283 * contains the repository associated with the callback.
285 typedef int each_repo_ref_fn(struct repository *r,
286 const char *refname,
287 const struct object_id *oid,
288 int flags,
289 void *cb_data);
292 * The following functions invoke the specified callback function for
293 * each reference indicated. If the function ever returns a nonzero
294 * value, stop the iteration and return that value. Please note that
295 * it is not safe to modify references while an iteration is in
296 * progress, unless the same callback function invocation that
297 * modifies the reference also returns a nonzero value to immediately
298 * stop the iteration. Returned references are sorted.
300 int refs_head_ref(struct ref_store *refs,
301 each_ref_fn fn, void *cb_data);
302 int refs_for_each_ref(struct ref_store *refs,
303 each_ref_fn fn, void *cb_data);
304 int refs_for_each_ref_in(struct ref_store *refs, const char *prefix,
305 each_ref_fn fn, void *cb_data);
306 int refs_for_each_tag_ref(struct ref_store *refs,
307 each_ref_fn fn, void *cb_data);
308 int refs_for_each_branch_ref(struct ref_store *refs,
309 each_ref_fn fn, void *cb_data);
310 int refs_for_each_remote_ref(struct ref_store *refs,
311 each_ref_fn fn, void *cb_data);
313 /* just iterates the head ref. */
314 int head_ref(each_ref_fn fn, void *cb_data);
316 /* iterates all refs. */
317 int for_each_ref(each_ref_fn fn, void *cb_data);
320 * iterates all refs which have a defined prefix and strips that prefix from
321 * the passed variable refname.
323 int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data);
325 int refs_for_each_fullref_in(struct ref_store *refs, const char *prefix,
326 each_ref_fn fn, void *cb_data,
327 unsigned int broken);
328 int for_each_fullref_in(const char *prefix, each_ref_fn fn, void *cb_data,
329 unsigned int broken);
332 * iterate refs from the respective area.
334 int for_each_tag_ref(each_ref_fn fn, void *cb_data);
335 int for_each_branch_ref(each_ref_fn fn, void *cb_data);
336 int for_each_remote_ref(each_ref_fn fn, void *cb_data);
337 int for_each_replace_ref(struct repository *r, each_repo_ref_fn fn, void *cb_data);
339 /* iterates all refs that match the specified glob pattern. */
340 int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data);
342 int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
343 const char *prefix, void *cb_data);
345 int head_ref_namespaced(each_ref_fn fn, void *cb_data);
346 int for_each_namespaced_ref(each_ref_fn fn, void *cb_data);
348 /* can be used to learn about broken ref and symref */
349 int refs_for_each_rawref(struct ref_store *refs, each_ref_fn fn, void *cb_data);
350 int for_each_rawref(each_ref_fn fn, void *cb_data);
353 * Normalizes partial refs to their fully qualified form.
354 * Will prepend <prefix> to the <pattern> if it doesn't start with 'refs/'.
355 * <prefix> will default to 'refs/' if NULL.
357 * item.string will be set to the result.
358 * item.util will be set to NULL if <pattern> contains glob characters, or
359 * non-NULL if it doesn't.
361 void normalize_glob_ref(struct string_list_item *item, const char *prefix,
362 const char *pattern);
364 static inline const char *has_glob_specials(const char *pattern)
366 return strpbrk(pattern, "?*[");
369 void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname);
370 void warn_dangling_symrefs(FILE *fp, const char *msg_fmt,
371 const struct string_list *refnames);
374 * Flags for controlling behaviour of pack_refs()
375 * PACK_REFS_PRUNE: Prune loose refs after packing
376 * PACK_REFS_ALL: Pack _all_ refs, not just tags and already packed refs
378 #define PACK_REFS_PRUNE 0x0001
379 #define PACK_REFS_ALL 0x0002
382 * Write a packed-refs file for the current repository.
383 * flags: Combination of the above PACK_REFS_* flags.
385 int refs_pack_refs(struct ref_store *refs, unsigned int flags);
388 * Setup reflog before using. Fill in err and return -1 on failure.
390 int refs_create_reflog(struct ref_store *refs, const char *refname,
391 int force_create, struct strbuf *err);
392 int safe_create_reflog(const char *refname, int force_create, struct strbuf *err);
394 /** Reads log for the value of ref during at_time. **/
395 int read_ref_at(struct ref_store *refs,
396 const char *refname, unsigned int flags,
397 timestamp_t at_time, int cnt,
398 struct object_id *oid, char **msg,
399 timestamp_t *cutoff_time, int *cutoff_tz, int *cutoff_cnt);
401 /** Check if a particular reflog exists */
402 int refs_reflog_exists(struct ref_store *refs, const char *refname);
403 int reflog_exists(const char *refname);
406 * Delete the specified reference. If old_oid is non-NULL, then
407 * verify that the current value of the reference is old_oid before
408 * deleting it. If old_oid is NULL, delete the reference if it
409 * exists, regardless of its old value. It is an error for old_oid to
410 * be null_oid. msg and flags are passed through to
411 * ref_transaction_delete().
413 int refs_delete_ref(struct ref_store *refs, const char *msg,
414 const char *refname,
415 const struct object_id *old_oid,
416 unsigned int flags);
417 int delete_ref(const char *msg, const char *refname,
418 const struct object_id *old_oid, unsigned int flags);
421 * Delete the specified references. If there are any problems, emit
422 * errors but attempt to keep going (i.e., the deletes are not done in
423 * an all-or-nothing transaction). msg and flags are passed through to
424 * ref_transaction_delete().
426 int refs_delete_refs(struct ref_store *refs, const char *msg,
427 struct string_list *refnames, unsigned int flags);
428 int delete_refs(const char *msg, struct string_list *refnames,
429 unsigned int flags);
431 /** Delete a reflog */
432 int refs_delete_reflog(struct ref_store *refs, const char *refname);
433 int delete_reflog(const char *refname);
435 /* iterate over reflog entries */
436 typedef int each_reflog_ent_fn(
437 struct object_id *old_oid, struct object_id *new_oid,
438 const char *committer, timestamp_t timestamp,
439 int tz, const char *msg, void *cb_data);
441 int refs_for_each_reflog_ent(struct ref_store *refs, const char *refname,
442 each_reflog_ent_fn fn, void *cb_data);
443 int refs_for_each_reflog_ent_reverse(struct ref_store *refs,
444 const char *refname,
445 each_reflog_ent_fn fn,
446 void *cb_data);
447 int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data);
448 int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data);
451 * Calls the specified function for each reflog file until it returns nonzero,
452 * and returns the value. Reflog file order is unspecified.
454 int refs_for_each_reflog(struct ref_store *refs, each_ref_fn fn, void *cb_data);
455 int for_each_reflog(each_ref_fn fn, void *cb_data);
457 #define REFNAME_ALLOW_ONELEVEL 1
458 #define REFNAME_REFSPEC_PATTERN 2
461 * Return 0 iff refname has the correct format for a refname according
462 * to the rules described in Documentation/git-check-ref-format.txt.
463 * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level
464 * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then
465 * allow a single "*" wildcard character in the refspec. No leading or
466 * repeated slashes are accepted.
468 int check_refname_format(const char *refname, int flags);
471 * Apply the rules from check_refname_format, but mutate the result until it
472 * is acceptable, and place the result in "out".
474 void sanitize_refname_component(const char *refname, struct strbuf *out);
476 const char *prettify_refname(const char *refname);
478 char *refs_shorten_unambiguous_ref(struct ref_store *refs,
479 const char *refname, int strict);
480 char *shorten_unambiguous_ref(const char *refname, int strict);
482 /** rename ref, return 0 on success **/
483 int refs_rename_ref(struct ref_store *refs, const char *oldref,
484 const char *newref, const char *logmsg);
485 int rename_ref(const char *oldref, const char *newref,
486 const char *logmsg);
488 /** copy ref, return 0 on success **/
489 int refs_copy_existing_ref(struct ref_store *refs, const char *oldref,
490 const char *newref, const char *logmsg);
491 int copy_existing_ref(const char *oldref, const char *newref,
492 const char *logmsg);
494 int refs_create_symref(struct ref_store *refs, const char *refname,
495 const char *target, const char *logmsg);
496 int create_symref(const char *refname, const char *target, const char *logmsg);
498 enum action_on_err {
499 UPDATE_REFS_MSG_ON_ERR,
500 UPDATE_REFS_DIE_ON_ERR,
501 UPDATE_REFS_QUIET_ON_ERR
505 * Begin a reference transaction. The reference transaction must
506 * be freed by calling ref_transaction_free().
508 struct ref_transaction *ref_store_transaction_begin(struct ref_store *refs,
509 struct strbuf *err);
510 struct ref_transaction *ref_transaction_begin(struct strbuf *err);
513 * Reference transaction updates
515 * The following four functions add a reference check or update to a
516 * ref_transaction. They have some common similar parameters:
518 * transaction -- a pointer to an open ref_transaction, obtained
519 * from ref_transaction_begin().
521 * refname -- the name of the reference to be affected.
523 * new_oid -- the object ID that should be set to be the new value
524 * of the reference. Some functions allow this parameter to be
525 * NULL, meaning that the reference is not changed, or
526 * null_oid, meaning that the reference should be deleted. A
527 * copy of this value is made in the transaction.
529 * old_oid -- the object ID that the reference must have before
530 * the update. Some functions allow this parameter to be NULL,
531 * meaning that the old value of the reference is not checked,
532 * or null_oid, meaning that the reference must not exist
533 * before the update. A copy of this value is made in the
534 * transaction.
536 * flags -- flags affecting the update, passed to
537 * update_ref_lock(). Possible flags: REF_NO_DEREF,
538 * REF_FORCE_CREATE_REFLOG. See those constants for more
539 * information.
541 * msg -- a message describing the change (for the reflog).
543 * err -- a strbuf for receiving a description of any error that
544 * might have occurred.
546 * The functions make internal copies of refname and msg, so the
547 * caller retains ownership of these parameters.
549 * The functions return 0 on success and non-zero on failure. A
550 * failure means that the transaction as a whole has failed and needs
551 * to be rolled back.
555 * The following flags can be passed to ref_transaction_update() etc.
556 * Internally, they are stored in `ref_update::flags`, along with some
557 * internal flags.
561 * Act on the ref directly; i.e., without dereferencing symbolic refs.
562 * If this flag is not specified, then symbolic references are
563 * dereferenced and the update is applied to the referent.
565 #define REF_NO_DEREF (1 << 0)
568 * Force the creation of a reflog for this reference, even if it
569 * didn't previously have a reflog.
571 #define REF_FORCE_CREATE_REFLOG (1 << 1)
574 * Bitmask of all of the flags that are allowed to be passed in to
575 * ref_transaction_update() and friends:
577 #define REF_TRANSACTION_UPDATE_ALLOWED_FLAGS \
578 (REF_NO_DEREF | REF_FORCE_CREATE_REFLOG)
581 * Add a reference update to transaction. `new_oid` is the value that
582 * the reference should have after the update, or `null_oid` if it
583 * should be deleted. If `new_oid` is NULL, then the reference is not
584 * changed at all. `old_oid` is the value that the reference must have
585 * before the update, or `null_oid` if it must not have existed
586 * beforehand. The old value is checked after the lock is taken to
587 * prevent races. If the old value doesn't agree with old_oid, the
588 * whole transaction fails. If old_oid is NULL, then the previous
589 * value is not checked.
591 * See the above comment "Reference transaction updates" for more
592 * information.
594 int ref_transaction_update(struct ref_transaction *transaction,
595 const char *refname,
596 const struct object_id *new_oid,
597 const struct object_id *old_oid,
598 unsigned int flags, const char *msg,
599 struct strbuf *err);
602 * Add a reference creation to transaction. new_oid is the value that
603 * the reference should have after the update; it must not be
604 * null_oid. It is verified that the reference does not exist
605 * already.
607 * See the above comment "Reference transaction updates" for more
608 * information.
610 int ref_transaction_create(struct ref_transaction *transaction,
611 const char *refname,
612 const struct object_id *new_oid,
613 unsigned int flags, const char *msg,
614 struct strbuf *err);
617 * Add a reference deletion to transaction. If old_oid is non-NULL,
618 * then it holds the value that the reference should have had before
619 * the update (which must not be null_oid).
621 * See the above comment "Reference transaction updates" for more
622 * information.
624 int ref_transaction_delete(struct ref_transaction *transaction,
625 const char *refname,
626 const struct object_id *old_oid,
627 unsigned int flags, const char *msg,
628 struct strbuf *err);
631 * Verify, within a transaction, that refname has the value old_oid,
632 * or, if old_oid is null_oid, then verify that the reference
633 * doesn't exist. old_oid must be non-NULL.
635 * See the above comment "Reference transaction updates" for more
636 * information.
638 int ref_transaction_verify(struct ref_transaction *transaction,
639 const char *refname,
640 const struct object_id *old_oid,
641 unsigned int flags,
642 struct strbuf *err);
644 /* Naming conflict (for example, the ref names A and A/B conflict). */
645 #define TRANSACTION_NAME_CONFLICT -1
646 /* All other errors. */
647 #define TRANSACTION_GENERIC_ERROR -2
650 * Perform the preparatory stages of committing `transaction`. Acquire
651 * any needed locks, check preconditions, etc.; basically, do as much
652 * as possible to ensure that the transaction will be able to go
653 * through, stopping just short of making any irrevocable or
654 * user-visible changes. The updates that this function prepares can
655 * be finished up by calling `ref_transaction_commit()` or rolled back
656 * by calling `ref_transaction_abort()`.
658 * On success, return 0 and leave the transaction in "prepared" state.
659 * On failure, abort the transaction, write an error message to `err`,
660 * and return one of the `TRANSACTION_*` constants.
662 * Callers who don't need such fine-grained control over committing
663 * reference transactions should just call `ref_transaction_commit()`.
665 int ref_transaction_prepare(struct ref_transaction *transaction,
666 struct strbuf *err);
669 * Commit all of the changes that have been queued in transaction, as
670 * atomically as possible. On success, return 0 and leave the
671 * transaction in "closed" state. On failure, roll back the
672 * transaction, write an error message to `err`, and return one of the
673 * `TRANSACTION_*` constants
675 int ref_transaction_commit(struct ref_transaction *transaction,
676 struct strbuf *err);
679 * Abort `transaction`, which has been begun and possibly prepared,
680 * but not yet committed.
682 int ref_transaction_abort(struct ref_transaction *transaction,
683 struct strbuf *err);
686 * Like ref_transaction_commit(), but optimized for creating
687 * references when originally initializing a repository (e.g., by "git
688 * clone"). It writes the new references directly to packed-refs
689 * without locking the individual references.
691 * It is a bug to call this function when there might be other
692 * processes accessing the repository or if there are existing
693 * references that might conflict with the ones being created. All
694 * old_oid values must either be absent or null_oid.
696 int initial_ref_transaction_commit(struct ref_transaction *transaction,
697 struct strbuf *err);
700 * Free `*transaction` and all associated data.
702 void ref_transaction_free(struct ref_transaction *transaction);
705 * Lock, update, and unlock a single reference. This function
706 * basically does a transaction containing a single call to
707 * ref_transaction_update(). The parameters to this function have the
708 * same meaning as the corresponding parameters to
709 * ref_transaction_update(). Handle errors as requested by the `onerr`
710 * argument.
712 int refs_update_ref(struct ref_store *refs, const char *msg, const char *refname,
713 const struct object_id *new_oid, const struct object_id *old_oid,
714 unsigned int flags, enum action_on_err onerr);
715 int update_ref(const char *msg, const char *refname,
716 const struct object_id *new_oid, const struct object_id *old_oid,
717 unsigned int flags, enum action_on_err onerr);
719 int parse_hide_refs_config(const char *var, const char *value, const char *);
722 * Check whether a ref is hidden. If no namespace is set, both the first and
723 * the second parameter point to the full ref name. If a namespace is set and
724 * the ref is inside that namespace, the first parameter is a pointer to the
725 * name of the ref with the namespace prefix removed. If a namespace is set and
726 * the ref is outside that namespace, the first parameter is NULL. The second
727 * parameter always points to the full ref name.
729 int ref_is_hidden(const char *, const char *);
731 enum ref_type {
732 REF_TYPE_PER_WORKTREE, /* refs inside refs/ but not shared */
733 REF_TYPE_PSEUDOREF, /* refs outside refs/ in current worktree */
734 REF_TYPE_MAIN_PSEUDOREF, /* pseudo refs from the main worktree */
735 REF_TYPE_OTHER_PSEUDOREF, /* pseudo refs from other worktrees */
736 REF_TYPE_NORMAL, /* normal/shared refs inside refs/ */
739 enum ref_type ref_type(const char *refname);
741 enum expire_reflog_flags {
742 EXPIRE_REFLOGS_DRY_RUN = 1 << 0,
743 EXPIRE_REFLOGS_UPDATE_REF = 1 << 1,
744 EXPIRE_REFLOGS_VERBOSE = 1 << 2,
745 EXPIRE_REFLOGS_REWRITE = 1 << 3
749 * The following interface is used for reflog expiration. The caller
750 * calls reflog_expire(), supplying it with three callback functions,
751 * of the following types. The callback functions define the
752 * expiration policy that is desired.
754 * reflog_expiry_prepare_fn -- Called once after the reference is
755 * locked.
757 * reflog_expiry_should_prune_fn -- Called once for each entry in the
758 * existing reflog. It should return true iff that entry should be
759 * pruned.
761 * reflog_expiry_cleanup_fn -- Called once before the reference is
762 * unlocked again.
764 typedef void reflog_expiry_prepare_fn(const char *refname,
765 const struct object_id *oid,
766 void *cb_data);
767 typedef int reflog_expiry_should_prune_fn(struct object_id *ooid,
768 struct object_id *noid,
769 const char *email,
770 timestamp_t timestamp, int tz,
771 const char *message, void *cb_data);
772 typedef void reflog_expiry_cleanup_fn(void *cb_data);
775 * Expire reflog entries for the specified reference. oid is the old
776 * value of the reference. flags is a combination of the constants in
777 * enum expire_reflog_flags. The three function pointers are described
778 * above. On success, return zero.
780 int refs_reflog_expire(struct ref_store *refs,
781 const char *refname,
782 const struct object_id *oid,
783 unsigned int flags,
784 reflog_expiry_prepare_fn prepare_fn,
785 reflog_expiry_should_prune_fn should_prune_fn,
786 reflog_expiry_cleanup_fn cleanup_fn,
787 void *policy_cb_data);
788 int reflog_expire(const char *refname, const struct object_id *oid,
789 unsigned int flags,
790 reflog_expiry_prepare_fn prepare_fn,
791 reflog_expiry_should_prune_fn should_prune_fn,
792 reflog_expiry_cleanup_fn cleanup_fn,
793 void *policy_cb_data);
795 int ref_storage_backend_exists(const char *name);
797 struct ref_store *get_main_ref_store(struct repository *r);
800 * Submodules
801 * ----------
803 * If you want to iterate the refs of a submodule you first need to add the
804 * submodules object database. You can do this by a code-snippet like
805 * this:
807 * const char *path = "path/to/submodule"
808 * if (add_submodule_odb(path))
809 * die("Error submodule '%s' not populated.", path);
811 * `add_submodule_odb()` will return zero on success. If you
812 * do not do this you will get an error for each ref that it does not point
813 * to a valid object.
815 * Note: As a side-effect of this you cannot safely assume that all
816 * objects you lookup are available in superproject. All submodule objects
817 * will be available the same way as the superprojects objects.
819 * Example:
820 * --------
822 * ----
823 * static int handle_remote_ref(const char *refname,
824 * const unsigned char *sha1, int flags, void *cb_data)
826 * struct strbuf *output = cb_data;
827 * strbuf_addf(output, "%s\n", refname);
828 * return 0;
834 * Return the ref_store instance for the specified submodule. For the
835 * main repository, use submodule==NULL; such a call cannot fail. For
836 * a submodule, the submodule must exist and be a nonbare repository,
837 * otherwise return NULL. If the requested reference store has not yet
838 * been initialized, initialize it first.
840 * For backwards compatibility, submodule=="" is treated the same as
841 * submodule==NULL.
843 struct ref_store *get_submodule_ref_store(const char *submodule);
844 struct ref_store *get_worktree_ref_store(const struct worktree *wt);
846 #endif /* REFS_H */