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