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 void gitmodules_config(void);
43extern void gitmodules_config_sha1(const unsigned char *commit_sha1);
44extern int is_submodule_initialized(const char *path);
45/*
46 * Determine if a submodule has been populated at a given 'path' by checking if
47 * the <path>/.git resolves to a valid git repository.
48 * If return_error_code is NULL, die on error.
49 * Otherwise the return error code is the same as of resolve_gitdir_gently.
50 */
51extern int is_submodule_populated_gently(const char *path, int *return_error_code);
52extern void die_in_unpopulated_submodule(const struct index_state *istate,
53 const char *prefix);
54extern void die_path_inside_submodule(const struct index_state *istate,
55 const struct pathspec *ps);
56extern int parse_submodule_update_strategy(const char *value,
57 struct submodule_update_strategy *dst);
58extern const char *submodule_strategy_to_string(const struct submodule_update_strategy *s);
59extern void handle_ignore_submodules_arg(struct diff_options *, const char *);
60extern void show_submodule_summary(FILE *f, const char *path,
61 const char *line_prefix,
62 struct object_id *one, struct object_id *two,
63 unsigned dirty_submodule, const char *meta,
64 const char *del, const char *add, const char *reset);
65extern void show_submodule_inline_diff(FILE *f, const char *path,
66 const char *line_prefix,
67 struct object_id *one, struct object_id *two,
68 unsigned dirty_submodule, const char *meta,
69 const char *del, const char *add, const char *reset,
70 const struct diff_options *opt);
71extern void set_config_fetch_recurse_submodules(int value);
72extern void set_config_update_recurse_submodules(int value);
73/* Check if we want to update any submodule.*/
74extern int should_update_submodules(void);
75/*
76 * Returns the submodule struct if the given ce entry is a submodule
77 * and it should be updated. Returns NULL otherwise.
78 */
79extern const struct submodule *submodule_from_ce(const struct cache_entry *ce);
80extern void check_for_new_submodule_commits(struct object_id *oid);
81extern int fetch_populated_submodules(const struct argv_array *options,
82 const char *prefix, int command_line_option,
83 int quiet, int max_parallel_jobs);
84extern unsigned is_submodule_modified(const char *path, int ignore_untracked);
85extern int submodule_uses_gitfile(const char *path);
86#define SUBMODULE_REMOVAL_DIE_ON_ERROR (1<<0)
88#define SUBMODULE_REMOVAL_IGNORE_UNTRACKED (1<<1)
89#define SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED (1<<2)
90extern int bad_to_remove_submodule(const char *path, unsigned flags);
91extern int merge_submodule(struct object_id *result, const char *path,
92 const struct object_id *base,
93 const struct object_id *a,
94 const struct object_id *b, int search);
95extern int find_unpushed_submodules(struct oid_array *commits,
96 const char *remotes_name,
97 struct string_list *needs_pushing);
98extern int push_unpushed_submodules(struct oid_array *commits,
99 const struct remote *remote,
100 const char **refspec, int refspec_nr,
101 const struct string_list *push_options,
102 int dry_run);
103extern void connect_work_tree_and_git_dir(const char *work_tree, const char *git_dir);
104extern int parallel_submodules(void);
105/*
106 * Given a submodule path (as in the index), return the repository
107 * path of that submodule in 'buf'. Return -1 on error or when the
108 * submodule is not initialized.
109 */
110int submodule_to_gitdir(struct strbuf *buf, const char *submodule);
111#define SUBMODULE_MOVE_HEAD_DRY_RUN (1<<0)
113#define SUBMODULE_MOVE_HEAD_FORCE (1<<1)
114extern int submodule_move_head(const char *path,
115 const char *old,
116 const char *new,
117 unsigned flags);
118/*
120 * Prepare the "env_array" parameter of a "struct child_process" for executing
121 * a submodule by clearing any repo-specific envirionment variables, but
122 * retaining any config in the environment.
123 */
124extern void prepare_submodule_repo_env(struct argv_array *out);
125#define ABSORB_GITDIR_RECURSE_SUBMODULES (1<<0)
127extern void absorb_git_dir_into_superproject(const char *prefix,
128 const char *path,
129 unsigned flags);
130/*
132 * Return the absolute path of the working tree of the superproject, which this
133 * project is a submodule of. If this repository is not a submodule of
134 * another repository, return NULL.
135 */
136extern const char *get_superproject_working_tree(void);
137#endif