submodule: add repo_read_gitmodules
[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
bd267561
SB
36extern int is_staging_gitmodules_ok(void);
37extern int update_path_in_gitmodules(const char *oldpath, const char *newpath);
38extern int remove_path_from_gitmodules(const char *path);
39extern void stage_updated_gitmodules(void);
40extern void set_diffopt_flags_from_submodule_config(struct diff_options *,
aee9c7d6 41 const char *path);
bd267561 42extern int submodule_config(const char *var, const char *value, void *cb);
046b4823 43extern int git_default_submodule_config(const char *var, const char *value, void *cb);
d7a3803f
SB
44
45struct option;
46int option_parse_recurse_submodules_worktree_updater(const struct option *opt,
47 const char *arg, int unset);
48void load_submodule_cache(void);
bd267561 49extern void gitmodules_config(void);
69aba532 50extern void repo_read_gitmodules(struct repository *repo);
9ebf689a 51extern void gitmodules_config_sha1(const unsigned char *commit_sha1);
f9f42560 52extern int is_submodule_initialized(const char *path);
15cdc647
SB
53/*
54 * Determine if a submodule has been populated at a given 'path' by checking if
55 * the <path>/.git resolves to a valid git repository.
56 * If return_error_code is NULL, die on error.
57 * Otherwise the return error code is the same as of resolve_gitdir_gently.
58 */
59extern int is_submodule_populated_gently(const char *path, int *return_error_code);
bdab9721
BW
60extern void die_in_unpopulated_submodule(const struct index_state *istate,
61 const char *prefix);
c08397e3
BW
62extern void die_path_inside_submodule(const struct index_state *istate,
63 const struct pathspec *ps);
bd267561 64extern int parse_submodule_update_strategy(const char *value,
ea2fa5a3 65 struct submodule_update_strategy *dst);
bd267561
SB
66extern const char *submodule_strategy_to_string(const struct submodule_update_strategy *s);
67extern void handle_ignore_submodules_arg(struct diff_options *, const char *);
68extern void show_submodule_summary(FILE *f, const char *path,
0f33a067 69 const char *line_prefix,
602a283a 70 struct object_id *one, struct object_id *two,
4e215131 71 unsigned dirty_submodule, const char *meta,
752c0c24 72 const char *del, const char *add, const char *reset);
bd267561 73extern void show_submodule_inline_diff(FILE *f, const char *path,
fd47ae6a
JK
74 const char *line_prefix,
75 struct object_id *one, struct object_id *two,
76 unsigned dirty_submodule, const char *meta,
77 const char *del, const char *add, const char *reset,
78 const struct diff_options *opt);
bd267561 79extern void set_config_fetch_recurse_submodules(int value);
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,
62104ba1 90 int quiet, int max_parallel_jobs);
bd267561
SB
91extern unsigned is_submodule_modified(const char *path, int ignore_untracked);
92extern int submodule_uses_gitfile(const char *path);
83b76966
SB
93
94#define SUBMODULE_REMOVAL_DIE_ON_ERROR (1<<0)
95#define SUBMODULE_REMOVAL_IGNORE_UNTRACKED (1<<1)
96#define SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED (1<<2)
97extern int bad_to_remove_submodule(const char *path, unsigned flags);
71f35d5c 98extern int merge_submodule(struct object_id *result, const char *path,
99 const struct object_id *base,
100 const struct object_id *a,
101 const struct object_id *b, int search);
910650d2 102extern int find_unpushed_submodules(struct oid_array *commits,
bd267561
SB
103 const char *remotes_name,
104 struct string_list *needs_pushing);
910650d2 105extern int push_unpushed_submodules(struct oid_array *commits,
06bf4ad1
BW
106 const struct remote *remote,
107 const char **refspec, int refspec_nr,
2a90556d 108 const struct string_list *push_options,
0301c821 109 int dry_run);
bd267561
SB
110extern void connect_work_tree_and_git_dir(const char *work_tree, const char *git_dir);
111extern int parallel_submodules(void);
bbbb7de7
NTND
112/*
113 * Given a submodule path (as in the index), return the repository
114 * path of that submodule in 'buf'. Return -1 on error or when the
115 * submodule is not initialized.
116 */
117int submodule_to_gitdir(struct strbuf *buf, const char *submodule);
752c0c24 118
6e3c1595
SB
119#define SUBMODULE_MOVE_HEAD_DRY_RUN (1<<0)
120#define SUBMODULE_MOVE_HEAD_FORCE (1<<1)
121extern int submodule_move_head(const char *path,
122 const char *old,
123 const char *new,
124 unsigned flags);
125
4638728c
JK
126/*
127 * Prepare the "env_array" parameter of a "struct child_process" for executing
128 * a submodule by clearing any repo-specific envirionment variables, but
89044baa 129 * retaining any config in the environment.
4638728c 130 */
bd267561 131extern void prepare_submodule_repo_env(struct argv_array *out);
4638728c 132
f6f85861
SB
133#define ABSORB_GITDIR_RECURSE_SUBMODULES (1<<0)
134extern void absorb_git_dir_into_superproject(const char *prefix,
135 const char *path,
136 unsigned flags);
bf0231c6
SB
137
138/*
139 * Return the absolute path of the working tree of the superproject, which this
140 * project is a submodule of. If this repository is not a submodule of
141 * another repository, return NULL.
142 */
143extern const char *get_superproject_working_tree(void);
144
752c0c24 145#endif