9c32b28b1282672d7595c7e7fceeb10cc4bdc178
[git/git.git] / submodule.h
1 #ifndef SUBMODULE_H
2 #define SUBMODULE_H
3
4 struct diff_options;
5 struct argv_array;
6 struct sha1_array;
7
8 enum {
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
19 enum 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
28 struct 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
34 extern int is_staging_gitmodules_ok(void);
35 extern int update_path_in_gitmodules(const char *oldpath, const char *newpath);
36 extern int remove_path_from_gitmodules(const char *path);
37 extern void stage_updated_gitmodules(void);
38 extern void set_diffopt_flags_from_submodule_config(struct diff_options *,
39 const char *path);
40 extern int submodule_config(const char *var, const char *value, void *cb);
41 extern void gitmodules_config(void);
42 extern void gitmodules_config_sha1(const unsigned char *commit_sha1);
43 extern int is_submodule_initialized(const char *path);
44 extern int is_submodule_populated(const char *path);
45 extern int parse_submodule_update_strategy(const char *value,
46 struct submodule_update_strategy *dst);
47 extern const char *submodule_strategy_to_string(const struct submodule_update_strategy *s);
48 extern void handle_ignore_submodules_arg(struct diff_options *, const char *);
49 extern void show_submodule_summary(FILE *f, const char *path,
50 const char *line_prefix,
51 struct object_id *one, struct object_id *two,
52 unsigned dirty_submodule, const char *meta,
53 const char *del, const char *add, const char *reset);
54 extern void show_submodule_inline_diff(FILE *f, const char *path,
55 const char *line_prefix,
56 struct object_id *one, struct object_id *two,
57 unsigned dirty_submodule, const char *meta,
58 const char *del, const char *add, const char *reset,
59 const struct diff_options *opt);
60 extern void set_config_fetch_recurse_submodules(int value);
61 extern void check_for_new_submodule_commits(struct object_id *oid);
62 extern int fetch_populated_submodules(const struct argv_array *options,
63 const char *prefix, int command_line_option,
64 int quiet, int max_parallel_jobs);
65 extern unsigned is_submodule_modified(const char *path, int ignore_untracked);
66 extern int submodule_uses_gitfile(const char *path);
67
68 #define SUBMODULE_REMOVAL_DIE_ON_ERROR (1<<0)
69 #define SUBMODULE_REMOVAL_IGNORE_UNTRACKED (1<<1)
70 #define SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED (1<<2)
71 extern int bad_to_remove_submodule(const char *path, unsigned flags);
72 extern int merge_submodule(unsigned char result[20], const char *path,
73 const unsigned char base[20],
74 const unsigned char a[20],
75 const unsigned char b[20], int search);
76 extern int find_unpushed_submodules(struct sha1_array *commits,
77 const char *remotes_name,
78 struct string_list *needs_pushing);
79 extern int push_unpushed_submodules(struct sha1_array *commits,
80 const char *remotes_name,
81 int dry_run);
82 extern void connect_work_tree_and_git_dir(const char *work_tree, const char *git_dir);
83 extern int parallel_submodules(void);
84
85 /*
86 * Prepare the "env_array" parameter of a "struct child_process" for executing
87 * a submodule by clearing any repo-specific envirionment variables, but
88 * retaining any config in the environment.
89 */
90 extern void prepare_submodule_repo_env(struct argv_array *out);
91
92 #define ABSORB_GITDIR_RECURSE_SUBMODULES (1<<0)
93 extern void absorb_git_dir_into_superproject(const char *prefix,
94 const char *path,
95 unsigned flags);
96
97 /*
98 * Return the absolute path of the working tree of the superproject, which this
99 * project is a submodule of. If this repository is not a submodule of
100 * another repository, return NULL.
101 */
102 extern const char *get_superproject_working_tree(void);
103
104 #endif