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