submodule--helper: don't overlay config in remote_submodule_branch
[git/git.git] / submodule.h
CommitLineData
752c0c24
JS
1#ifndef SUBMODULE_H
2#define SUBMODULE_H
3
69aba532 4struct repository;
46a958b3 5struct diff_options;
50d89ad6 6struct argv_array;
910650d2 7struct oid_array;
06bf4ad1 8struct remote;
46a958b3 9
88a21979 10enum {
6c656c3f 11 RECURSE_SUBMODULES_ONLY = -5,
b33a15b0 12 RECURSE_SUBMODULES_CHECK = -4,
027771fc 13 RECURSE_SUBMODULES_ERROR = -3,
959b5455 14 RECURSE_SUBMODULES_NONE = -2,
88a21979
JL
15 RECURSE_SUBMODULES_ON_DEMAND = -1,
16 RECURSE_SUBMODULES_OFF = 0,
17 RECURSE_SUBMODULES_DEFAULT = 1,
18 RECURSE_SUBMODULES_ON = 2
19};
20
ea2fa5a3
SB
21enum 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};
29
30struct submodule_update_strategy {
31 enum submodule_update_type type;
32 const char *command;
33};
a028a193 34#define SUBMODULE_UPDATE_STRATEGY_INIT {SM_UPDATE_UNSPECIFIED, NULL}
ea2fa5a3 35
34e2ba04 36extern int is_gitmodules_unmerged(const struct index_state *istate);
91b83480 37extern int is_staging_gitmodules_ok(const struct index_state *istate);
bd267561
SB
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 *,
aee9c7d6 42 const char *path);
bd267561 43extern int submodule_config(const char *var, const char *value, void *cb);
046b4823 44extern int git_default_submodule_config(const char *var, const char *value, void *cb);
d7a3803f
SB
45
46struct option;
47int option_parse_recurse_submodules_worktree_updater(const struct option *opt,
48 const char *arg, int unset);
49void load_submodule_cache(void);
bd267561 50extern void gitmodules_config(void);
69aba532 51extern void repo_read_gitmodules(struct repository *repo);
cd73de47 52extern void gitmodules_config_oid(const struct object_id *commit_oid);
627d9342 53extern int is_submodule_active(struct repository *repo, const char *path);
15cdc647
SB
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);
bdab9721
BW
61extern void die_in_unpopulated_submodule(const struct index_state *istate,
62 const char *prefix);
c08397e3
BW
63extern void die_path_inside_submodule(const struct index_state *istate,
64 const struct pathspec *ps);
bd267561 65extern int parse_submodule_update_strategy(const char *value,
ea2fa5a3 66 struct submodule_update_strategy *dst);
bd267561
SB
67extern const char *submodule_strategy_to_string(const struct submodule_update_strategy *s);
68extern void handle_ignore_submodules_arg(struct diff_options *, const char *);
69extern void show_submodule_summary(FILE *f, const char *path,
0f33a067 70 const char *line_prefix,
602a283a 71 struct object_id *one, struct object_id *two,
4e215131 72 unsigned dirty_submodule, const char *meta,
752c0c24 73 const char *del, const char *add, const char *reset);
bd267561 74extern void show_submodule_inline_diff(FILE *f, const char *path,
fd47ae6a
JK
75 const char *line_prefix,
76 struct object_id *one, struct object_id *two,
77 unsigned dirty_submodule, const char *meta,
78 const char *del, const char *add, const char *reset,
79 const struct diff_options *opt);
84f8925e
SB
80/* Check if we want to update any submodule.*/
81extern int should_update_submodules(void);
82/*
83 * Returns the submodule struct if the given ce entry is a submodule
84 * and it should be updated. Returns NULL otherwise.
85 */
86extern const struct submodule *submodule_from_ce(const struct cache_entry *ce);
2eb80bcd 87extern void check_for_new_submodule_commits(struct object_id *oid);
bd267561 88extern int fetch_populated_submodules(const struct argv_array *options,
8f0700dd 89 const char *prefix, int command_line_option,
8fa29159 90 int default_option,
62104ba1 91 int quiet, int max_parallel_jobs);
bd267561
SB
92extern unsigned is_submodule_modified(const char *path, int ignore_untracked);
93extern int submodule_uses_gitfile(const char *path);
83b76966
SB
94
95#define SUBMODULE_REMOVAL_DIE_ON_ERROR (1<<0)
96#define SUBMODULE_REMOVAL_IGNORE_UNTRACKED (1<<1)
97#define SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED (1<<2)
98extern int bad_to_remove_submodule(const char *path, unsigned flags);
71f35d5c 99extern int merge_submodule(struct object_id *result, const char *path,
100 const struct object_id *base,
101 const struct object_id *a,
102 const struct object_id *b, int search);
a6d7eb2c
SB
103
104/* Checks if there are submodule changes in a..b. */
105extern int submodule_touches_in_range(struct object_id *a,
106 struct object_id *b);
910650d2 107extern int find_unpushed_submodules(struct oid_array *commits,
bd267561
SB
108 const char *remotes_name,
109 struct string_list *needs_pushing);
910650d2 110extern int push_unpushed_submodules(struct oid_array *commits,
06bf4ad1
BW
111 const struct remote *remote,
112 const char **refspec, int refspec_nr,
2a90556d 113 const struct string_list *push_options,
0301c821 114 int dry_run);
bd267561 115extern void connect_work_tree_and_git_dir(const char *work_tree, const char *git_dir);
bbbb7de7
NTND
116/*
117 * Given a submodule path (as in the index), return the repository
118 * path of that submodule in 'buf'. Return -1 on error or when the
119 * submodule is not initialized.
120 */
121int submodule_to_gitdir(struct strbuf *buf, const char *submodule);
752c0c24 122
6e3c1595
SB
123#define SUBMODULE_MOVE_HEAD_DRY_RUN (1<<0)
124#define SUBMODULE_MOVE_HEAD_FORCE (1<<1)
125extern int submodule_move_head(const char *path,
126 const char *old,
127 const char *new,
128 unsigned flags);
129
4638728c
JK
130/*
131 * Prepare the "env_array" parameter of a "struct child_process" for executing
132 * a submodule by clearing any repo-specific envirionment variables, but
89044baa 133 * retaining any config in the environment.
4638728c 134 */
bd267561 135extern void prepare_submodule_repo_env(struct argv_array *out);
4638728c 136
f6f85861
SB
137#define ABSORB_GITDIR_RECURSE_SUBMODULES (1<<0)
138extern void absorb_git_dir_into_superproject(const char *prefix,
139 const char *path,
140 unsigned flags);
bf0231c6
SB
141
142/*
143 * Return the absolute path of the working tree of the superproject, which this
144 * project is a submodule of. If this repository is not a submodule of
145 * another repository, return NULL.
146 */
147extern const char *get_superproject_working_tree(void);
148
752c0c24 149#endif