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