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