1#ifndef SUBMODULE_H
2#define SUBMODULE_H
3struct diff_options;
5struct argv_array;
6struct oid_array;
7struct remote;
8enum {
10 RECURSE_SUBMODULES_ONLY = -5,
11 RECURSE_SUBMODULES_CHECK = -4,
12 RECURSE_SUBMODULES_ERROR = -3,
13 RECURSE_SUBMODULES_NONE = -2,
14 RECURSE_SUBMODULES_ON_DEMAND = -1,
15 RECURSE_SUBMODULES_OFF = 0,
16 RECURSE_SUBMODULES_DEFAULT = 1,
17 RECURSE_SUBMODULES_ON = 2
18};
19enum submodule_update_type {
21 SM_UPDATE_UNSPECIFIED = 0,
22 SM_UPDATE_CHECKOUT,
23 SM_UPDATE_REBASE,
24 SM_UPDATE_MERGE,
25 SM_UPDATE_NONE,
26 SM_UPDATE_COMMAND
27};
28struct submodule_update_strategy {
30 enum submodule_update_type type;
31 const char *command;
32};
33#define SUBMODULE_UPDATE_STRATEGY_INIT {SM_UPDATE_UNSPECIFIED, NULL}
34extern int is_staging_gitmodules_ok(void);
36extern int update_path_in_gitmodules(const char *oldpath, const char *newpath);
37extern int remove_path_from_gitmodules(const char *path);
38extern void stage_updated_gitmodules(void);
39extern void set_diffopt_flags_from_submodule_config(struct diff_options *,
40 const char *path);
41extern int submodule_config(const char *var, const char *value, void *cb);
42extern int git_default_submodule_config(const char *var, const char *value, void *cb);
43struct option;
45int option_parse_recurse_submodules_worktree_updater(const struct option *opt,
46 const char *arg, int unset);
47void load_submodule_cache(void);
48extern void gitmodules_config(void);
49extern void gitmodules_config_sha1(const unsigned char *commit_sha1);
50extern int is_submodule_initialized(const char *path);
51/*
52 * Determine if a submodule has been populated at a given 'path' by checking if
53 * the <path>/.git resolves to a valid git repository.
54 * If return_error_code is NULL, die on error.
55 * Otherwise the return error code is the same as of resolve_gitdir_gently.
56 */
57extern int is_submodule_populated_gently(const char *path, int *return_error_code);
58extern void die_in_unpopulated_submodule(const struct index_state *istate,
59 const char *prefix);
60extern void die_path_inside_submodule(const struct index_state *istate,
61 const struct pathspec *ps);
62extern int parse_submodule_update_strategy(const char *value,
63 struct submodule_update_strategy *dst);
64extern const char *submodule_strategy_to_string(const struct submodule_update_strategy *s);
65extern void handle_ignore_submodules_arg(struct diff_options *, const char *);
66extern void show_submodule_summary(FILE *f, const char *path,
67 const char *line_prefix,
68 struct object_id *one, struct object_id *two,
69 unsigned dirty_submodule, const char *meta,
70 const char *del, const char *add, const char *reset);
71extern void show_submodule_inline_diff(FILE *f, const char *path,
72 const char *line_prefix,
73 struct object_id *one, struct object_id *two,
74 unsigned dirty_submodule, const char *meta,
75 const char *del, const char *add, const char *reset,
76 const struct diff_options *opt);
77extern void set_config_fetch_recurse_submodules(int value);
78/* Check if we want to update any submodule.*/
79extern int should_update_submodules(void);
80/*
81 * Returns the submodule struct if the given ce entry is a submodule
82 * and it should be updated. Returns NULL otherwise.
83 */
84extern const struct submodule *submodule_from_ce(const struct cache_entry *ce);
85extern void check_for_new_submodule_commits(struct object_id *oid);
86extern int fetch_populated_submodules(const struct argv_array *options,
87 const char *prefix, int command_line_option,
88 int quiet, int max_parallel_jobs);
89extern unsigned is_submodule_modified(const char *path, int ignore_untracked);
90extern int submodule_uses_gitfile(const char *path);
91#define SUBMODULE_REMOVAL_DIE_ON_ERROR (1<<0)
93#define SUBMODULE_REMOVAL_IGNORE_UNTRACKED (1<<1)
94#define SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED (1<<2)
95extern int bad_to_remove_submodule(const char *path, unsigned flags);
96extern int merge_submodule(struct object_id *result, const char *path,
97 const struct object_id *base,
98 const struct object_id *a,
99 const struct object_id *b, int search);
100extern int find_unpushed_submodules(struct oid_array *commits,
101 const char *remotes_name,
102 struct string_list *needs_pushing);
103extern int push_unpushed_submodules(struct oid_array *commits,
104 const struct remote *remote,
105 const char **refspec, int refspec_nr,
106 const struct string_list *push_options,
107 int dry_run);
108extern void connect_work_tree_and_git_dir(const char *work_tree, const char *git_dir);
109extern int parallel_submodules(void);
110/*
111 * Given a submodule path (as in the index), return the repository
112 * path of that submodule in 'buf'. Return -1 on error or when the
113 * submodule is not initialized.
114 */
115int submodule_to_gitdir(struct strbuf *buf, const char *submodule);
116#define SUBMODULE_MOVE_HEAD_DRY_RUN (1<<0)
118#define SUBMODULE_MOVE_HEAD_FORCE (1<<1)
119extern int submodule_move_head(const char *path,
120 const char *old,
121 const char *new,
122 unsigned flags);
123/*
125 * Prepare the "env_array" parameter of a "struct child_process" for executing
126 * a submodule by clearing any repo-specific envirionment variables, but
127 * retaining any config in the environment.
128 */
129extern void prepare_submodule_repo_env(struct argv_array *out);
130#define ABSORB_GITDIR_RECURSE_SUBMODULES (1<<0)
132extern void absorb_git_dir_into_superproject(const char *prefix,
133 const char *path,
134 unsigned flags);
135/*
137 * Return the absolute path of the working tree of the superproject, which this
138 * project is a submodule of. If this repository is not a submodule of
139 * another repository, return NULL.
140 */
141extern const char *get_superproject_working_tree(void);
142#endif