🌐 AI搜索 & 代理 主页
Google Git
Sign in
chromium / external / github.com / git / git / refs/tags/v2.29.3 / . / repository.h
blob: bacf843d460d2ff8a28511288055dc12dfbb53c6 [file] [log] [blame]
Brandon Williams359efef2017-06-22 18:43:32[diff] [blame]1#ifndef REPOSITORY_H
2#define REPOSITORY_H
3
Elijah Newrenef3ca952018-08-15 17:54:05[diff] [blame]4#include "path.h"
5
Brandon Williams3b256222017-06-22 18:43:42[diff] [blame]6struct config_set;
brian m. carlson78a67662017-11-12 21:28:53[diff] [blame]7struct git_hash_algo;
Stefan Beller90c62152018-03-23 17:20:55[diff] [blame]8struct index_state;
Nguyễn Thái Ngọc Duy3a95f312019-01-12 02:13:24[diff] [blame]9struct lock_file;
Nguyễn Thái Ngọc Duye1ff0a32019-01-12 02:13:26[diff] [blame]10struct pathspec;
Stefan Beller90c62152018-03-23 17:20:55[diff] [blame]11struct raw_object_store;
12struct submodule_cache;
Brandon Williams3b256222017-06-22 18:43:42[diff] [blame]13
Derrick Stoleead0fb652019-08-13 18:37:46[diff] [blame]14enum untracked_cache_setting {
15 UNTRACKED_CACHE_UNSET = -1,
16 UNTRACKED_CACHE_REMOVE = 0,
17 UNTRACKED_CACHE_KEEP = 1,
18 UNTRACKED_CACHE_WRITE = 2
19};
20
Derrick Stoleeaaf633c2019-08-13 18:37:48[diff] [blame]21enum fetch_negotiation_setting {
22 FETCH_NEGOTIATION_UNSET = -1,
23 FETCH_NEGOTIATION_NONE = 0,
24 FETCH_NEGOTIATION_DEFAULT = 1,
25 FETCH_NEGOTIATION_SKIPPING = 2,
Jonathan Tancbe566a2020-08-18 04:01:31[diff] [blame]26 FETCH_NEGOTIATION_NOOP = 3,
Derrick Stoleeaaf633c2019-08-13 18:37:48[diff] [blame]27};
28
Derrick Stolee7211b9e2019-08-13 18:37:43[diff] [blame]29struct repo_settings {
30 int initialized;
31
32 int core_commit_graph;
Taylor Blaub66d8472020-09-09 15:23:10[diff] [blame]33 int commit_graph_read_changed_paths;
Derrick Stolee7211b9e2019-08-13 18:37:43[diff] [blame]34 int gc_write_commit_graph;
Derrick Stolee50f26bd2019-09-03 02:22:02[diff] [blame]35 int fetch_write_commit_graph;
Derrick Stolee7211b9e2019-08-13 18:37:43[diff] [blame]36
37 int index_version;
Derrick Stoleead0fb652019-08-13 18:37:46[diff] [blame]38 enum untracked_cache_setting core_untracked_cache;
Derrick Stolee7211b9e2019-08-13 18:37:43[diff] [blame]39
40 int pack_use_sparse;
Derrick Stoleeaaf633c2019-08-13 18:37:48[diff] [blame]41 enum fetch_negotiation_setting fetch_negotiation_algorithm;
Derrick Stolee7211b9e2019-08-13 18:37:43[diff] [blame]42};
43
Brandon Williams359efef2017-06-22 18:43:32[diff] [blame]44struct repository {
45 /* Environment */
46 /*
47 * Path to the git directory.
48 * Cannot be NULL after initialization.
49 */
50 char *gitdir;
51
52 /*
53 * Path to the common git directory.
54 * Cannot be NULL after initialization.
55 */
56 char *commondir;
57
58 /*
Stefan Beller90c62152018-03-23 17:20:55[diff] [blame]59 * Holds any information related to accessing the raw object content.
Brandon Williams359efef2017-06-22 18:43:32[diff] [blame]60 */
Stefan Beller90c62152018-03-23 17:20:55[diff] [blame]61 struct raw_object_store *objects;
Nguyễn Thái Ngọc Duy7bc0dca2018-03-03 11:35:57[diff] [blame]62
Stefan Beller99bf1152018-05-08 19:37:24[diff] [blame]63 /*
64 * All objects in this repository that have been parsed. This structure
65 * owns all objects it references, so users of "struct object *"
66 * generally do not need to free them; instead, when a repository is no
67 * longer used, call parsed_object_pool_clear() on this structure, which
68 * is called by the repositories repo_clear on its desconstruction.
69 */
70 struct parsed_object_pool *parsed_objects;
71
Jeff King02204612020-04-10 03:04:11[diff] [blame]72 /*
73 * The store in which the refs are held. This should generally only be
74 * accessed via get_main_ref_store(), as that will lazily initialize
75 * the ref object.
76 */
77 struct ref_store *refs_private;
Stefan Beller64a74162018-04-12 00:21:14[diff] [blame]78
Brandon Williams359efef2017-06-22 18:43:32[diff] [blame]79 /*
Stefan Beller102de882018-05-17 22:51:51[diff] [blame]80 * Contains path to often used file names.
81 */
82 struct path_cache cached_paths;
83
84 /*
Brandon Williams359efef2017-06-22 18:43:32[diff] [blame]85 * Path to the repository's graft file.
86 * Cannot be NULL after initialization.
87 */
88 char *graft_file;
89
90 /*
91 * Path to the current worktree's index file.
92 * Cannot be NULL after initialization.
93 */
94 char *index_file;
95
96 /*
97 * Path to the working directory.
98 * A NULL value indicates that there is no working directory.
99 */
100 char *worktree;
101
Brandon Williams96dc8832017-06-22 18:43:47[diff] [blame]102 /*
103 * Path from the root of the top-level superproject down to this
104 * repository. This is only non-NULL if the repository is initialized
105 * as a submodule of another repository.
106 */
107 char *submodule_prefix;
108
Derrick Stolee7211b9e2019-08-13 18:37:43[diff] [blame]109 struct repo_settings settings;
110
Brandon Williams3b256222017-06-22 18:43:42[diff] [blame]111 /* Subsystems */
112 /*
113 * Repository's config which contains key-value pairs from the usual
114 * set of config files (i.e. repo specific .git/config, user wide
115 * ~/.gitconfig, XDG config file and the global /etc/gitconfig)
116 */
117 struct config_set *config;
118
Brandon Williamsbf12fcd2017-06-22 18:43:44[diff] [blame]119 /* Repository's submodule config as defined by '.gitmodules' */
120 struct submodule_cache *submodule_cache;
121
Brandon Williams639e30b2017-06-22 18:43:43[diff] [blame]122 /*
123 * Repository's in-memory index.
124 * 'repo_read_index()' can be used to populate 'index'.
125 */
126 struct index_state *index;
127
brian m. carlson78a67662017-11-12 21:28:53[diff] [blame]128 /* Repository's current hash algorithm, as serialized on disk. */
129 const struct git_hash_algo *hash_algo;
130
Jeff Hostetleree4512e2019-02-22 22:25:01[diff] [blame]131 /* A unique-id for tracing purposes. */
132 int trace2_repo_id;
133
Jeff King6abada12019-09-12 14:44:45[diff] [blame]134 /* True if commit-graph has been disabled within this process. */
135 int commit_graph_disabled;
136
Brandon Williams359efef2017-06-22 18:43:32[diff] [blame]137 /* Configurations */
Brandon Williams359efef2017-06-22 18:43:32[diff] [blame]138
139 /* Indicate if a repository has a different 'commondir' from 'gitdir' */
140 unsigned different_commondir:1;
141};
142
143extern struct repository *the_repository;
144
Nguyễn Thái Ngọc Duy00a3da22018-03-23 15:55:23[diff] [blame]145/*
146 * Define a custom repository layout. Any field can be NULL, which
147 * will default back to the path according to the default layout.
148 */
Nguyễn Thái Ngọc Duy357a03e2018-03-03 11:35:55[diff] [blame]149struct set_gitdir_args {
150 const char *commondir;
151 const char *object_dir;
152 const char *graft_file;
153 const char *index_file;
Nguyễn Thái Ngọc Duy7bc0dca2018-03-03 11:35:57[diff] [blame]154 const char *alternate_db;
Nguyễn Thái Ngọc Duy357a03e2018-03-03 11:35:55[diff] [blame]155};
156
Nguyễn Thái Ngọc Duyc2ec4172018-06-30 09:20:29[diff] [blame]157void repo_set_gitdir(struct repository *repo, const char *root,
158 const struct set_gitdir_args *extra_args);
159void repo_set_worktree(struct repository *repo, const char *path);
160void repo_set_hash_algo(struct repository *repo, int algo);
161void initialize_the_repository(void);
162int repo_init(struct repository *r, const char *gitdir, const char *worktree);
Stefan Bellerd5498e02018-11-29 00:27:53[diff] [blame]163
164/*
165 * Initialize the repository 'subrepo' as the submodule given by the
166 * struct submodule 'sub' in parent repository 'superproject'.
167 * Return 0 upon success and a non-zero value upon failure, which may happen
168 * if the submodule is not found, or 'sub' is NULL.
169 */
170struct submodule;
171int repo_submodule_init(struct repository *subrepo,
Nguyễn Thái Ngọc Duyc2ec4172018-06-30 09:20:29[diff] [blame]172 struct repository *superproject,
Stefan Bellerd5498e02018-11-29 00:27:53[diff] [blame]173 const struct submodule *sub);
Nguyễn Thái Ngọc Duyc2ec4172018-06-30 09:20:29[diff] [blame]174void repo_clear(struct repository *repo);
Brandon Williams359efef2017-06-22 18:43:32[diff] [blame]175
Brandon Williams3f138772017-07-18 19:05:18[diff] [blame]176/*
177 * Populates the repository's index from its index_file, an index struct will
178 * be allocated if needed.
179 *
180 * Return the number of index entries in the populated index or a value less
Elijah Newren15beaaa2019-11-05 17:07:23[diff] [blame]181 * than zero if an error occurred. If the repository's index has already been
Brandon Williams3f138772017-07-18 19:05:18[diff] [blame]182 * populated then the number of entries will simply be returned.
183 */
Nguyễn Thái Ngọc Duyc2ec4172018-06-30 09:20:29[diff] [blame]184int repo_read_index(struct repository *repo);
Nguyễn Thái Ngọc Duy3a95f312019-01-12 02:13:24[diff] [blame]185int repo_hold_locked_index(struct repository *repo,
186 struct lock_file *lf,
187 int flags);
Brandon Williams639e30b2017-06-22 18:43:43[diff] [blame]188
Nguyễn Thái Ngọc Duye1ff0a32019-01-12 02:13:26[diff] [blame]189int repo_read_index_preload(struct repository *,
190 const struct pathspec *pathspec,
191 unsigned refresh_flags);
192int repo_read_index_unmerged(struct repository *);
Nguyễn Thái Ngọc Duy1b0d9682019-01-12 02:13:27[diff] [blame]193/*
194 * Opportunistically update the index but do not complain if we can't.
195 * The lockfile is always committed or rolled back.
196 */
197void repo_update_index_if_able(struct repository *, struct lock_file *);
198
Derrick Stolee7211b9e2019-08-13 18:37:43[diff] [blame]199void prepare_repo_settings(struct repository *r);
Brandon Williams639e30b2017-06-22 18:43:43[diff] [blame]200
Xin Li16af5f12020-06-05 09:10:01[diff] [blame]201/*
202 * Return 1 if upgrade repository format to target_version succeeded,
203 * 0 if no upgrade is necessary, and -1 when upgrade is not possible.
204 */
205int upgrade_repository_format(int target_version);
206
Brandon Williams359efef2017-06-22 18:43:32[diff] [blame]207#endif /* REPOSITORY_H */