7 struct fsmonitor_settings
;
12 struct raw_object_store
;
13 struct submodule_cache
;
14 struct promisor_remote_config
;
17 enum untracked_cache_setting
{
19 UNTRACKED_CACHE_REMOVE
,
20 UNTRACKED_CACHE_WRITE
,
23 enum fetch_negotiation_setting
{
24 FETCH_NEGOTIATION_CONSECUTIVE
,
25 FETCH_NEGOTIATION_SKIPPING
,
26 FETCH_NEGOTIATION_NOOP
,
29 struct repo_settings
{
32 int core_commit_graph
;
33 int commit_graph_generation_version
;
34 int commit_graph_read_changed_paths
;
35 int gc_write_commit_graph
;
37 int fetch_write_commit_graph
;
38 int command_requires_full_index
;
40 int pack_read_reverse_index
;
42 struct fsmonitor_settings
*fsmonitor
; /* lazily loaded */
46 enum untracked_cache_setting core_untracked_cache
;
49 enum fetch_negotiation_setting fetch_negotiation_algorithm
;
51 int core_multi_pack_index
;
54 struct repo_path_cache
{
60 char *merge_autostash
;
69 * Path to the git directory.
70 * Cannot be NULL after initialization.
75 * Path to the common git directory.
76 * Cannot be NULL after initialization.
81 * Holds any information related to accessing the raw object content.
83 struct raw_object_store
*objects
;
86 * All objects in this repository that have been parsed. This structure
87 * owns all objects it references, so users of "struct object *"
88 * generally do not need to free them; instead, when a repository is no
89 * longer used, call parsed_object_pool_clear() on this structure, which
90 * is called by the repositories repo_clear on its desconstruction.
92 struct parsed_object_pool
*parsed_objects
;
95 * The store in which the refs are held. This should generally only be
96 * accessed via get_main_ref_store(), as that will lazily initialize
99 struct ref_store
*refs_private
;
102 * Contains path to often used file names.
104 struct repo_path_cache cached_paths
;
107 * Path to the repository's graft file.
108 * Cannot be NULL after initialization.
113 * Path to the current worktree's index file.
114 * Cannot be NULL after initialization.
119 * Path to the working directory.
120 * A NULL value indicates that there is no working directory.
125 * Path from the root of the top-level superproject down to this
126 * repository. This is only non-NULL if the repository is initialized
127 * as a submodule of another repository.
129 char *submodule_prefix
;
131 struct repo_settings settings
;
135 * Repository's config which contains key-value pairs from the usual
136 * set of config files (i.e. repo specific .git/config, user wide
137 * ~/.gitconfig, XDG config file and the global /etc/gitconfig)
139 struct config_set
*config
;
141 /* Repository's submodule config as defined by '.gitmodules' */
142 struct submodule_cache
*submodule_cache
;
145 * Repository's in-memory index.
146 * 'repo_read_index()' can be used to populate 'index'.
148 struct index_state
*index
;
150 /* Repository's remotes and associated structures. */
151 struct remote_state
*remote_state
;
153 /* Repository's current hash algorithm, as serialized on disk. */
154 const struct git_hash_algo
*hash_algo
;
156 /* A unique-id for tracing purposes. */
159 /* True if commit-graph has been disabled within this process. */
160 int commit_graph_disabled
;
162 /* Configurations related to promisor remotes. */
163 char *repository_format_partial_clone
;
164 struct promisor_remote_config
*promisor_remote_config
;
168 /* Indicate if a repository has a different 'commondir' from 'gitdir' */
169 unsigned different_commondir
:1;
172 extern struct repository
*the_repository
;
175 * Define a custom repository layout. Any field can be NULL, which
176 * will default back to the path according to the default layout.
178 struct set_gitdir_args
{
179 const char *commondir
;
180 const char *object_dir
;
181 const char *graft_file
;
182 const char *index_file
;
183 const char *alternate_db
;
184 int disable_ref_updates
;
187 void repo_set_gitdir(struct repository
*repo
, const char *root
,
188 const struct set_gitdir_args
*extra_args
);
189 void repo_set_worktree(struct repository
*repo
, const char *path
);
190 void repo_set_hash_algo(struct repository
*repo
, int algo
);
191 void initialize_the_repository(void);
193 int repo_init(struct repository
*r
, const char *gitdir
, const char *worktree
);
196 * Initialize the repository 'subrepo' as the submodule at the given path. If
197 * the submodule's gitdir cannot be found at <path>/.git, this function calls
198 * submodule_from_path() to try to find it. treeish_name is only used if
199 * submodule_from_path() needs to be called; see its documentation for more
201 * Return 0 upon success and a non-zero value upon failure.
205 int repo_submodule_init(struct repository
*subrepo
,
206 struct repository
*superproject
,
208 const struct object_id
*treeish_name
);
209 void repo_clear(struct repository
*repo
);
212 * Populates the repository's index from its index_file, an index struct will
213 * be allocated if needed.
215 * Return the number of index entries in the populated index or a value less
216 * than zero if an error occurred. If the repository's index has already been
217 * populated then the number of entries will simply be returned.
219 int repo_read_index(struct repository
*repo
);
220 int repo_hold_locked_index(struct repository
*repo
,
221 struct lock_file
*lf
,
224 int repo_read_index_preload(struct repository
*,
225 const struct pathspec
*pathspec
,
226 unsigned refresh_flags
);
227 int repo_read_index_unmerged(struct repository
*);
229 * Opportunistically update the index but do not complain if we can't.
230 * The lockfile is always committed or rolled back.
232 void repo_update_index_if_able(struct repository
*, struct lock_file
*);
234 void prepare_repo_settings(struct repository
*r
);
237 * Return 1 if upgrade repository format to target_version succeeded,
238 * 0 if no upgrade is necessary, and -1 when upgrade is not possible.
240 int upgrade_repository_format(int target_version
);
242 #endif /* REPOSITORY_H */