freshlybakedca.ke
Git fork
1#ifndef REFS_PACKED_BACKEND_H
2#define REFS_PACKED_BACKEND_H
3
4struct repository;
5struct ref_transaction;
6
7/*
8 * Support for storing references in a `packed-refs` file.
9 *
10 * Note that this backend doesn't check for D/F conflicts, because it
11 * doesn't care about them. But usually it should be wrapped in a
12 * `files_ref_store` that prevents D/F conflicts from being created,
13 * even among packed refs.
14 */
15
16struct ref_store *packed_ref_store_init(struct repository *repo,
17 const char *gitdir,
18 unsigned int store_flags);
19
20/*
21 * Lock the packed-refs file for writing. Flags is passed to
22 * hold_lock_file_for_update(). Return 0 on success. On errors, write
23 * an error message to `err` and return a nonzero value.
24 */
25int packed_refs_lock(struct ref_store *ref_store, int flags, struct strbuf *err);
26
27void packed_refs_unlock(struct ref_store *ref_store);
28int packed_refs_is_locked(struct ref_store *ref_store);
29
30/*
31 * Obtain the size of the `packed-refs` file. Reports `0` as size in case there
32 * is no packed-refs file. Returns 0 on success, negative otherwise.
33 */
34int packed_refs_size(struct ref_store *ref_store,
35 size_t *out);
36
37/*
38 * Return true if `transaction` really needs to be carried out against
39 * the specified packed_ref_store, or false if it can be skipped
40 * (i.e., because it is an obvious NOOP). `ref_store` must be locked
41 * before calling this function.
42 */
43int is_packed_transaction_needed(struct ref_store *ref_store,
44 struct ref_transaction *transaction);
45
46#endif /* REFS_PACKED_BACKEND_H */