11 struct string_list_item
;
15 * Callers should not inspect "errno" on failure, but rather pass in a
16 * "failure_errno" parameter, on failure the "errno" will indicate the
17 * type of failure encountered, but not necessarily one that came from
18 * a syscall. We might have faked it up.
20 const char *refs_werrres_ref_unsafe(struct ref_store
*refs
,
23 struct object_id
*oid
,
24 int *flags
, int *failure_errno
);
27 * Resolve a reference, recursively following symbolic refererences.
29 * Return the name of the non-symbolic reference that ultimately pointed
30 * at the resolved object name. The return value, if not NULL, is a
31 * pointer into either a static buffer or the input ref.
33 * If oid is non-NULL, store the referred-to object's name in it.
35 * If the reference cannot be resolved to an object, the behavior
36 * depends on the RESOLVE_REF_READING flag:
38 * - If RESOLVE_REF_READING is set, return NULL.
40 * - If RESOLVE_REF_READING is not set, clear oid and return the name of
41 * the last reference name in the chain, which will either be a non-symbolic
42 * reference or an undefined reference. If this is a prelude to
43 * "writing" to the ref, the return value is the name of the ref
44 * that will actually be created or changed.
46 * If the RESOLVE_REF_NO_RECURSE flag is passed, only resolves one
47 * level of symbolic reference. The value stored in oid for a symbolic
48 * reference will always be null_oid in this case, and the return
49 * value is the reference that the symref refers to directly.
51 * If flags is non-NULL, set the value that it points to the
52 * combination of REF_ISPACKED (if the reference was found among the
53 * packed references), REF_ISSYMREF (if the initial reference was a
54 * symbolic reference), REF_BAD_NAME (if the reference name is ill
55 * formed --- see RESOLVE_REF_ALLOW_BAD_NAME below), and REF_ISBROKEN
56 * (if the ref is malformed or has a bad name). See refs.h for more detail
59 * If ref is not a properly-formatted, normalized reference, return
60 * NULL. If more than MAXDEPTH recursive symbolic lookups are needed,
61 * give up and return NULL.
63 * RESOLVE_REF_ALLOW_BAD_NAME allows resolving refs even when their
64 * name is invalid according to git-check-ref-format(1). If the name
65 * is bad then the value stored in oid will be null_oid and the two
66 * flags REF_ISBROKEN and REF_BAD_NAME will be set.
68 * Even with RESOLVE_REF_ALLOW_BAD_NAME, names that escape the refs/
69 * directory and do not consist of all caps and underscores cannot be
70 * resolved. The function returns NULL for such ref names.
71 * Caps and underscores refers to the special refs, such as HEAD,
72 * FETCH_HEAD and friends, that all live outside of the refs/ directory.
74 #define RESOLVE_REF_READING 0x01
75 #define RESOLVE_REF_NO_RECURSE 0x02
76 #define RESOLVE_REF_ALLOW_BAD_NAME 0x04
78 const char *refs_resolve_ref_unsafe(struct ref_store
*refs
,
81 struct object_id
*oid
,
83 const char *resolve_ref_unsafe(const char *refname
, int resolve_flags
,
84 struct object_id
*oid
, int *flags
);
86 char *refs_resolve_refdup(struct ref_store
*refs
,
87 const char *refname
, int resolve_flags
,
88 struct object_id
*oid
, int *flags
);
89 char *resolve_refdup(const char *refname
, int resolve_flags
,
90 struct object_id
*oid
, int *flags
);
92 int refs_read_ref_full(struct ref_store
*refs
, const char *refname
,
93 int resolve_flags
, struct object_id
*oid
, int *flags
);
94 int read_ref_full(const char *refname
, int resolve_flags
,
95 struct object_id
*oid
, int *flags
);
96 int read_ref(const char *refname
, struct object_id
*oid
);
99 * Return 0 if a reference named refname could be created without
100 * conflicting with the name of an existing reference. Otherwise,
101 * return a negative value and write an explanation to err. If extras
102 * is non-NULL, it is a list of additional refnames with which refname
103 * is not allowed to conflict. If skip is non-NULL, ignore potential
104 * conflicts with refs in skip (e.g., because they are scheduled for
105 * deletion in the same operation). Behavior is undefined if the same
106 * name is listed in both extras and skip.
108 * Two reference names conflict if one of them exactly matches the
109 * leading components of the other; e.g., "foo/bar" conflicts with
110 * both "foo" and with "foo/bar/baz" but not with "foo/bar" or
113 * extras and skip must be sorted.
116 int refs_verify_refname_available(struct ref_store
*refs
,
118 const struct string_list
*extras
,
119 const struct string_list
*skip
,
122 int refs_ref_exists(struct ref_store
*refs
, const char *refname
);
124 int ref_exists(const char *refname
);
126 int should_autocreate_reflog(const char *refname
);
128 int is_branch(const char *refname
);
130 int refs_init_db(struct strbuf
*err
);
133 * Return the peeled value of the oid currently being iterated via
134 * for_each_ref(), etc. This is equivalent to calling:
136 * peel_object(oid, &peeled);
138 * with the "oid" value given to the each_ref_fn callback, except
139 * that some ref storage may be able to answer the query without
140 * actually loading the object in memory.
142 int peel_iterated_oid(const struct object_id
*base
, struct object_id
*peeled
);
145 * Resolve refname in the nested "gitlink" repository in the specified
146 * submodule (which must be non-NULL). If the resolution is
147 * successful, return 0 and set oid to the name of the object;
148 * otherwise, return a non-zero value.
150 int resolve_gitlink_ref(const char *submodule
, const char *refname
,
151 struct object_id
*oid
);
154 * Return true iff abbrev_name is a possible abbreviation for
155 * full_name according to the rules defined by ref_rev_parse_rules in
158 int refname_match(const char *abbrev_name
, const char *full_name
);
161 * Given a 'prefix' expand it by the rules in 'ref_rev_parse_rules' and add
162 * the results to 'prefixes'
165 void expand_ref_prefix(struct strvec
*prefixes
, const char *prefix
);
167 int expand_ref(struct repository
*r
, const char *str
, int len
, struct object_id
*oid
, char **ref
);
168 int repo_dwim_ref(struct repository
*r
, const char *str
, int len
,
169 struct object_id
*oid
, char **ref
, int nonfatal_dangling_mark
);
170 int repo_dwim_log(struct repository
*r
, const char *str
, int len
, struct object_id
*oid
, char **ref
);
171 static inline int dwim_ref(const char *str
, int len
, struct object_id
*oid
,
172 char **ref
, int nonfatal_dangling_mark
)
174 return repo_dwim_ref(the_repository
, str
, len
, oid
, ref
,
175 nonfatal_dangling_mark
);
177 int dwim_log(const char *str
, int len
, struct object_id
*oid
, char **ref
);
180 * Retrieves the default branch name for newly-initialized repositories.
182 * The return value of `repo_default_branch_name()` is an allocated string. The
183 * return value of `git_default_branch_name()` is a singleton.
185 const char *git_default_branch_name(int quiet
);
186 char *repo_default_branch_name(struct repository
*r
, int quiet
);
189 * A ref_transaction represents a collection of reference updates that
190 * should succeed or fail together.
195 * - Allocate and initialize a `struct ref_transaction` by calling
196 * `ref_transaction_begin()`.
198 * - Specify the intended ref updates by calling one or more of the
199 * following functions:
200 * - `ref_transaction_update()`
201 * - `ref_transaction_create()`
202 * - `ref_transaction_delete()`
203 * - `ref_transaction_verify()`
207 * - Optionally call `ref_transaction_prepare()` to prepare the
208 * transaction. This locks all references, checks preconditions,
209 * etc. but doesn't finalize anything. If this step fails, the
210 * transaction has been closed and can only be freed. If this step
211 * succeeds, then `ref_transaction_commit()` is almost certain to
212 * succeed. However, you can still call `ref_transaction_abort()`
213 * if you decide not to commit the transaction after all.
215 * - Call `ref_transaction_commit()` to execute the transaction,
216 * make the changes permanent, and release all locks. If you
217 * haven't already called `ref_transaction_prepare()`, then
218 * `ref_transaction_commit()` calls it for you.
222 * - Call `initial_ref_transaction_commit()` if the ref database is
223 * known to be empty and have no other writers (e.g. during
224 * clone). This is likely to be much faster than
225 * `ref_transaction_commit()`. `ref_transaction_prepare()` should
226 * *not* be called before `initial_ref_transaction_commit()`.
228 * - Then finally, call `ref_transaction_free()` to free the
229 * `ref_transaction` data structure.
231 * At any time before calling `ref_transaction_commit()`, you can call
232 * `ref_transaction_abort()` to abort the transaction, rollback any
233 * locks, and free any associated resources (including the
234 * `ref_transaction` data structure).
236 * Putting it all together, a complete reference update looks like
238 * struct ref_transaction *transaction;
239 * struct strbuf err = STRBUF_INIT;
242 * transaction = ref_store_transaction_begin(refs, &err);
243 * if (!transaction ||
244 * ref_transaction_update(...) ||
245 * ref_transaction_create(...) ||
247 * ref_transaction_commit(transaction, &err)) {
248 * error("%s", err.buf);
251 * ref_transaction_free(transaction);
252 * strbuf_release(&err);
258 * On error, transaction functions append a message about what
259 * went wrong to the 'err' argument. The message mentions what
260 * ref was being updated (if any) when the error occurred so it
261 * can be passed to 'die' or 'error' as-is.
263 * The message is appended to err without first clearing err.
264 * err will not be '\n' terminated.
269 * Note that no locks are taken, and no refs are read, until
270 * `ref_transaction_prepare()` or `ref_transaction_commit()` is
271 * called. So, for example, `ref_transaction_verify()` won't report a
272 * verification failure until the commit is attempted.
274 struct ref_transaction
;
277 * Bit values set in the flags argument passed to each_ref_fn() and
278 * stored in ref_iterator::flags. Other bits are for internal use
282 /* Reference is a symbolic reference. */
283 #define REF_ISSYMREF 0x01
285 /* Reference is a packed reference. */
286 #define REF_ISPACKED 0x02
289 * Reference cannot be resolved to an object name: dangling symbolic
290 * reference (directly or indirectly), corrupt reference file,
291 * reference exists but name is bad, or symbolic reference refers to
292 * ill-formatted reference name.
294 #define REF_ISBROKEN 0x04
297 * Reference name is not well formed.
299 * See git-check-ref-format(1) for the definition of well formed ref names.
301 #define REF_BAD_NAME 0x08
304 * The signature for the callback function for the for_each_*()
305 * functions below. The memory pointed to by the refname and oid
306 * arguments is only guaranteed to be valid for the duration of a
307 * single callback invocation.
309 typedef int each_ref_fn(const char *refname
,
310 const struct object_id
*oid
, int flags
, void *cb_data
);
313 * The same as each_ref_fn, but also with a repository argument that
314 * contains the repository associated with the callback.
316 typedef int each_repo_ref_fn(struct repository
*r
,
318 const struct object_id
*oid
,
323 * The following functions invoke the specified callback function for
324 * each reference indicated. If the function ever returns a nonzero
325 * value, stop the iteration and return that value. Please note that
326 * it is not safe to modify references while an iteration is in
327 * progress, unless the same callback function invocation that
328 * modifies the reference also returns a nonzero value to immediately
329 * stop the iteration. Returned references are sorted.
331 int refs_head_ref(struct ref_store
*refs
,
332 each_ref_fn fn
, void *cb_data
);
333 int refs_for_each_ref(struct ref_store
*refs
,
334 each_ref_fn fn
, void *cb_data
);
335 int refs_for_each_ref_in(struct ref_store
*refs
, const char *prefix
,
336 each_ref_fn fn
, void *cb_data
);
337 int refs_for_each_tag_ref(struct ref_store
*refs
,
338 each_ref_fn fn
, void *cb_data
);
339 int refs_for_each_branch_ref(struct ref_store
*refs
,
340 each_ref_fn fn
, void *cb_data
);
341 int refs_for_each_remote_ref(struct ref_store
*refs
,
342 each_ref_fn fn
, void *cb_data
);
344 /* just iterates the head ref. */
345 int head_ref(each_ref_fn fn
, void *cb_data
);
347 /* iterates all refs. */
348 int for_each_ref(each_ref_fn fn
, void *cb_data
);
351 * iterates all refs which have a defined prefix and strips that prefix from
352 * the passed variable refname.
354 int for_each_ref_in(const char *prefix
, each_ref_fn fn
, void *cb_data
);
356 int refs_for_each_fullref_in(struct ref_store
*refs
, const char *prefix
,
357 each_ref_fn fn
, void *cb_data
);
358 int for_each_fullref_in(const char *prefix
, each_ref_fn fn
, void *cb_data
);
361 * iterate all refs in "patterns" by partitioning patterns into disjoint sets
362 * and iterating the longest-common prefix of each set.
364 * callers should be prepared to ignore references that they did not ask for.
366 int for_each_fullref_in_prefixes(const char *namespace, const char **patterns
,
367 each_ref_fn fn
, void *cb_data
);
369 * iterate refs from the respective area.
371 int for_each_tag_ref(each_ref_fn fn
, void *cb_data
);
372 int for_each_branch_ref(each_ref_fn fn
, void *cb_data
);
373 int for_each_remote_ref(each_ref_fn fn
, void *cb_data
);
374 int for_each_replace_ref(struct repository
*r
, each_repo_ref_fn fn
, void *cb_data
);
376 /* iterates all refs that match the specified glob pattern. */
377 int for_each_glob_ref(each_ref_fn fn
, const char *pattern
, void *cb_data
);
379 int for_each_glob_ref_in(each_ref_fn fn
, const char *pattern
,
380 const char *prefix
, void *cb_data
);
382 int head_ref_namespaced(each_ref_fn fn
, void *cb_data
);
383 int for_each_namespaced_ref(each_ref_fn fn
, void *cb_data
);
385 /* can be used to learn about broken ref and symref */
386 int refs_for_each_rawref(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
);
387 int for_each_rawref(each_ref_fn fn
, void *cb_data
);
390 * Normalizes partial refs to their fully qualified form.
391 * Will prepend <prefix> to the <pattern> if it doesn't start with 'refs/'.
392 * <prefix> will default to 'refs/' if NULL.
394 * item.string will be set to the result.
395 * item.util will be set to NULL if <pattern> contains glob characters, or
396 * non-NULL if it doesn't.
398 void normalize_glob_ref(struct string_list_item
*item
, const char *prefix
,
399 const char *pattern
);
401 static inline const char *has_glob_specials(const char *pattern
)
403 return strpbrk(pattern
, "?*[");
406 void warn_dangling_symref(FILE *fp
, const char *msg_fmt
, const char *refname
);
407 void warn_dangling_symrefs(FILE *fp
, const char *msg_fmt
,
408 const struct string_list
*refnames
);
411 * Flags for controlling behaviour of pack_refs()
412 * PACK_REFS_PRUNE: Prune loose refs after packing
413 * PACK_REFS_ALL: Pack _all_ refs, not just tags and already packed refs
415 #define PACK_REFS_PRUNE 0x0001
416 #define PACK_REFS_ALL 0x0002
419 * Write a packed-refs file for the current repository.
420 * flags: Combination of the above PACK_REFS_* flags.
422 int refs_pack_refs(struct ref_store
*refs
, unsigned int flags
);
425 * Setup reflog before using. Fill in err and return -1 on failure.
427 int refs_create_reflog(struct ref_store
*refs
, const char *refname
,
428 int force_create
, struct strbuf
*err
);
429 int safe_create_reflog(const char *refname
, int force_create
, struct strbuf
*err
);
431 /** Reads log for the value of ref during at_time. **/
432 int read_ref_at(struct ref_store
*refs
,
433 const char *refname
, unsigned int flags
,
434 timestamp_t at_time
, int cnt
,
435 struct object_id
*oid
, char **msg
,
436 timestamp_t
*cutoff_time
, int *cutoff_tz
, int *cutoff_cnt
);
438 /** Check if a particular reflog exists */
439 int refs_reflog_exists(struct ref_store
*refs
, const char *refname
);
440 int reflog_exists(const char *refname
);
443 * Delete the specified reference. If old_oid is non-NULL, then
444 * verify that the current value of the reference is old_oid before
445 * deleting it. If old_oid is NULL, delete the reference if it
446 * exists, regardless of its old value. It is an error for old_oid to
447 * be null_oid. msg and flags are passed through to
448 * ref_transaction_delete().
450 int refs_delete_ref(struct ref_store
*refs
, const char *msg
,
452 const struct object_id
*old_oid
,
454 int delete_ref(const char *msg
, const char *refname
,
455 const struct object_id
*old_oid
, unsigned int flags
);
458 * Delete the specified references. If there are any problems, emit
459 * errors but attempt to keep going (i.e., the deletes are not done in
460 * an all-or-nothing transaction). msg and flags are passed through to
461 * ref_transaction_delete().
463 int refs_delete_refs(struct ref_store
*refs
, const char *msg
,
464 struct string_list
*refnames
, unsigned int flags
);
465 int delete_refs(const char *msg
, struct string_list
*refnames
,
468 /** Delete a reflog */
469 int refs_delete_reflog(struct ref_store
*refs
, const char *refname
);
470 int delete_reflog(const char *refname
);
473 * Callback to process a reflog entry found by the iteration functions (see
476 typedef int each_reflog_ent_fn(
477 struct object_id
*old_oid
, struct object_id
*new_oid
,
478 const char *committer
, timestamp_t timestamp
,
479 int tz
, const char *msg
, void *cb_data
);
481 /* Iterate over reflog entries in the log for `refname`. */
483 /* oldest entry first */
484 int refs_for_each_reflog_ent(struct ref_store
*refs
, const char *refname
,
485 each_reflog_ent_fn fn
, void *cb_data
);
487 /* youngest entry first */
488 int refs_for_each_reflog_ent_reverse(struct ref_store
*refs
,
490 each_reflog_ent_fn fn
,
494 * Iterate over reflog entries in the log for `refname` in the main ref store.
497 /* oldest entry first */
498 int for_each_reflog_ent(const char *refname
, each_reflog_ent_fn fn
, void *cb_data
);
500 /* youngest entry first */
501 int for_each_reflog_ent_reverse(const char *refname
, each_reflog_ent_fn fn
, void *cb_data
);
504 * Calls the specified function for each reflog file until it returns nonzero,
505 * and returns the value. Reflog file order is unspecified.
507 int refs_for_each_reflog(struct ref_store
*refs
, each_ref_fn fn
, void *cb_data
);
508 int for_each_reflog(each_ref_fn fn
, void *cb_data
);
510 #define REFNAME_ALLOW_ONELEVEL 1
511 #define REFNAME_REFSPEC_PATTERN 2
514 * Return 0 iff refname has the correct format for a refname according
515 * to the rules described in Documentation/git-check-ref-format.txt.
516 * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level
517 * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then
518 * allow a single "*" wildcard character in the refspec. No leading or
519 * repeated slashes are accepted.
521 int check_refname_format(const char *refname
, int flags
);
524 * Apply the rules from check_refname_format, but mutate the result until it
525 * is acceptable, and place the result in "out".
527 void sanitize_refname_component(const char *refname
, struct strbuf
*out
);
529 const char *prettify_refname(const char *refname
);
531 char *refs_shorten_unambiguous_ref(struct ref_store
*refs
,
532 const char *refname
, int strict
);
533 char *shorten_unambiguous_ref(const char *refname
, int strict
);
535 /** rename ref, return 0 on success **/
536 int refs_rename_ref(struct ref_store
*refs
, const char *oldref
,
537 const char *newref
, const char *logmsg
);
538 int rename_ref(const char *oldref
, const char *newref
,
541 /** copy ref, return 0 on success **/
542 int refs_copy_existing_ref(struct ref_store
*refs
, const char *oldref
,
543 const char *newref
, const char *logmsg
);
544 int copy_existing_ref(const char *oldref
, const char *newref
,
547 int refs_create_symref(struct ref_store
*refs
, const char *refname
,
548 const char *target
, const char *logmsg
);
549 int create_symref(const char *refname
, const char *target
, const char *logmsg
);
552 UPDATE_REFS_MSG_ON_ERR
,
553 UPDATE_REFS_DIE_ON_ERR
,
554 UPDATE_REFS_QUIET_ON_ERR
558 * Begin a reference transaction. The reference transaction must
559 * be freed by calling ref_transaction_free().
561 struct ref_transaction
*ref_store_transaction_begin(struct ref_store
*refs
,
563 struct ref_transaction
*ref_transaction_begin(struct strbuf
*err
);
566 * Reference transaction updates
568 * The following four functions add a reference check or update to a
569 * ref_transaction. They have some common similar parameters:
571 * transaction -- a pointer to an open ref_transaction, obtained
572 * from ref_transaction_begin().
574 * refname -- the name of the reference to be affected.
576 * new_oid -- the object ID that should be set to be the new value
577 * of the reference. Some functions allow this parameter to be
578 * NULL, meaning that the reference is not changed, or
579 * null_oid, meaning that the reference should be deleted. A
580 * copy of this value is made in the transaction.
582 * old_oid -- the object ID that the reference must have before
583 * the update. Some functions allow this parameter to be NULL,
584 * meaning that the old value of the reference is not checked,
585 * or null_oid, meaning that the reference must not exist
586 * before the update. A copy of this value is made in the
589 * flags -- flags affecting the update, passed to
590 * update_ref_lock(). Possible flags: REF_NO_DEREF,
591 * REF_FORCE_CREATE_REFLOG. See those constants for more
594 * msg -- a message describing the change (for the reflog).
596 * err -- a strbuf for receiving a description of any error that
597 * might have occurred.
599 * The functions make internal copies of refname and msg, so the
600 * caller retains ownership of these parameters.
602 * The functions return 0 on success and non-zero on failure. A
603 * failure means that the transaction as a whole has failed and needs
608 * The following flags can be passed to ref_transaction_update() etc.
609 * Internally, they are stored in `ref_update::flags`, along with some
614 * Act on the ref directly; i.e., without dereferencing symbolic refs.
615 * If this flag is not specified, then symbolic references are
616 * dereferenced and the update is applied to the referent.
618 #define REF_NO_DEREF (1 << 0)
621 * Force the creation of a reflog for this reference, even if it
622 * didn't previously have a reflog.
624 #define REF_FORCE_CREATE_REFLOG (1 << 1)
627 * Bitmask of all of the flags that are allowed to be passed in to
628 * ref_transaction_update() and friends:
630 #define REF_TRANSACTION_UPDATE_ALLOWED_FLAGS \
631 (REF_NO_DEREF | REF_FORCE_CREATE_REFLOG)
634 * Add a reference update to transaction. `new_oid` is the value that
635 * the reference should have after the update, or `null_oid` if it
636 * should be deleted. If `new_oid` is NULL, then the reference is not
637 * changed at all. `old_oid` is the value that the reference must have
638 * before the update, or `null_oid` if it must not have existed
639 * beforehand. The old value is checked after the lock is taken to
640 * prevent races. If the old value doesn't agree with old_oid, the
641 * whole transaction fails. If old_oid is NULL, then the previous
642 * value is not checked.
644 * See the above comment "Reference transaction updates" for more
647 int ref_transaction_update(struct ref_transaction
*transaction
,
649 const struct object_id
*new_oid
,
650 const struct object_id
*old_oid
,
651 unsigned int flags
, const char *msg
,
655 * Add a reference creation to transaction. new_oid is the value that
656 * the reference should have after the update; it must not be
657 * null_oid. It is verified that the reference does not exist
660 * See the above comment "Reference transaction updates" for more
663 int ref_transaction_create(struct ref_transaction
*transaction
,
665 const struct object_id
*new_oid
,
666 unsigned int flags
, const char *msg
,
670 * Add a reference deletion to transaction. If old_oid is non-NULL,
671 * then it holds the value that the reference should have had before
672 * the update (which must not be null_oid).
674 * See the above comment "Reference transaction updates" for more
677 int ref_transaction_delete(struct ref_transaction
*transaction
,
679 const struct object_id
*old_oid
,
680 unsigned int flags
, const char *msg
,
684 * Verify, within a transaction, that refname has the value old_oid,
685 * or, if old_oid is null_oid, then verify that the reference
686 * doesn't exist. old_oid must be non-NULL.
688 * See the above comment "Reference transaction updates" for more
691 int ref_transaction_verify(struct ref_transaction
*transaction
,
693 const struct object_id
*old_oid
,
697 /* Naming conflict (for example, the ref names A and A/B conflict). */
698 #define TRANSACTION_NAME_CONFLICT -1
699 /* All other errors. */
700 #define TRANSACTION_GENERIC_ERROR -2
703 * Perform the preparatory stages of committing `transaction`. Acquire
704 * any needed locks, check preconditions, etc.; basically, do as much
705 * as possible to ensure that the transaction will be able to go
706 * through, stopping just short of making any irrevocable or
707 * user-visible changes. The updates that this function prepares can
708 * be finished up by calling `ref_transaction_commit()` or rolled back
709 * by calling `ref_transaction_abort()`.
711 * On success, return 0 and leave the transaction in "prepared" state.
712 * On failure, abort the transaction, write an error message to `err`,
713 * and return one of the `TRANSACTION_*` constants.
715 * Callers who don't need such fine-grained control over committing
716 * reference transactions should just call `ref_transaction_commit()`.
718 int ref_transaction_prepare(struct ref_transaction
*transaction
,
722 * Commit all of the changes that have been queued in transaction, as
723 * atomically as possible. On success, return 0 and leave the
724 * transaction in "closed" state. On failure, roll back the
725 * transaction, write an error message to `err`, and return one of the
726 * `TRANSACTION_*` constants
728 int ref_transaction_commit(struct ref_transaction
*transaction
,
732 * Abort `transaction`, which has been begun and possibly prepared,
733 * but not yet committed.
735 int ref_transaction_abort(struct ref_transaction
*transaction
,
739 * Like ref_transaction_commit(), but optimized for creating
740 * references when originally initializing a repository (e.g., by "git
741 * clone"). It writes the new references directly to packed-refs
742 * without locking the individual references.
744 * It is a bug to call this function when there might be other
745 * processes accessing the repository or if there are existing
746 * references that might conflict with the ones being created. All
747 * old_oid values must either be absent or null_oid.
749 int initial_ref_transaction_commit(struct ref_transaction
*transaction
,
753 * Free `*transaction` and all associated data.
755 void ref_transaction_free(struct ref_transaction
*transaction
);
758 * Lock, update, and unlock a single reference. This function
759 * basically does a transaction containing a single call to
760 * ref_transaction_update(). The parameters to this function have the
761 * same meaning as the corresponding parameters to
762 * ref_transaction_update(). Handle errors as requested by the `onerr`
765 int refs_update_ref(struct ref_store
*refs
, const char *msg
, const char *refname
,
766 const struct object_id
*new_oid
, const struct object_id
*old_oid
,
767 unsigned int flags
, enum action_on_err onerr
);
768 int update_ref(const char *msg
, const char *refname
,
769 const struct object_id
*new_oid
, const struct object_id
*old_oid
,
770 unsigned int flags
, enum action_on_err onerr
);
772 int parse_hide_refs_config(const char *var
, const char *value
, const char *);
775 * Check whether a ref is hidden. If no namespace is set, both the first and
776 * the second parameter point to the full ref name. If a namespace is set and
777 * the ref is inside that namespace, the first parameter is a pointer to the
778 * name of the ref with the namespace prefix removed. If a namespace is set and
779 * the ref is outside that namespace, the first parameter is NULL. The second
780 * parameter always points to the full ref name.
782 int ref_is_hidden(const char *, const char *);
785 REF_TYPE_PER_WORKTREE
, /* refs inside refs/ but not shared */
786 REF_TYPE_PSEUDOREF
, /* refs outside refs/ in current worktree */
787 REF_TYPE_MAIN_PSEUDOREF
, /* pseudo refs from the main worktree */
788 REF_TYPE_OTHER_PSEUDOREF
, /* pseudo refs from other worktrees */
789 REF_TYPE_NORMAL
, /* normal/shared refs inside refs/ */
792 enum ref_type
ref_type(const char *refname
);
794 enum expire_reflog_flags
{
795 EXPIRE_REFLOGS_DRY_RUN
= 1 << 0,
796 EXPIRE_REFLOGS_UPDATE_REF
= 1 << 1,
797 EXPIRE_REFLOGS_VERBOSE
= 1 << 2,
798 EXPIRE_REFLOGS_REWRITE
= 1 << 3
802 * The following interface is used for reflog expiration. The caller
803 * calls reflog_expire(), supplying it with three callback functions,
804 * of the following types. The callback functions define the
805 * expiration policy that is desired.
807 * reflog_expiry_prepare_fn -- Called once after the reference is
808 * locked. Called with the OID of the locked reference.
810 * reflog_expiry_should_prune_fn -- Called once for each entry in the
811 * existing reflog. It should return true iff that entry should be
814 * reflog_expiry_cleanup_fn -- Called once before the reference is
817 typedef void reflog_expiry_prepare_fn(const char *refname
,
818 const struct object_id
*oid
,
820 typedef int reflog_expiry_should_prune_fn(struct object_id
*ooid
,
821 struct object_id
*noid
,
823 timestamp_t timestamp
, int tz
,
824 const char *message
, void *cb_data
);
825 typedef void reflog_expiry_cleanup_fn(void *cb_data
);
828 * Expire reflog entries for the specified reference.
829 * flags is a combination of the constants in
830 * enum expire_reflog_flags. The three function pointers are described
831 * above. On success, return zero.
833 int refs_reflog_expire(struct ref_store
*refs
,
836 reflog_expiry_prepare_fn prepare_fn
,
837 reflog_expiry_should_prune_fn should_prune_fn
,
838 reflog_expiry_cleanup_fn cleanup_fn
,
839 void *policy_cb_data
);
840 int reflog_expire(const char *refname
,
842 reflog_expiry_prepare_fn prepare_fn
,
843 reflog_expiry_should_prune_fn should_prune_fn
,
844 reflog_expiry_cleanup_fn cleanup_fn
,
845 void *policy_cb_data
);
847 struct ref_store
*get_main_ref_store(struct repository
*r
);
853 * If you want to iterate the refs of a submodule you first need to add the
854 * submodules object database. You can do this by a code-snippet like
857 * const char *path = "path/to/submodule"
858 * if (add_submodule_odb(path))
859 * die("Error submodule '%s' not populated.", path);
861 * `add_submodule_odb()` will return zero on success. If you
862 * do not do this you will get an error for each ref that it does not point
865 * Note: As a side-effect of this you cannot safely assume that all
866 * objects you lookup are available in superproject. All submodule objects
867 * will be available the same way as the superprojects objects.
873 * static int handle_remote_ref(const char *refname,
874 * const unsigned char *sha1, int flags, void *cb_data)
876 * struct strbuf *output = cb_data;
877 * strbuf_addf(output, "%s\n", refname);
884 * Return the ref_store instance for the specified submodule. For the
885 * main repository, use submodule==NULL; such a call cannot fail. For
886 * a submodule, the submodule must exist and be a nonbare repository,
887 * otherwise return NULL. If the requested reference store has not yet
888 * been initialized, initialize it first.
890 * For backwards compatibility, submodule=="" is treated the same as
893 struct ref_store
*get_submodule_ref_store(const char *submodule
);
894 struct ref_store
*get_worktree_ref_store(const struct worktree
*wt
);