]>
Commit | Line | Data |
---|---|---|
752c0c24 JS |
1 | #ifndef SUBMODULE_H |
2 | #define SUBMODULE_H | |
3 | ||
873cd28a | 4 | struct strvec; |
ef3ca954 EN |
5 | struct cache_entry; |
6 | struct diff_options; | |
7 | struct index_state; | |
8 | struct object_id; | |
910650d2 | 9 | struct oid_array; |
ef3ca954 | 10 | struct pathspec; |
06bf4ad1 | 11 | struct remote; |
ef3ca954 EN |
12 | struct repository; |
13 | struct string_list; | |
14 | struct strbuf; | |
46a958b3 | 15 | |
88a21979 | 16 | enum { |
6c656c3f | 17 | RECURSE_SUBMODULES_ONLY = -5, |
b33a15b0 | 18 | RECURSE_SUBMODULES_CHECK = -4, |
027771fc | 19 | RECURSE_SUBMODULES_ERROR = -3, |
959b5455 | 20 | RECURSE_SUBMODULES_NONE = -2, |
88a21979 JL |
21 | RECURSE_SUBMODULES_ON_DEMAND = -1, |
22 | RECURSE_SUBMODULES_OFF = 0, | |
23 | RECURSE_SUBMODULES_DEFAULT = 1, | |
24 | RECURSE_SUBMODULES_ON = 2 | |
25 | }; | |
26 | ||
ea2fa5a3 SB |
27 | enum submodule_update_type { |
28 | SM_UPDATE_UNSPECIFIED = 0, | |
29 | SM_UPDATE_CHECKOUT, | |
30 | SM_UPDATE_REBASE, | |
31 | SM_UPDATE_MERGE, | |
32 | SM_UPDATE_NONE, | |
33 | SM_UPDATE_COMMAND | |
34 | }; | |
35 | ||
36 | struct submodule_update_strategy { | |
37 | enum submodule_update_type type; | |
38 | const char *command; | |
39 | }; | |
f69a6e4f ÆAB |
40 | #define SUBMODULE_UPDATE_STRATEGY_INIT { \ |
41 | .type = SM_UPDATE_UNSPECIFIED, \ | |
42 | } | |
ea2fa5a3 | 43 | |
847a9e5d | 44 | int is_gitmodules_unmerged(struct index_state *istate); |
b5c259f2 | 45 | int is_writing_gitmodules_ok(void); |
4dcd706f NTND |
46 | int is_staging_gitmodules_ok(struct index_state *istate); |
47 | int update_path_in_gitmodules(const char *oldpath, const char *newpath); | |
48 | int remove_path_from_gitmodules(const char *path); | |
49 | void stage_updated_gitmodules(struct index_state *istate); | |
50 | void set_diffopt_flags_from_submodule_config(struct diff_options *, | |
51 | const char *path); | |
52 | int git_default_submodule_config(const char *var, const char *value, void *cb); | |
d7a3803f SB |
53 | |
54 | struct option; | |
55 | int option_parse_recurse_submodules_worktree_updater(const struct option *opt, | |
56 | const char *arg, int unset); | |
961b130d GC |
57 | int is_tree_submodule_active(struct repository *repo, |
58 | const struct object_id *treeish_name, | |
59 | const char *path); | |
4dcd706f | 60 | int is_submodule_active(struct repository *repo, const char *path); |
15cdc647 SB |
61 | /* |
62 | * Determine if a submodule has been populated at a given 'path' by checking if | |
63 | * the <path>/.git resolves to a valid git repository. | |
64 | * If return_error_code is NULL, die on error. | |
65 | * Otherwise the return error code is the same as of resolve_gitdir_gently. | |
66 | */ | |
4dcd706f | 67 | int is_submodule_populated_gently(const char *path, int *return_error_code); |
847a9e5d | 68 | void die_in_unpopulated_submodule(struct index_state *istate, |
4dcd706f | 69 | const char *prefix); |
847a9e5d | 70 | void die_path_inside_submodule(struct index_state *istate, |
4dcd706f NTND |
71 | const struct pathspec *ps); |
72 | enum submodule_update_type parse_submodule_update_type(const char *value); | |
73 | int parse_submodule_update_strategy(const char *value, | |
74 | struct submodule_update_strategy *dst); | |
75 | const char *submodule_strategy_to_string(const struct submodule_update_strategy *s); | |
76 | void handle_ignore_submodules_arg(struct diff_options *, const char *); | |
180b154b | 77 | void show_submodule_diff_summary(struct diff_options *o, const char *path, |
4dcd706f NTND |
78 | struct object_id *one, struct object_id *two, |
79 | unsigned dirty_submodule); | |
80 | void show_submodule_inline_diff(struct diff_options *o, const char *path, | |
81 | struct object_id *one, struct object_id *two, | |
82 | unsigned dirty_submodule); | |
84f8925e | 83 | /* Check if we want to update any submodule.*/ |
4dcd706f | 84 | int should_update_submodules(void); |
84f8925e SB |
85 | /* |
86 | * Returns the submodule struct if the given ce entry is a submodule | |
87 | * and it should be updated. Returns NULL otherwise. | |
88 | */ | |
4dcd706f NTND |
89 | const struct submodule *submodule_from_ce(const struct cache_entry *ce); |
90 | void check_for_new_submodule_commits(struct object_id *oid); | |
91 | int fetch_populated_submodules(struct repository *r, | |
873cd28a | 92 | const struct strvec *options, |
4dcd706f NTND |
93 | const char *prefix, |
94 | int command_line_option, | |
95 | int default_option, | |
96 | int quiet, int max_parallel_jobs); | |
97 | unsigned is_submodule_modified(const char *path, int ignore_untracked); | |
98 | int submodule_uses_gitfile(const char *path); | |
83b76966 SB |
99 | |
100 | #define SUBMODULE_REMOVAL_DIE_ON_ERROR (1<<0) | |
101 | #define SUBMODULE_REMOVAL_IGNORE_UNTRACKED (1<<1) | |
102 | #define SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED (1<<2) | |
4dcd706f | 103 | int bad_to_remove_submodule(const char *path, unsigned flags); |
18cfc088 | 104 | |
a35e03de JT |
105 | /* |
106 | * Call add_submodule_odb() to add the submodule at the given path to a list. | |
107 | * When register_all_submodule_odb_as_alternates() is called, the object stores | |
108 | * of all submodules in that list will be added as alternates in | |
109 | * the_repository. | |
110 | */ | |
18cfc088 | 111 | int add_submodule_odb(const char *path); |
8d33c3af | 112 | void add_submodule_odb_by_path(const char *path); |
a35e03de | 113 | int register_all_submodule_odb_as_alternates(void); |
a6d7eb2c | 114 | |
4d36f88b JT |
115 | /* |
116 | * Checks if there are submodule changes in a..b. If a is the null OID, | |
117 | * checks b and all its ancestors instead. | |
118 | */ | |
6245b98b | 119 | int submodule_touches_in_range(struct repository *r, |
174d131f | 120 | struct object_id *a, |
4dcd706f | 121 | struct object_id *b); |
6245b98b | 122 | int find_unpushed_submodules(struct repository *r, |
174d131f | 123 | struct oid_array *commits, |
4dcd706f NTND |
124 | const char *remotes_name, |
125 | struct string_list *needs_pushing); | |
60fba4bf | 126 | struct refspec; |
6245b98b | 127 | int push_unpushed_submodules(struct repository *r, |
174d131f | 128 | struct oid_array *commits, |
4dcd706f NTND |
129 | const struct remote *remote, |
130 | const struct refspec *rs, | |
131 | const struct string_list *push_options, | |
132 | int dry_run); | |
bbbb7de7 NTND |
133 | /* |
134 | * Given a submodule path (as in the index), return the repository | |
135 | * path of that submodule in 'buf'. Return -1 on error or when the | |
136 | * submodule is not initialized. | |
137 | */ | |
138 | int submodule_to_gitdir(struct strbuf *buf, const char *submodule); | |
752c0c24 | 139 | |
ce125d43 JT |
140 | /* |
141 | * Given a submodule name, create a path to where the submodule's gitdir lives | |
142 | * inside of the provided repository's 'modules' directory. | |
143 | */ | |
144 | void submodule_name_to_gitdir(struct strbuf *buf, struct repository *r, | |
145 | const char *submodule_name); | |
146 | ||
a8dee3ca JS |
147 | /* |
148 | * Make sure that no submodule's git dir is nested in a sibling submodule's. | |
149 | */ | |
150 | int validate_submodule_git_dir(char *git_dir, const char *submodule_name); | |
151 | ||
6e3c1595 SB |
152 | #define SUBMODULE_MOVE_HEAD_DRY_RUN (1<<0) |
153 | #define SUBMODULE_MOVE_HEAD_FORCE (1<<1) | |
4dcd706f NTND |
154 | int submodule_move_head(const char *path, |
155 | const char *old, | |
156 | const char *new_head, | |
157 | unsigned flags); | |
6e3c1595 | 158 | |
898c2e65 SB |
159 | void submodule_unset_core_worktree(const struct submodule *sub); |
160 | ||
4638728c JK |
161 | /* |
162 | * Prepare the "env_array" parameter of a "struct child_process" for executing | |
217bb56d | 163 | * a submodule by clearing any repo-specific environment variables, but |
89044baa | 164 | * retaining any config in the environment. |
4638728c | 165 | */ |
873cd28a | 166 | void prepare_submodule_repo_env(struct strvec *out); |
4638728c | 167 | |
f6f85861 | 168 | #define ABSORB_GITDIR_RECURSE_SUBMODULES (1<<0) |
cf7a901a | 169 | void absorb_git_dir_into_superproject(const char *path, |
4dcd706f | 170 | unsigned flags); |
bf0231c6 SB |
171 | |
172 | /* | |
173 | * Return the absolute path of the working tree of the superproject, which this | |
174 | * project is a submodule of. If this repository is not a submodule of | |
49d3c4b4 | 175 | * another repository, return 0. |
bf0231c6 | 176 | */ |
49d3c4b4 | 177 | int get_superproject_working_tree(struct strbuf *buf); |
bf0231c6 | 178 | |
752c0c24 | 179 | #endif |