]>
Commit | Line | Data |
---|---|---|
359efeff BW |
1 | #ifndef REPOSITORY_H |
2 | #define REPOSITORY_H | |
3 | ||
3b256228 | 4 | struct config_set; |
1e0ea5c4 | 5 | struct fsmonitor_settings; |
90c62155 | 6 | struct git_hash_algo; |
639e30b5 | 7 | struct index_state; |
3a95f31d | 8 | struct lock_file; |
e1ff0a32 | 9 | struct pathspec; |
90c62155 | 10 | struct raw_object_store; |
bf12fcdf | 11 | struct submodule_cache; |
ef7dc2e9 | 12 | struct promisor_remote_config; |
fd3cb050 | 13 | struct remote_state; |
3b256228 | 14 | |
ad0fb659 | 15 | enum untracked_cache_setting { |
3050b6df ÆAB |
16 | UNTRACKED_CACHE_KEEP, |
17 | UNTRACKED_CACHE_REMOVE, | |
18 | UNTRACKED_CACHE_WRITE, | |
ad0fb659 DS |
19 | }; |
20 | ||
aaf633c2 | 21 | enum fetch_negotiation_setting { |
714edc62 | 22 | FETCH_NEGOTIATION_CONSECUTIVE, |
3050b6df ÆAB |
23 | FETCH_NEGOTIATION_SKIPPING, |
24 | FETCH_NEGOTIATION_NOOP, | |
aaf633c2 DS |
25 | }; |
26 | ||
0fcc285c PS |
27 | #define REF_STORAGE_FORMAT_UNKNOWN 0 |
28 | #define REF_STORAGE_FORMAT_FILES 1 | |
29 | ||
7211b9e7 DS |
30 | struct repo_settings { |
31 | int initialized; | |
32 | ||
33 | int core_commit_graph; | |
a92d8523 | 34 | int commit_graph_generation_version; |
b66d8475 | 35 | int commit_graph_read_changed_paths; |
7211b9e7 | 36 | int gc_write_commit_graph; |
50f26bd0 | 37 | int fetch_write_commit_graph; |
c21919f1 ÆAB |
38 | int command_requires_full_index; |
39 | int sparse_index; | |
dbcf6116 | 40 | int pack_read_reverse_index; |
b0afdce5 | 41 | int pack_use_bitmap_boundary_traversal; |
7211b9e7 | 42 | |
9c7d1b05 DS |
43 | /* |
44 | * Does this repository have core.useReplaceRefs=true (on by | |
45 | * default)? This provides a repository-scoped version of this | |
46 | * config, though it could be disabled process-wide via some Git | |
47 | * builtins or the --no-replace-objects option. See | |
48 | * replace_refs_enabled() for more details. | |
49 | */ | |
50 | int read_replace_refs; | |
51 | ||
1e0ea5c4 JH |
52 | struct fsmonitor_settings *fsmonitor; /* lazily loaded */ |
53 | ||
7211b9e7 | 54 | int index_version; |
17194b19 | 55 | int index_skip_hash; |
ad0fb659 | 56 | enum untracked_cache_setting core_untracked_cache; |
7211b9e7 DS |
57 | |
58 | int pack_use_sparse; | |
aaf633c2 | 59 | enum fetch_negotiation_setting fetch_negotiation_algorithm; |
18e449f8 DS |
60 | |
61 | int core_multi_pack_index; | |
7211b9e7 DS |
62 | }; |
63 | ||
759f3407 ÆAB |
64 | struct repo_path_cache { |
65 | char *squash_msg; | |
66 | char *merge_msg; | |
67 | char *merge_rr; | |
68 | char *merge_mode; | |
69 | char *merge_head; | |
759f3407 ÆAB |
70 | char *fetch_head; |
71 | char *shallow; | |
72 | }; | |
73 | ||
359efeff BW |
74 | struct repository { |
75 | /* Environment */ | |
76 | /* | |
77 | * Path to the git directory. | |
78 | * Cannot be NULL after initialization. | |
79 | */ | |
80 | char *gitdir; | |
81 | ||
82 | /* | |
83 | * Path to the common git directory. | |
84 | * Cannot be NULL after initialization. | |
85 | */ | |
86 | char *commondir; | |
87 | ||
88 | /* | |
90c62155 | 89 | * Holds any information related to accessing the raw object content. |
359efeff | 90 | */ |
90c62155 | 91 | struct raw_object_store *objects; |
7bc0dcaa | 92 | |
99bf115c SB |
93 | /* |
94 | * All objects in this repository that have been parsed. This structure | |
95 | * owns all objects it references, so users of "struct object *" | |
96 | * generally do not need to free them; instead, when a repository is no | |
97 | * longer used, call parsed_object_pool_clear() on this structure, which | |
98 | * is called by the repositories repo_clear on its desconstruction. | |
99 | */ | |
100 | struct parsed_object_pool *parsed_objects; | |
101 | ||
02204610 JK |
102 | /* |
103 | * The store in which the refs are held. This should generally only be | |
104 | * accessed via get_main_ref_store(), as that will lazily initialize | |
105 | * the ref object. | |
106 | */ | |
107 | struct ref_store *refs_private; | |
64a74161 | 108 | |
102de880 SB |
109 | /* |
110 | * Contains path to often used file names. | |
111 | */ | |
759f3407 | 112 | struct repo_path_cache cached_paths; |
102de880 | 113 | |
359efeff BW |
114 | /* |
115 | * Path to the repository's graft file. | |
116 | * Cannot be NULL after initialization. | |
117 | */ | |
118 | char *graft_file; | |
119 | ||
120 | /* | |
121 | * Path to the current worktree's index file. | |
122 | * Cannot be NULL after initialization. | |
123 | */ | |
124 | char *index_file; | |
125 | ||
126 | /* | |
127 | * Path to the working directory. | |
128 | * A NULL value indicates that there is no working directory. | |
129 | */ | |
130 | char *worktree; | |
131 | ||
96dc883b BW |
132 | /* |
133 | * Path from the root of the top-level superproject down to this | |
134 | * repository. This is only non-NULL if the repository is initialized | |
135 | * as a submodule of another repository. | |
136 | */ | |
137 | char *submodule_prefix; | |
138 | ||
7211b9e7 DS |
139 | struct repo_settings settings; |
140 | ||
3b256228 BW |
141 | /* Subsystems */ |
142 | /* | |
143 | * Repository's config which contains key-value pairs from the usual | |
144 | * set of config files (i.e. repo specific .git/config, user wide | |
145 | * ~/.gitconfig, XDG config file and the global /etc/gitconfig) | |
146 | */ | |
147 | struct config_set *config; | |
148 | ||
bf12fcdf BW |
149 | /* Repository's submodule config as defined by '.gitmodules' */ |
150 | struct submodule_cache *submodule_cache; | |
151 | ||
639e30b5 BW |
152 | /* |
153 | * Repository's in-memory index. | |
154 | * 'repo_read_index()' can be used to populate 'index'. | |
155 | */ | |
156 | struct index_state *index; | |
157 | ||
fd3cb050 GC |
158 | /* Repository's remotes and associated structures. */ |
159 | struct remote_state *remote_state; | |
160 | ||
78a67668 | 161 | /* Repository's current hash algorithm, as serialized on disk. */ |
162 | const struct git_hash_algo *hash_algo; | |
163 | ||
173761e2 PS |
164 | /* Repository's reference storage format, as serialized on disk. */ |
165 | unsigned int ref_storage_format; | |
166 | ||
ee4512ed JH |
167 | /* A unique-id for tracing purposes. */ |
168 | int trace2_repo_id; | |
169 | ||
6abada18 JK |
170 | /* True if commit-graph has been disabled within this process. */ |
171 | int commit_graph_disabled; | |
172 | ||
ebaf3bcf JT |
173 | /* Configurations related to promisor remotes. */ |
174 | char *repository_format_partial_clone; | |
ef7dc2e9 | 175 | struct promisor_remote_config *promisor_remote_config; |
ebaf3bcf | 176 | |
359efeff | 177 | /* Configurations */ |
3867f6d6 | 178 | int repository_format_worktree_config; |
359efeff BW |
179 | |
180 | /* Indicate if a repository has a different 'commondir' from 'gitdir' */ | |
181 | unsigned different_commondir:1; | |
182 | }; | |
183 | ||
184 | extern struct repository *the_repository; | |
bc47f16d EN |
185 | #ifdef USE_THE_INDEX_VARIABLE |
186 | extern struct index_state the_index; | |
187 | #endif | |
359efeff | 188 | |
00a3da2a NTND |
189 | /* |
190 | * Define a custom repository layout. Any field can be NULL, which | |
191 | * will default back to the path according to the default layout. | |
192 | */ | |
357a03eb NTND |
193 | struct set_gitdir_args { |
194 | const char *commondir; | |
195 | const char *object_dir; | |
196 | const char *graft_file; | |
197 | const char *index_file; | |
7bc0dcaa | 198 | const char *alternate_db; |
ecd81dfc | 199 | int disable_ref_updates; |
357a03eb NTND |
200 | }; |
201 | ||
c2ec4175 NTND |
202 | void repo_set_gitdir(struct repository *repo, const char *root, |
203 | const struct set_gitdir_args *extra_args); | |
204 | void repo_set_worktree(struct repository *repo, const char *path); | |
205 | void repo_set_hash_algo(struct repository *repo, int algo); | |
173761e2 | 206 | void repo_set_ref_storage_format(struct repository *repo, unsigned int format); |
c2ec4175 | 207 | void initialize_the_repository(void); |
1e8697b5 | 208 | RESULT_MUST_BE_USED |
c2ec4175 | 209 | int repo_init(struct repository *r, const char *gitdir, const char *worktree); |
d5498e08 SB |
210 | |
211 | /* | |
8eb8dcf9 JT |
212 | * Initialize the repository 'subrepo' as the submodule at the given path. If |
213 | * the submodule's gitdir cannot be found at <path>/.git, this function calls | |
214 | * submodule_from_path() to try to find it. treeish_name is only used if | |
215 | * submodule_from_path() needs to be called; see its documentation for more | |
216 | * information. | |
217 | * Return 0 upon success and a non-zero value upon failure. | |
d5498e08 | 218 | */ |
8eb8dcf9 | 219 | struct object_id; |
1e8697b5 | 220 | RESULT_MUST_BE_USED |
d5498e08 | 221 | int repo_submodule_init(struct repository *subrepo, |
c2ec4175 | 222 | struct repository *superproject, |
8eb8dcf9 JT |
223 | const char *path, |
224 | const struct object_id *treeish_name); | |
c2ec4175 | 225 | void repo_clear(struct repository *repo); |
359efeff | 226 | |
3f138775 BW |
227 | /* |
228 | * Populates the repository's index from its index_file, an index struct will | |
229 | * be allocated if needed. | |
230 | * | |
231 | * Return the number of index entries in the populated index or a value less | |
15beaaa3 | 232 | * than zero if an error occurred. If the repository's index has already been |
3f138775 BW |
233 | * populated then the number of entries will simply be returned. |
234 | */ | |
c2ec4175 | 235 | int repo_read_index(struct repository *repo); |
3a95f31d NTND |
236 | int repo_hold_locked_index(struct repository *repo, |
237 | struct lock_file *lf, | |
238 | int flags); | |
639e30b5 | 239 | |
e1ff0a32 | 240 | int repo_read_index_unmerged(struct repository *); |
1b0d968b NTND |
241 | /* |
242 | * Opportunistically update the index but do not complain if we can't. | |
243 | * The lockfile is always committed or rolled back. | |
244 | */ | |
245 | void repo_update_index_if_able(struct repository *, struct lock_file *); | |
246 | ||
7211b9e7 | 247 | void prepare_repo_settings(struct repository *r); |
639e30b5 | 248 | |
16af5f1a XL |
249 | /* |
250 | * Return 1 if upgrade repository format to target_version succeeded, | |
251 | * 0 if no upgrade is necessary, and -1 when upgrade is not possible. | |
252 | */ | |
253 | int upgrade_repository_format(int target_version); | |
254 | ||
359efeff | 255 | #endif /* REPOSITORY_H */ |