1#ifndef SUBMODULE_H
2#define SUBMODULE_H
3
4struct diff_options;
5struct argv_array;
6struct sha1_array;
7
8enum {
9 RECURSE_SUBMODULES_ONLY = -5,
10 RECURSE_SUBMODULES_CHECK = -4,
11 RECURSE_SUBMODULES_ERROR = -3,
12 RECURSE_SUBMODULES_NONE = -2,
13 RECURSE_SUBMODULES_ON_DEMAND = -1,
14 RECURSE_SUBMODULES_OFF = 0,
15 RECURSE_SUBMODULES_DEFAULT = 1,
16 RECURSE_SUBMODULES_ON = 2
17};
18
19enum submodule_update_type {
20 SM_UPDATE_UNSPECIFIED = 0,
21 SM_UPDATE_CHECKOUT,
22 SM_UPDATE_REBASE,
23 SM_UPDATE_MERGE,
24 SM_UPDATE_NONE,
25 SM_UPDATE_COMMAND
26};
27
28struct submodule_update_strategy {
29 enum submodule_update_type type;
30 const char *command;
31};
32#define SUBMODULE_UPDATE_STRATEGY_INIT {SM_UPDATE_UNSPECIFIED, NULL}
33
34extern int is_staging_gitmodules_ok(void);
35extern int update_path_in_gitmodules(const char *oldpath, const char *newpath);
36extern int remove_path_from_gitmodules(const char *path);
37extern void stage_updated_gitmodules(void);
38extern void set_diffopt_flags_from_submodule_config(struct diff_options *,
39 const char *path);
40extern int submodule_config(const char *var, const char *value, void *cb);
41extern void gitmodules_config(void);
42extern void gitmodules_config_sha1(const unsigned char *commit_sha1);
43extern int is_submodule_initialized(const char *path);
44/*
45 * Determine if a submodule has been populated at a given 'path' by checking if
46 * the <path>/.git resolves to a valid git repository.
47 * If return_error_code is NULL, die on error.
48 * Otherwise the return error code is the same as of resolve_gitdir_gently.
49 */
50extern int is_submodule_populated_gently(const char *path, int *return_error_code);
51extern int parse_submodule_update_strategy(const char *value,
52 struct submodule_update_strategy *dst);
53extern const char *submodule_strategy_to_string(const struct submodule_update_strategy *s);
54extern void handle_ignore_submodules_arg(struct diff_options *, const char *);
55extern void show_submodule_summary(FILE *f, const char *path,
56 const char *line_prefix,
57 struct object_id *one, struct object_id *two,
58 unsigned dirty_submodule, const char *meta,
59 const char *del, const char *add, const char *reset);
60extern void show_submodule_inline_diff(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,
65 const struct diff_options *opt);
66extern void set_config_fetch_recurse_submodules(int value);
67extern void check_for_new_submodule_commits(unsigned char new_sha1[20]);
68extern int fetch_populated_submodules(const struct argv_array *options,
69 const char *prefix, int command_line_option,
70 int quiet, int max_parallel_jobs);
71extern unsigned is_submodule_modified(const char *path, int ignore_untracked);
72extern int submodule_uses_gitfile(const char *path);
73
74#define SUBMODULE_REMOVAL_DIE_ON_ERROR (1<<0)
75#define SUBMODULE_REMOVAL_IGNORE_UNTRACKED (1<<1)
76#define SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED (1<<2)
77extern int bad_to_remove_submodule(const char *path, unsigned flags);
78extern int merge_submodule(unsigned char result[20], const char *path,
79 const unsigned char base[20],
80 const unsigned char a[20],
81 const unsigned char b[20], int search);
82extern int find_unpushed_submodules(struct sha1_array *commits,
83 const char *remotes_name,
84 struct string_list *needs_pushing);
85extern int push_unpushed_submodules(struct sha1_array *commits,
86 const char *remotes_name,
87 int dry_run);
88extern void connect_work_tree_and_git_dir(const char *work_tree, const char *git_dir);
89extern int parallel_submodules(void);
90
91/*
92 * Prepare the "env_array" parameter of a "struct child_process" for executing
93 * a submodule by clearing any repo-specific envirionment variables, but
94 * retaining any config in the environment.
95 */
96extern void prepare_submodule_repo_env(struct argv_array *out);
97
98#define ABSORB_GITDIR_RECURSE_SUBMODULES (1<<0)
99extern void absorb_git_dir_into_superproject(const char *prefix,
100 const char *path,
101 unsigned flags);
102#endif