@leroysheep / LeeRoySheep
Code Commits Pulls CI/CD 82,128
seen
bisect jch maint master next seen test todo
h 180 lines 6.3 KB
Raw
1 #ifndef SUBMODULE_H
2 #define SUBMODULE_H
3
4 struct strvec;
5 struct cache_entry;
6 struct diff_options;
7 struct index_state;
8 struct object_id;
9 struct oid_array;
10 struct pathspec;
11 struct remote;
12 struct repository;
13 struct string_list;
14 struct strbuf;
15
16 enum 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
27 enum 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
36 struct 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
44 int parse_submodule_update_strategy(const char *value,
45 struct submodule_update_strategy *dst);
46 void submodule_update_strategy_release(struct submodule_update_strategy *strategy);
47
48 int is_gitmodules_unmerged(struct index_state *istate);
49 int is_writing_gitmodules_ok(void);
50 int is_staging_gitmodules_ok(struct index_state *istate);
51 int update_path_in_gitmodules(const char *oldpath, const char *newpath);
52 int remove_path_from_gitmodules(const char *path);
53 void stage_updated_gitmodules(struct index_state *istate);
54 void set_diffopt_flags_from_submodule_config(struct diff_options *,
55 const char *path);
56 int git_default_submodule_config(const char *var, const char *value, void *cb);
57
58 struct option;
59 int option_parse_recurse_submodules_worktree_updater(const struct option *opt,
60 const char *arg, int unset);
61 int is_tree_submodule_active(struct repository *repo,
62 const struct object_id *treeish_name,
63 const char *path);
64 int 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 */
71 int is_submodule_populated_gently(const char *path, int *return_error_code);
72 void die_in_unpopulated_submodule(struct index_state *istate,
73 const char *prefix);
74 void die_path_inside_submodule(struct index_state *istate,
75 const struct pathspec *ps);
76 enum submodule_update_type parse_submodule_update_type(const char *value);
77 const char *submodule_update_type_to_string(enum submodule_update_type type);
78 void handle_ignore_submodules_arg(struct diff_options *, const char *);
79 void show_submodule_diff_summary(struct diff_options *o, const char *path,
80 struct object_id *one, struct object_id *two,
81 unsigned dirty_submodule);
82 void 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.*/
86 int 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 */
91 const struct submodule *submodule_from_ce(const struct cache_entry *ce);
92 void check_for_new_submodule_commits(struct object_id *oid);
93 /* Values for the submodule_errors parameter of fetch_submodules(). */
94 #define SUBMODULE_ERRORS_FAIL 0 /* submodule fetch errors are fatal (default) */
95 #define SUBMODULE_ERRORS_WARN 1 /* submodule fetch errors are non-fatal warnings */
96
97 int fetch_submodules(struct repository *r,
98 const struct strvec *options,
99 const char *prefix,
100 int command_line_option,
101 int default_option,
102 int quiet, int max_parallel_jobs,
103 int submodule_errors);
104 unsigned is_submodule_modified(const char *path, int ignore_untracked);
105 int submodule_uses_gitfile(const char *path);
106
107 #define SUBMODULE_REMOVAL_DIE_ON_ERROR (1<<0)
108 #define SUBMODULE_REMOVAL_IGNORE_UNTRACKED (1<<1)
109 #define SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED (1<<2)
110 int bad_to_remove_submodule(const char *path, unsigned flags);
111
112 /*
113 * Checks if there are submodule changes in a..b. If a is the null OID,
114 * checks b and all its ancestors instead.
115 */
116 int submodule_touches_in_range(struct repository *r,
117 struct object_id *a,
118 struct object_id *b);
119 int find_unpushed_submodules(struct repository *r,
120 struct oid_array *commits,
121 const char *remotes_name,
122 struct string_list *needs_pushing);
123 struct refspec;
124 int push_unpushed_submodules(struct repository *r,
125 struct oid_array *commits,
126 const struct remote *remote,
127 const struct refspec *rs,
128 const struct string_list *push_options,
129 int dry_run);
130 /*
131 * Given a submodule path (as in the index), return the repository
132 * path of that submodule in 'buf'. Return -1 on error or when the
133 * submodule is not initialized.
134 */
135 int submodule_to_gitdir(struct repository *repo,
136 struct strbuf *buf, const char *submodule);
137
138 /*
139 * Given a submodule name, create a path to where the submodule's gitdir lives
140 * inside of the provided repository's 'modules' directory.
141 */
142 void submodule_name_to_gitdir(struct strbuf *buf, struct repository *r,
143 const char *submodule_name);
144
145 /*
146 * Make sure that no submodule's git dir is nested in a sibling submodule's.
147 */
148 int validate_submodule_git_dir(char *git_dir, const char *submodule_name);
149
150 /*
151 * Make sure that the given submodule path does not follow symlinks.
152 */
153 int validate_submodule_path(const char *path);
154
155 #define SUBMODULE_MOVE_HEAD_DRY_RUN (1<<0)
156 #define SUBMODULE_MOVE_HEAD_FORCE (1<<1)
157 int submodule_move_head(const char *path, const char *super_prefix,
158 const char *old_head, const char *new_head,
159 unsigned flags);
160
161 void submodule_unset_core_worktree(const struct submodule *sub);
162
163 /*
164 * Prepare the "env" parameter of a "struct child_process" for executing
165 * a submodule by clearing any repo-specific environment variables, but
166 * retaining any config in the environment.
167 */
168 void prepare_submodule_repo_env(struct strvec *env);
169
170 void absorb_git_dir_into_superproject(const char *path,
171 const char *super_prefix);
172
173 /*
174 * Return the absolute path of the working tree of the superproject, which this
175 * project is a submodule of. If this repository is not a submodule of
176 * another repository, return 0.
177 */
178 int get_superproject_working_tree(struct strbuf *buf);
179
180 #endif