]>
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; |
50f26bd0 | 36 | int fetch_write_commit_graph; |
c21919f1 ÆAB |
37 | int command_requires_full_index; |
38 | int sparse_index; | |
dbcf6116 | 39 | int pack_read_reverse_index; |
b0afdce5 | 40 | int pack_use_bitmap_boundary_traversal; |
7211b9e7 | 41 | |
1e0ea5c4 JH |
42 | struct fsmonitor_settings *fsmonitor; /* lazily loaded */ |
43 | ||
7211b9e7 | 44 | int index_version; |
17194b19 | 45 | int index_skip_hash; |
ad0fb659 | 46 | enum untracked_cache_setting core_untracked_cache; |
7211b9e7 DS |
47 | |
48 | int pack_use_sparse; | |
aaf633c2 | 49 | enum fetch_negotiation_setting fetch_negotiation_algorithm; |
18e449f8 DS |
50 | |
51 | int core_multi_pack_index; | |
7211b9e7 DS |
52 | }; |
53 | ||
759f3407 ÆAB |
54 | struct repo_path_cache { |
55 | char *squash_msg; | |
56 | char *merge_msg; | |
57 | char *merge_rr; | |
58 | char *merge_mode; | |
59 | char *merge_head; | |
60 | char *merge_autostash; | |
61 | char *auto_merge; | |
62 | char *fetch_head; | |
63 | char *shallow; | |
64 | }; | |
65 | ||
359efeff BW |
66 | struct repository { |
67 | /* Environment */ | |
68 | /* | |
69 | * Path to the git directory. | |
70 | * Cannot be NULL after initialization. | |
71 | */ | |
72 | char *gitdir; | |
73 | ||
74 | /* | |
75 | * Path to the common git directory. | |
76 | * Cannot be NULL after initialization. | |
77 | */ | |
78 | char *commondir; | |
79 | ||
80 | /* | |
90c62155 | 81 | * Holds any information related to accessing the raw object content. |
359efeff | 82 | */ |
90c62155 | 83 | struct raw_object_store *objects; |
7bc0dcaa | 84 | |
99bf115c SB |
85 | /* |
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. | |
91 | */ | |
92 | struct parsed_object_pool *parsed_objects; | |
93 | ||
02204610 JK |
94 | /* |
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 | |
97 | * the ref object. | |
98 | */ | |
99 | struct ref_store *refs_private; | |
64a74161 | 100 | |
102de880 SB |
101 | /* |
102 | * Contains path to often used file names. | |
103 | */ | |
759f3407 | 104 | struct repo_path_cache cached_paths; |
102de880 | 105 | |
359efeff BW |
106 | /* |
107 | * Path to the repository's graft file. | |
108 | * Cannot be NULL after initialization. | |
109 | */ | |
110 | char *graft_file; | |
111 | ||
112 | /* | |
113 | * Path to the current worktree's index file. | |
114 | * Cannot be NULL after initialization. | |
115 | */ | |
116 | char *index_file; | |
117 | ||
118 | /* | |
119 | * Path to the working directory. | |
120 | * A NULL value indicates that there is no working directory. | |
121 | */ | |
122 | char *worktree; | |
123 | ||
96dc883b BW |
124 | /* |
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. | |
128 | */ | |
129 | char *submodule_prefix; | |
130 | ||
7211b9e7 DS |
131 | struct repo_settings settings; |
132 | ||
3b256228 BW |
133 | /* Subsystems */ |
134 | /* | |
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) | |
138 | */ | |
139 | struct config_set *config; | |
140 | ||
bf12fcdf BW |
141 | /* Repository's submodule config as defined by '.gitmodules' */ |
142 | struct submodule_cache *submodule_cache; | |
143 | ||
639e30b5 BW |
144 | /* |
145 | * Repository's in-memory index. | |
146 | * 'repo_read_index()' can be used to populate 'index'. | |
147 | */ | |
148 | struct index_state *index; | |
149 | ||
fd3cb050 GC |
150 | /* Repository's remotes and associated structures. */ |
151 | struct remote_state *remote_state; | |
152 | ||
78a67668 | 153 | /* Repository's current hash algorithm, as serialized on disk. */ |
154 | const struct git_hash_algo *hash_algo; | |
155 | ||
ee4512ed JH |
156 | /* A unique-id for tracing purposes. */ |
157 | int trace2_repo_id; | |
158 | ||
6abada18 JK |
159 | /* True if commit-graph has been disabled within this process. */ |
160 | int commit_graph_disabled; | |
161 | ||
ebaf3bcf JT |
162 | /* Configurations related to promisor remotes. */ |
163 | char *repository_format_partial_clone; | |
ef7dc2e9 | 164 | struct promisor_remote_config *promisor_remote_config; |
ebaf3bcf | 165 | |
359efeff | 166 | /* Configurations */ |
359efeff BW |
167 | |
168 | /* Indicate if a repository has a different 'commondir' from 'gitdir' */ | |
169 | unsigned different_commondir:1; | |
170 | }; | |
171 | ||
172 | extern struct repository *the_repository; | |
173 | ||
00a3da2a NTND |
174 | /* |
175 | * Define a custom repository layout. Any field can be NULL, which | |
176 | * will default back to the path according to the default layout. | |
177 | */ | |
357a03eb NTND |
178 | struct set_gitdir_args { |
179 | const char *commondir; | |
180 | const char *object_dir; | |
181 | const char *graft_file; | |
182 | const char *index_file; | |
7bc0dcaa | 183 | const char *alternate_db; |
ecd81dfc | 184 | int disable_ref_updates; |
357a03eb NTND |
185 | }; |
186 | ||
c2ec4175 NTND |
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); | |
1e8697b5 | 192 | RESULT_MUST_BE_USED |
c2ec4175 | 193 | int repo_init(struct repository *r, const char *gitdir, const char *worktree); |
d5498e08 SB |
194 | |
195 | /* | |
8eb8dcf9 JT |
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 | |
200 | * information. | |
201 | * Return 0 upon success and a non-zero value upon failure. | |
d5498e08 | 202 | */ |
8eb8dcf9 | 203 | struct object_id; |
1e8697b5 | 204 | RESULT_MUST_BE_USED |
d5498e08 | 205 | int repo_submodule_init(struct repository *subrepo, |
c2ec4175 | 206 | struct repository *superproject, |
8eb8dcf9 JT |
207 | const char *path, |
208 | const struct object_id *treeish_name); | |
c2ec4175 | 209 | void repo_clear(struct repository *repo); |
359efeff | 210 | |
3f138775 BW |
211 | /* |
212 | * Populates the repository's index from its index_file, an index struct will | |
213 | * be allocated if needed. | |
214 | * | |
215 | * Return the number of index entries in the populated index or a value less | |
15beaaa3 | 216 | * than zero if an error occurred. If the repository's index has already been |
3f138775 BW |
217 | * populated then the number of entries will simply be returned. |
218 | */ | |
c2ec4175 | 219 | int repo_read_index(struct repository *repo); |
3a95f31d NTND |
220 | int repo_hold_locked_index(struct repository *repo, |
221 | struct lock_file *lf, | |
222 | int flags); | |
639e30b5 | 223 | |
e1ff0a32 NTND |
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 *); | |
1b0d968b NTND |
228 | /* |
229 | * Opportunistically update the index but do not complain if we can't. | |
230 | * The lockfile is always committed or rolled back. | |
231 | */ | |
232 | void repo_update_index_if_able(struct repository *, struct lock_file *); | |
233 | ||
7211b9e7 | 234 | void prepare_repo_settings(struct repository *r); |
639e30b5 | 235 | |
16af5f1a XL |
236 | /* |
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. | |
239 | */ | |
240 | int upgrade_repository_format(int target_version); | |
241 | ||
359efeff | 242 | #endif /* REPOSITORY_H */ |