11 struct raw_object_store
;
12 struct submodule_cache
;
14 enum untracked_cache_setting
{
15 UNTRACKED_CACHE_UNSET
= -1,
16 UNTRACKED_CACHE_REMOVE
= 0,
17 UNTRACKED_CACHE_KEEP
= 1,
18 UNTRACKED_CACHE_WRITE
= 2
21 enum fetch_negotiation_setting
{
22 FETCH_NEGOTIATION_UNSET
= -1,
23 FETCH_NEGOTIATION_NONE
= 0,
24 FETCH_NEGOTIATION_DEFAULT
= 1,
25 FETCH_NEGOTIATION_SKIPPING
= 2,
28 struct repo_settings
{
31 int core_commit_graph
;
32 int gc_write_commit_graph
;
33 int fetch_write_commit_graph
;
36 enum untracked_cache_setting core_untracked_cache
;
39 enum fetch_negotiation_setting fetch_negotiation_algorithm
;
45 * Path to the git directory.
46 * Cannot be NULL after initialization.
51 * Path to the common git directory.
52 * Cannot be NULL after initialization.
57 * Holds any information related to accessing the raw object content.
59 struct raw_object_store
*objects
;
62 * All objects in this repository that have been parsed. This structure
63 * owns all objects it references, so users of "struct object *"
64 * generally do not need to free them; instead, when a repository is no
65 * longer used, call parsed_object_pool_clear() on this structure, which
66 * is called by the repositories repo_clear on its desconstruction.
68 struct parsed_object_pool
*parsed_objects
;
70 /* The store in which the refs are held. */
71 struct ref_store
*refs
;
74 * Contains path to often used file names.
76 struct path_cache cached_paths
;
79 * Path to the repository's graft file.
80 * Cannot be NULL after initialization.
85 * Path to the current worktree's index file.
86 * Cannot be NULL after initialization.
91 * Path to the working directory.
92 * A NULL value indicates that there is no working directory.
97 * Path from the root of the top-level superproject down to this
98 * repository. This is only non-NULL if the repository is initialized
99 * as a submodule of another repository.
101 char *submodule_prefix
;
103 struct repo_settings settings
;
107 * Repository's config which contains key-value pairs from the usual
108 * set of config files (i.e. repo specific .git/config, user wide
109 * ~/.gitconfig, XDG config file and the global /etc/gitconfig)
111 struct config_set
*config
;
113 /* Repository's submodule config as defined by '.gitmodules' */
114 struct submodule_cache
*submodule_cache
;
117 * Repository's in-memory index.
118 * 'repo_read_index()' can be used to populate 'index'.
120 struct index_state
*index
;
122 /* Repository's current hash algorithm, as serialized on disk. */
123 const struct git_hash_algo
*hash_algo
;
125 /* A unique-id for tracing purposes. */
128 /* True if commit-graph has been disabled within this process. */
129 int commit_graph_disabled
;
133 /* Indicate if a repository has a different 'commondir' from 'gitdir' */
134 unsigned different_commondir
:1;
137 extern struct repository
*the_repository
;
140 * Define a custom repository layout. Any field can be NULL, which
141 * will default back to the path according to the default layout.
143 struct set_gitdir_args
{
144 const char *commondir
;
145 const char *object_dir
;
146 const char *graft_file
;
147 const char *index_file
;
148 const char *alternate_db
;
151 void repo_set_gitdir(struct repository
*repo
, const char *root
,
152 const struct set_gitdir_args
*extra_args
);
153 void repo_set_worktree(struct repository
*repo
, const char *path
);
154 void repo_set_hash_algo(struct repository
*repo
, int algo
);
155 void initialize_the_repository(void);
156 int repo_init(struct repository
*r
, const char *gitdir
, const char *worktree
);
159 * Initialize the repository 'subrepo' as the submodule given by the
160 * struct submodule 'sub' in parent repository 'superproject'.
161 * Return 0 upon success and a non-zero value upon failure, which may happen
162 * if the submodule is not found, or 'sub' is NULL.
165 int repo_submodule_init(struct repository
*subrepo
,
166 struct repository
*superproject
,
167 const struct submodule
*sub
);
168 void repo_clear(struct repository
*repo
);
171 * Populates the repository's index from its index_file, an index struct will
172 * be allocated if needed.
174 * Return the number of index entries in the populated index or a value less
175 * than zero if an error occured. If the repository's index has already been
176 * populated then the number of entries will simply be returned.
178 int repo_read_index(struct repository
*repo
);
179 int repo_hold_locked_index(struct repository
*repo
,
180 struct lock_file
*lf
,
183 int repo_read_index_preload(struct repository
*,
184 const struct pathspec
*pathspec
,
185 unsigned refresh_flags
);
186 int repo_read_index_unmerged(struct repository
*);
188 * Opportunistically update the index but do not complain if we can't.
189 * The lockfile is always committed or rolled back.
191 void repo_update_index_if_able(struct repository
*, struct lock_file
*);
193 void prepare_repo_settings(struct repository
*r
);
195 #endif /* REPOSITORY_H */