8 struct fsmonitor_settings
;
13 struct raw_object_store
;
14 struct submodule_cache
;
15 struct promisor_remote_config
;
18 enum untracked_cache_setting
{
20 UNTRACKED_CACHE_REMOVE
,
21 UNTRACKED_CACHE_WRITE
,
24 enum fetch_negotiation_setting
{
25 FETCH_NEGOTIATION_CONSECUTIVE
,
26 FETCH_NEGOTIATION_SKIPPING
,
27 FETCH_NEGOTIATION_NOOP
,
30 struct repo_settings
{
33 int core_commit_graph
;
34 int commit_graph_generation_version
;
35 int commit_graph_read_changed_paths
;
36 int gc_write_commit_graph
;
37 int fetch_write_commit_graph
;
38 int command_requires_full_index
;
40 int pack_read_reverse_index
;
41 int pack_use_bitmap_boundary_traversal
;
42 int pack_use_multi_pack_reuse
;
45 * Does this repository have core.useReplaceRefs=true (on by
46 * default)? This provides a repository-scoped version of this
47 * config, though it could be disabled process-wide via some Git
48 * builtins or the --no-replace-objects option. See
49 * replace_refs_enabled() for more details.
51 int read_replace_refs
;
53 struct fsmonitor_settings
*fsmonitor
; /* lazily loaded */
57 enum untracked_cache_setting core_untracked_cache
;
60 enum fetch_negotiation_setting fetch_negotiation_algorithm
;
62 int core_multi_pack_index
;
65 struct repo_path_cache
{
78 * Path to the git directory.
79 * Cannot be NULL after initialization.
84 * Path to the common git directory.
85 * Cannot be NULL after initialization.
90 * Holds any information related to accessing the raw object content.
92 struct raw_object_store
*objects
;
95 * All objects in this repository that have been parsed. This structure
96 * owns all objects it references, so users of "struct object *"
97 * generally do not need to free them; instead, when a repository is no
98 * longer used, call parsed_object_pool_clear() on this structure, which
99 * is called by the repositories repo_clear on its desconstruction.
101 struct parsed_object_pool
*parsed_objects
;
104 * The store in which the refs are held. This should generally only be
105 * accessed via get_main_ref_store(), as that will lazily initialize
108 struct ref_store
*refs_private
;
111 * A strmap of ref_stores, stored by submodule name, accessible via
112 * `repo_get_submodule_ref_store()`.
114 struct strmap submodule_ref_stores
;
117 * A strmap of ref_stores, stored by worktree id, accessible via
118 * `get_worktree_ref_store()`.
120 struct strmap worktree_ref_stores
;
123 * Contains path to often used file names.
125 struct repo_path_cache cached_paths
;
128 * Path to the repository's graft file.
129 * Cannot be NULL after initialization.
134 * Path to the current worktree's index file.
135 * Cannot be NULL after initialization.
140 * Path to the working directory.
141 * A NULL value indicates that there is no working directory.
146 * Path from the root of the top-level superproject down to this
147 * repository. This is only non-NULL if the repository is initialized
148 * as a submodule of another repository.
150 char *submodule_prefix
;
152 struct repo_settings settings
;
156 * Repository's config which contains key-value pairs from the usual
157 * set of config files (i.e. repo specific .git/config, user wide
158 * ~/.gitconfig, XDG config file and the global /etc/gitconfig)
160 struct config_set
*config
;
162 /* Repository's submodule config as defined by '.gitmodules' */
163 struct submodule_cache
*submodule_cache
;
166 * Repository's in-memory index.
167 * 'repo_read_index()' can be used to populate 'index'.
169 struct index_state
*index
;
171 /* Repository's remotes and associated structures. */
172 struct remote_state
*remote_state
;
174 /* Repository's current hash algorithm, as serialized on disk. */
175 const struct git_hash_algo
*hash_algo
;
177 /* Repository's compatibility hash algorithm. */
178 const struct git_hash_algo
*compat_hash_algo
;
180 /* Repository's reference storage format, as serialized on disk. */
181 enum ref_storage_format ref_storage_format
;
183 /* A unique-id for tracing purposes. */
186 /* True if commit-graph has been disabled within this process. */
187 int commit_graph_disabled
;
189 /* Configurations related to promisor remotes. */
190 char *repository_format_partial_clone
;
191 struct promisor_remote_config
*promisor_remote_config
;
194 int repository_format_worktree_config
;
196 /* Indicate if a repository has a different 'commondir' from 'gitdir' */
197 unsigned different_commondir
:1;
200 extern struct repository
*the_repository
;
203 * Define a custom repository layout. Any field can be NULL, which
204 * will default back to the path according to the default layout.
206 struct set_gitdir_args
{
207 const char *commondir
;
208 const char *object_dir
;
209 const char *graft_file
;
210 const char *index_file
;
211 const char *alternate_db
;
212 int disable_ref_updates
;
215 void repo_set_gitdir(struct repository
*repo
, const char *root
,
216 const struct set_gitdir_args
*extra_args
);
217 void repo_set_worktree(struct repository
*repo
, const char *path
);
218 void repo_set_hash_algo(struct repository
*repo
, int algo
);
219 void repo_set_compat_hash_algo(struct repository
*repo
, int compat_algo
);
220 void repo_set_ref_storage_format(struct repository
*repo
,
221 enum ref_storage_format format
);
222 void initialize_repository(struct repository
*repo
);
224 int repo_init(struct repository
*r
, const char *gitdir
, const char *worktree
);
227 * Initialize the repository 'subrepo' as the submodule at the given path. If
228 * the submodule's gitdir cannot be found at <path>/.git, this function calls
229 * submodule_from_path() to try to find it. treeish_name is only used if
230 * submodule_from_path() needs to be called; see its documentation for more
232 * Return 0 upon success and a non-zero value upon failure.
236 int repo_submodule_init(struct repository
*subrepo
,
237 struct repository
*superproject
,
239 const struct object_id
*treeish_name
);
240 void repo_clear(struct repository
*repo
);
243 * Populates the repository's index from its index_file, an index struct will
244 * be allocated if needed.
246 * Return the number of index entries in the populated index or a value less
247 * than zero if an error occurred. If the repository's index has already been
248 * populated then the number of entries will simply be returned.
250 int repo_read_index(struct repository
*repo
);
251 int repo_hold_locked_index(struct repository
*repo
,
252 struct lock_file
*lf
,
255 int repo_read_index_unmerged(struct repository
*);
257 * Opportunistically update the index but do not complain if we can't.
258 * The lockfile is always committed or rolled back.
260 void repo_update_index_if_able(struct repository
*, struct lock_file
*);
262 void prepare_repo_settings(struct repository
*r
);
265 * Return 1 if upgrade repository format to target_version succeeded,
266 * 0 if no upgrade is necessary, and -1 when upgrade is not possible.
268 int upgrade_repository_format(int target_version
);
270 #endif /* REPOSITORY_H */