freshlybakedca.ke
Git fork
1#ifndef SUBMODULE_H
2#define SUBMODULE_H
3
4struct strvec;
5struct cache_entry;
6struct diff_options;
7struct index_state;
8struct object_id;
9struct oid_array;
10struct pathspec;
11struct remote;
12struct repository;
13struct string_list;
14struct strbuf;
15
16enum submodule_recurse_mode {
17 RECURSE_SUBMODULES_ONLY = -5,
18 RECURSE_SUBMODULES_CHECK = -4,
19 RECURSE_SUBMODULES_ERROR = -3,
20 RECURSE_SUBMODULES_NONE = -2,
21 RECURSE_SUBMODULES_ON_DEMAND = -1,
22 RECURSE_SUBMODULES_OFF = 0,
23 RECURSE_SUBMODULES_DEFAULT = 1,
24 RECURSE_SUBMODULES_ON = 2
25};
26
27enum submodule_update_type {
28 SM_UPDATE_UNSPECIFIED = 0,
29 SM_UPDATE_CHECKOUT,
30 SM_UPDATE_REBASE,
31 SM_UPDATE_MERGE,
32 SM_UPDATE_NONE,
33 SM_UPDATE_COMMAND
34};
35
36struct submodule_update_strategy {
37 enum submodule_update_type type;
38 const char *command;
39};
40#define SUBMODULE_UPDATE_STRATEGY_INIT { \
41 .type = SM_UPDATE_UNSPECIFIED, \
42}
43
44int parse_submodule_update_strategy(const char *value,
45 struct submodule_update_strategy *dst);
46void submodule_update_strategy_release(struct submodule_update_strategy *strategy);
47
48int is_gitmodules_unmerged(struct index_state *istate);
49int is_writing_gitmodules_ok(void);
50int is_staging_gitmodules_ok(struct index_state *istate);
51int update_path_in_gitmodules(const char *oldpath, const char *newpath);
52int remove_path_from_gitmodules(const char *path);
53void stage_updated_gitmodules(struct index_state *istate);
54void set_diffopt_flags_from_submodule_config(struct diff_options *,
55 const char *path);
56int git_default_submodule_config(const char *var, const char *value, void *cb);
57
58struct option;
59int option_parse_recurse_submodules_worktree_updater(const struct option *opt,
60 const char *arg, int unset);
61int is_tree_submodule_active(struct repository *repo,
62 const struct object_id *treeish_name,
63 const char *path);
64int is_submodule_active(struct repository *repo, const char *path);
65/*
66 * Determine if a submodule has been populated at a given 'path' by checking if
67 * the <path>/.git resolves to a valid git repository.
68 * If return_error_code is NULL, die on error.
69 * Otherwise the return error code is the same as of resolve_gitdir_gently.
70 */
71int is_submodule_populated_gently(const char *path, int *return_error_code);
72void die_in_unpopulated_submodule(struct index_state *istate,
73 const char *prefix);
74void die_path_inside_submodule(struct index_state *istate,
75 const struct pathspec *ps);
76enum submodule_update_type parse_submodule_update_type(const char *value);
77const char *submodule_update_type_to_string(enum submodule_update_type type);
78void handle_ignore_submodules_arg(struct diff_options *, const char *);
79void show_submodule_diff_summary(struct diff_options *o, const char *path,
80 struct object_id *one, struct object_id *two,
81 unsigned dirty_submodule);
82void show_submodule_inline_diff(struct diff_options *o, const char *path,
83 struct object_id *one, struct object_id *two,
84 unsigned dirty_submodule);
85/* Check if we want to update any submodule.*/
86int should_update_submodules(void);
87/*
88 * Returns the submodule struct if the given ce entry is a submodule
89 * and it should be updated. Returns NULL otherwise.
90 */
91const struct submodule *submodule_from_ce(const struct cache_entry *ce);
92void check_for_new_submodule_commits(struct object_id *oid);
93int fetch_submodules(struct repository *r,
94 const struct strvec *options,
95 const char *prefix,
96 int command_line_option,
97 int default_option,
98 int quiet, int max_parallel_jobs);
99unsigned is_submodule_modified(const char *path, int ignore_untracked);
100int submodule_uses_gitfile(const char *path);
101
102#define SUBMODULE_REMOVAL_DIE_ON_ERROR (1<<0)
103#define SUBMODULE_REMOVAL_IGNORE_UNTRACKED (1<<1)
104#define SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED (1<<2)
105int bad_to_remove_submodule(const char *path, unsigned flags);
106
107/*
108 * Checks if there are submodule changes in a..b. If a is the null OID,
109 * checks b and all its ancestors instead.
110 */
111int submodule_touches_in_range(struct repository *r,
112 struct object_id *a,
113 struct object_id *b);
114int find_unpushed_submodules(struct repository *r,
115 struct oid_array *commits,
116 const char *remotes_name,
117 struct string_list *needs_pushing);
118struct refspec;
119int push_unpushed_submodules(struct repository *r,
120 struct oid_array *commits,
121 const struct remote *remote,
122 const struct refspec *rs,
123 const struct string_list *push_options,
124 int dry_run);
125/*
126 * Given a submodule path (as in the index), return the repository
127 * path of that submodule in 'buf'. Return -1 on error or when the
128 * submodule is not initialized.
129 */
130int submodule_to_gitdir(struct repository *repo,
131 struct strbuf *buf, const char *submodule);
132
133/*
134 * Given a submodule name, create a path to where the submodule's gitdir lives
135 * inside of the provided repository's 'modules' directory.
136 */
137void submodule_name_to_gitdir(struct strbuf *buf, struct repository *r,
138 const char *submodule_name);
139
140/*
141 * Make sure that no submodule's git dir is nested in a sibling submodule's.
142 */
143int validate_submodule_git_dir(char *git_dir, const char *submodule_name);
144
145/*
146 * Make sure that the given submodule path does not follow symlinks.
147 */
148int validate_submodule_path(const char *path);
149
150#define SUBMODULE_MOVE_HEAD_DRY_RUN (1<<0)
151#define SUBMODULE_MOVE_HEAD_FORCE (1<<1)
152int submodule_move_head(const char *path, const char *super_prefix,
153 const char *old_head, const char *new_head,
154 unsigned flags);
155
156void submodule_unset_core_worktree(const struct submodule *sub);
157
158/*
159 * Prepare the "env" parameter of a "struct child_process" for executing
160 * a submodule by clearing any repo-specific environment variables, but
161 * retaining any config in the environment.
162 */
163void prepare_submodule_repo_env(struct strvec *env);
164
165void absorb_git_dir_into_superproject(const char *path,
166 const char *super_prefix);
167
168/*
169 * Return the absolute path of the working tree of the superproject, which this
170 * project is a submodule of. If this repository is not a submodule of
171 * another repository, return 0.
172 */
173int get_superproject_working_tree(struct strbuf *buf);
174
175#endif