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