11 struct raw_object_store
;
12 struct submodule_cache
;
13 struct promisor_remote_config
;
16 enum untracked_cache_setting
{
18 UNTRACKED_CACHE_REMOVE
,
19 UNTRACKED_CACHE_WRITE
,
22 enum fetch_negotiation_setting
{
23 FETCH_NEGOTIATION_CONSECUTIVE
,
24 FETCH_NEGOTIATION_SKIPPING
,
25 FETCH_NEGOTIATION_NOOP
,
28 struct repo_settings
{
31 int core_commit_graph
;
32 int commit_graph_read_changed_paths
;
33 int gc_write_commit_graph
;
34 int fetch_write_commit_graph
;
35 int command_requires_full_index
;
39 enum untracked_cache_setting core_untracked_cache
;
42 enum fetch_negotiation_setting fetch_negotiation_algorithm
;
44 int core_multi_pack_index
;
47 struct repo_path_cache
{
53 char *merge_autostash
;
62 * Path to the git directory.
63 * Cannot be NULL after initialization.
68 * Path to the common git directory.
69 * Cannot be NULL after initialization.
74 * Holds any information related to accessing the raw object content.
76 struct raw_object_store
*objects
;
79 * All objects in this repository that have been parsed. This structure
80 * owns all objects it references, so users of "struct object *"
81 * generally do not need to free them; instead, when a repository is no
82 * longer used, call parsed_object_pool_clear() on this structure, which
83 * is called by the repositories repo_clear on its desconstruction.
85 struct parsed_object_pool
*parsed_objects
;
88 * The store in which the refs are held. This should generally only be
89 * accessed via get_main_ref_store(), as that will lazily initialize
92 struct ref_store
*refs_private
;
95 * Contains path to often used file names.
97 struct repo_path_cache cached_paths
;
100 * Path to the repository's graft file.
101 * Cannot be NULL after initialization.
106 * Path to the current worktree's index file.
107 * Cannot be NULL after initialization.
112 * Path to the working directory.
113 * A NULL value indicates that there is no working directory.
118 * Path from the root of the top-level superproject down to this
119 * repository. This is only non-NULL if the repository is initialized
120 * as a submodule of another repository.
122 char *submodule_prefix
;
124 struct repo_settings settings
;
128 * Repository's config which contains key-value pairs from the usual
129 * set of config files (i.e. repo specific .git/config, user wide
130 * ~/.gitconfig, XDG config file and the global /etc/gitconfig)
132 struct config_set
*config
;
134 /* Repository's submodule config as defined by '.gitmodules' */
135 struct submodule_cache
*submodule_cache
;
138 * Repository's in-memory index.
139 * 'repo_read_index()' can be used to populate 'index'.
141 struct index_state
*index
;
143 /* Repository's remotes and associated structures. */
144 struct remote_state
*remote_state
;
146 /* Repository's current hash algorithm, as serialized on disk. */
147 const struct git_hash_algo
*hash_algo
;
149 /* A unique-id for tracing purposes. */
152 /* True if commit-graph has been disabled within this process. */
153 int commit_graph_disabled
;
155 /* Configurations related to promisor remotes. */
156 char *repository_format_partial_clone
;
157 struct promisor_remote_config
*promisor_remote_config
;
161 /* Indicate if a repository has a different 'commondir' from 'gitdir' */
162 unsigned different_commondir
:1;
165 extern struct repository
*the_repository
;
168 * Define a custom repository layout. Any field can be NULL, which
169 * will default back to the path according to the default layout.
171 struct set_gitdir_args
{
172 const char *commondir
;
173 const char *object_dir
;
174 const char *graft_file
;
175 const char *index_file
;
176 const char *alternate_db
;
177 int disable_ref_updates
;
180 void repo_set_gitdir(struct repository
*repo
, const char *root
,
181 const struct set_gitdir_args
*extra_args
);
182 void repo_set_worktree(struct repository
*repo
, const char *path
);
183 void repo_set_hash_algo(struct repository
*repo
, int algo
);
184 void initialize_the_repository(void);
185 int repo_init(struct repository
*r
, const char *gitdir
, const char *worktree
);
188 * Initialize the repository 'subrepo' as the submodule at the given path. If
189 * the submodule's gitdir cannot be found at <path>/.git, this function calls
190 * submodule_from_path() to try to find it. treeish_name is only used if
191 * submodule_from_path() needs to be called; see its documentation for more
193 * Return 0 upon success and a non-zero value upon failure.
196 int repo_submodule_init(struct repository
*subrepo
,
197 struct repository
*superproject
,
199 const struct object_id
*treeish_name
);
200 void repo_clear(struct repository
*repo
);
203 * Populates the repository's index from its index_file, an index struct will
204 * be allocated if needed.
206 * Return the number of index entries in the populated index or a value less
207 * than zero if an error occurred. If the repository's index has already been
208 * populated then the number of entries will simply be returned.
210 int repo_read_index(struct repository
*repo
);
211 int repo_hold_locked_index(struct repository
*repo
,
212 struct lock_file
*lf
,
215 int repo_read_index_preload(struct repository
*,
216 const struct pathspec
*pathspec
,
217 unsigned refresh_flags
);
218 int repo_read_index_unmerged(struct repository
*);
220 * Opportunistically update the index but do not complain if we can't.
221 * The lockfile is always committed or rolled back.
223 void repo_update_index_if_able(struct repository
*, struct lock_file
*);
225 void prepare_repo_settings(struct repository
*r
);
228 * Return 1 if upgrade repository format to target_version succeeded,
229 * 0 if no upgrade is necessary, and -1 when upgrade is not possible.
231 int upgrade_repository_format(int target_version
);
233 #endif /* REPOSITORY_H */