11 struct raw_object_store
;
12 struct submodule_cache
;
13 struct promisor_remote_config
;
15 enum untracked_cache_setting
{
16 UNTRACKED_CACHE_UNSET
= -1,
17 UNTRACKED_CACHE_REMOVE
= 0,
18 UNTRACKED_CACHE_KEEP
= 1,
19 UNTRACKED_CACHE_WRITE
= 2
22 enum fetch_negotiation_setting
{
23 FETCH_NEGOTIATION_UNSET
= -1,
24 FETCH_NEGOTIATION_NONE
= 0,
25 FETCH_NEGOTIATION_DEFAULT
= 1,
26 FETCH_NEGOTIATION_SKIPPING
= 2,
27 FETCH_NEGOTIATION_NOOP
= 3,
30 struct repo_settings
{
33 int core_commit_graph
;
34 int commit_graph_read_changed_paths
;
35 int gc_write_commit_graph
;
36 int fetch_write_commit_graph
;
39 enum untracked_cache_setting core_untracked_cache
;
42 enum fetch_negotiation_setting fetch_negotiation_algorithm
;
44 int core_multi_pack_index
;
46 unsigned command_requires_full_index
:1,
53 * Path to the git directory.
54 * Cannot be NULL after initialization.
59 * Path to the common git directory.
60 * Cannot be NULL after initialization.
65 * Holds any information related to accessing the raw object content.
67 struct raw_object_store
*objects
;
70 * All objects in this repository that have been parsed. This structure
71 * owns all objects it references, so users of "struct object *"
72 * generally do not need to free them; instead, when a repository is no
73 * longer used, call parsed_object_pool_clear() on this structure, which
74 * is called by the repositories repo_clear on its desconstruction.
76 struct parsed_object_pool
*parsed_objects
;
79 * The store in which the refs are held. This should generally only be
80 * accessed via get_main_ref_store(), as that will lazily initialize
83 struct ref_store
*refs_private
;
86 * Contains path to often used file names.
88 struct path_cache cached_paths
;
91 * Path to the repository's graft file.
92 * Cannot be NULL after initialization.
97 * Path to the current worktree's index file.
98 * Cannot be NULL after initialization.
103 * Path to the working directory.
104 * A NULL value indicates that there is no working directory.
109 * Path from the root of the top-level superproject down to this
110 * repository. This is only non-NULL if the repository is initialized
111 * as a submodule of another repository.
113 char *submodule_prefix
;
115 struct repo_settings settings
;
119 * Repository's config which contains key-value pairs from the usual
120 * set of config files (i.e. repo specific .git/config, user wide
121 * ~/.gitconfig, XDG config file and the global /etc/gitconfig)
123 struct config_set
*config
;
125 /* Repository's submodule config as defined by '.gitmodules' */
126 struct submodule_cache
*submodule_cache
;
129 * Repository's in-memory index.
130 * 'repo_read_index()' can be used to populate 'index'.
132 struct index_state
*index
;
134 /* Repository's current hash algorithm, as serialized on disk. */
135 const struct git_hash_algo
*hash_algo
;
137 /* A unique-id for tracing purposes. */
140 /* True if commit-graph has been disabled within this process. */
141 int commit_graph_disabled
;
143 /* Configurations related to promisor remotes. */
144 char *repository_format_partial_clone
;
145 struct promisor_remote_config
*promisor_remote_config
;
149 /* Indicate if a repository has a different 'commondir' from 'gitdir' */
150 unsigned different_commondir
:1;
153 extern struct repository
*the_repository
;
156 * Define a custom repository layout. Any field can be NULL, which
157 * will default back to the path according to the default layout.
159 struct set_gitdir_args
{
160 const char *commondir
;
161 const char *object_dir
;
162 const char *graft_file
;
163 const char *index_file
;
164 const char *alternate_db
;
167 void repo_set_gitdir(struct repository
*repo
, const char *root
,
168 const struct set_gitdir_args
*extra_args
);
169 void repo_set_worktree(struct repository
*repo
, const char *path
);
170 void repo_set_hash_algo(struct repository
*repo
, int algo
);
171 void initialize_the_repository(void);
172 int repo_init(struct repository
*r
, const char *gitdir
, const char *worktree
);
175 * Initialize the repository 'subrepo' as the submodule given by the
176 * struct submodule 'sub' in parent repository 'superproject'.
177 * Return 0 upon success and a non-zero value upon failure, which may happen
178 * if the submodule is not found, or 'sub' is NULL.
181 int repo_submodule_init(struct repository
*subrepo
,
182 struct repository
*superproject
,
183 const struct submodule
*sub
);
184 void repo_clear(struct repository
*repo
);
187 * Populates the repository's index from its index_file, an index struct will
188 * be allocated if needed.
190 * Return the number of index entries in the populated index or a value less
191 * than zero if an error occurred. If the repository's index has already been
192 * populated then the number of entries will simply be returned.
194 int repo_read_index(struct repository
*repo
);
195 int repo_hold_locked_index(struct repository
*repo
,
196 struct lock_file
*lf
,
199 int repo_read_index_preload(struct repository
*,
200 const struct pathspec
*pathspec
,
201 unsigned refresh_flags
);
202 int repo_read_index_unmerged(struct repository
*);
204 * Opportunistically update the index but do not complain if we can't.
205 * The lockfile is always committed or rolled back.
207 void repo_update_index_if_able(struct repository
*, struct lock_file
*);
209 void prepare_repo_settings(struct repository
*r
);
212 * Return 1 if upgrade repository format to target_version succeeded,
213 * 0 if no upgrade is necessary, and -1 when upgrade is not possible.
215 int upgrade_repository_format(int target_version
);
217 #endif /* REPOSITORY_H */