4 #include "git-compat-util.h"
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
;
41 struct fsmonitor_settings
*fsmonitor
; /* lazily loaded */
44 enum untracked_cache_setting core_untracked_cache
;
47 enum fetch_negotiation_setting fetch_negotiation_algorithm
;
49 int core_multi_pack_index
;
52 struct repo_path_cache
{
58 char *merge_autostash
;
67 * Path to the git directory.
68 * Cannot be NULL after initialization.
73 * Path to the common git directory.
74 * Cannot be NULL after initialization.
79 * Holds any information related to accessing the raw object content.
81 struct raw_object_store
*objects
;
84 * All objects in this repository that have been parsed. This structure
85 * owns all objects it references, so users of "struct object *"
86 * generally do not need to free them; instead, when a repository is no
87 * longer used, call parsed_object_pool_clear() on this structure, which
88 * is called by the repositories repo_clear on its desconstruction.
90 struct parsed_object_pool
*parsed_objects
;
93 * The store in which the refs are held. This should generally only be
94 * accessed via get_main_ref_store(), as that will lazily initialize
97 struct ref_store
*refs_private
;
100 * Contains path to often used file names.
102 struct repo_path_cache cached_paths
;
105 * Path to the repository's graft file.
106 * Cannot be NULL after initialization.
111 * Path to the current worktree's index file.
112 * Cannot be NULL after initialization.
117 * Path to the working directory.
118 * A NULL value indicates that there is no working directory.
123 * Path from the root of the top-level superproject down to this
124 * repository. This is only non-NULL if the repository is initialized
125 * as a submodule of another repository.
127 char *submodule_prefix
;
129 struct repo_settings settings
;
133 * Repository's config which contains key-value pairs from the usual
134 * set of config files (i.e. repo specific .git/config, user wide
135 * ~/.gitconfig, XDG config file and the global /etc/gitconfig)
137 struct config_set
*config
;
139 /* Repository's submodule config as defined by '.gitmodules' */
140 struct submodule_cache
*submodule_cache
;
143 * Repository's in-memory index.
144 * 'repo_read_index()' can be used to populate 'index'.
146 struct index_state
*index
;
148 /* Repository's remotes and associated structures. */
149 struct remote_state
*remote_state
;
151 /* Repository's current hash algorithm, as serialized on disk. */
152 const struct git_hash_algo
*hash_algo
;
154 /* A unique-id for tracing purposes. */
157 /* True if commit-graph has been disabled within this process. */
158 int commit_graph_disabled
;
160 /* Configurations related to promisor remotes. */
161 char *repository_format_partial_clone
;
162 struct promisor_remote_config
*promisor_remote_config
;
166 /* Indicate if a repository has a different 'commondir' from 'gitdir' */
167 unsigned different_commondir
:1;
170 extern struct repository
*the_repository
;
173 * Define a custom repository layout. Any field can be NULL, which
174 * will default back to the path according to the default layout.
176 struct set_gitdir_args
{
177 const char *commondir
;
178 const char *object_dir
;
179 const char *graft_file
;
180 const char *index_file
;
181 const char *alternate_db
;
182 int disable_ref_updates
;
185 void repo_set_gitdir(struct repository
*repo
, const char *root
,
186 const struct set_gitdir_args
*extra_args
);
187 void repo_set_worktree(struct repository
*repo
, const char *path
);
188 void repo_set_hash_algo(struct repository
*repo
, int algo
);
189 void initialize_the_repository(void);
191 int repo_init(struct repository
*r
, const char *gitdir
, const char *worktree
);
194 * Initialize the repository 'subrepo' as the submodule at the given path. If
195 * the submodule's gitdir cannot be found at <path>/.git, this function calls
196 * submodule_from_path() to try to find it. treeish_name is only used if
197 * submodule_from_path() needs to be called; see its documentation for more
199 * Return 0 upon success and a non-zero value upon failure.
203 int repo_submodule_init(struct repository
*subrepo
,
204 struct repository
*superproject
,
206 const struct object_id
*treeish_name
);
207 void repo_clear(struct repository
*repo
);
210 * Populates the repository's index from its index_file, an index struct will
211 * be allocated if needed.
213 * Return the number of index entries in the populated index or a value less
214 * than zero if an error occurred. If the repository's index has already been
215 * populated then the number of entries will simply be returned.
217 int repo_read_index(struct repository
*repo
);
218 int repo_hold_locked_index(struct repository
*repo
,
219 struct lock_file
*lf
,
222 int repo_read_index_preload(struct repository
*,
223 const struct pathspec
*pathspec
,
224 unsigned refresh_flags
);
225 int repo_read_index_unmerged(struct repository
*);
227 * Opportunistically update the index but do not complain if we can't.
228 * The lockfile is always committed or rolled back.
230 void repo_update_index_if_able(struct repository
*, struct lock_file
*);
232 void prepare_repo_settings(struct repository
*r
);
235 * Return 1 if upgrade repository format to target_version succeeded,
236 * 0 if no upgrade is necessary, and -1 when upgrade is not possible.
238 int upgrade_repository_format(int target_version
);
240 #endif /* REPOSITORY_H */