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