🌐 AI搜索 & 代理 主页
Google Git
Sign in
chromium / external / github.com / git / git / refs/tags/v2.35.6 / . / submodule.h
blob: 6bd2c99fd99d409abd89771d511b3a7db5f47252 [file] [log] [blame]
Johannes Schindelin752c0c22009-10-19 12:38:32[diff] [blame]1#ifndef SUBMODULE_H
2#define SUBMODULE_H
3
Jeff King873cd282020-07-28 20:23:25[diff] [blame]4struct strvec;
Elijah Newrenef3ca952018-08-15 17:54:05[diff] [blame]5struct cache_entry;
6struct diff_options;
7struct index_state;
8struct object_id;
brian m. carlson910650d2017-03-31 01:40:00[diff] [blame]9struct oid_array;
Elijah Newrenef3ca952018-08-15 17:54:05[diff] [blame]10struct pathspec;
Brandon Williams06bf4ad2017-04-05 17:47:19[diff] [blame]11struct remote;
Elijah Newrenef3ca952018-08-15 17:54:05[diff] [blame]12struct repository;
13struct string_list;
14struct strbuf;
Jens Lehmann46a958b2010-06-25 14:56:47[diff] [blame]15
Jens Lehmann88a21972011-03-06 22:10:46[diff] [blame]16enum {
Brandon Williams6c656c32016-12-19 18:25:32[diff] [blame]17 RECURSE_SUBMODULES_ONLY = -5,
Mike Croweb33a15b2015-11-17 11:05:56[diff] [blame]18 RECURSE_SUBMODULES_CHECK = -4,
Heiko Voigt027771f2015-08-18 00:22:00[diff] [blame]19 RECURSE_SUBMODULES_ERROR = -3,
Heiko Voigt959b5452015-08-18 00:21:57[diff] [blame]20 RECURSE_SUBMODULES_NONE = -2,
Jens Lehmann88a21972011-03-06 22:10:46[diff] [blame]21 RECURSE_SUBMODULES_ON_DEMAND = -1,
22 RECURSE_SUBMODULES_OFF = 0,
23 RECURSE_SUBMODULES_DEFAULT = 1,
24 RECURSE_SUBMODULES_ON = 2
25};
26
Stefan Bellerea2fa5a2016-03-01 02:07:11[diff] [blame]27enum 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
36struct submodule_update_strategy {
37 enum submodule_update_type type;
38 const char *command;
39};
Ævar Arnfjörð Bjarmasonf69a6e42021-09-27 12:54:27[diff] [blame]40#define SUBMODULE_UPDATE_STRATEGY_INIT { \
41 .type = SM_UPDATE_UNSPECIFIED, \
42}
Stefan Bellerea2fa5a2016-03-01 02:07:11[diff] [blame]43
Derrick Stolee847a9e52021-04-01 01:49:39[diff] [blame]44int is_gitmodules_unmerged(struct index_state *istate);
Antonio Ospiteb5c259f2018-10-05 13:05:59[diff] [blame]45int is_writing_gitmodules_ok(void);
Nguyễn Thái Ngọc Duy4dcd7062018-06-30 09:20:31[diff] [blame]46int is_staging_gitmodules_ok(struct index_state *istate);
47int update_path_in_gitmodules(const char *oldpath, const char *newpath);
48int remove_path_from_gitmodules(const char *path);
49void stage_updated_gitmodules(struct index_state *istate);
50void set_diffopt_flags_from_submodule_config(struct diff_options *,
51 const char *path);
52int git_default_submodule_config(const char *var, const char *value, void *cb);
Stefan Bellerd7a38032017-05-26 19:10:12[diff] [blame]53
54struct option;
55int option_parse_recurse_submodules_worktree_updater(const struct option *opt,
56 const char *arg, int unset);
Nguyễn Thái Ngọc Duy4dcd7062018-06-30 09:20:31[diff] [blame]57int is_submodule_active(struct repository *repo, const char *path);
Stefan Beller15cdc642017-03-14 21:46:31[diff] [blame]58/*
59 * Determine if a submodule has been populated at a given 'path' by checking if
60 * the <path>/.git resolves to a valid git repository.
61 * If return_error_code is NULL, die on error.
62 * Otherwise the return error code is the same as of resolve_gitdir_gently.
63 */
Nguyễn Thái Ngọc Duy4dcd7062018-06-30 09:20:31[diff] [blame]64int is_submodule_populated_gently(const char *path, int *return_error_code);
Derrick Stolee847a9e52021-04-01 01:49:39[diff] [blame]65void die_in_unpopulated_submodule(struct index_state *istate,
Nguyễn Thái Ngọc Duy4dcd7062018-06-30 09:20:31[diff] [blame]66 const char *prefix);
Derrick Stolee847a9e52021-04-01 01:49:39[diff] [blame]67void die_path_inside_submodule(struct index_state *istate,
Nguyễn Thái Ngọc Duy4dcd7062018-06-30 09:20:31[diff] [blame]68 const struct pathspec *ps);
69enum submodule_update_type parse_submodule_update_type(const char *value);
70int parse_submodule_update_strategy(const char *value,
71 struct submodule_update_strategy *dst);
72const char *submodule_strategy_to_string(const struct submodule_update_strategy *s);
73void handle_ignore_submodules_arg(struct diff_options *, const char *);
Shourya Shukla180b1542020-08-12 19:44:02[diff] [blame]74void show_submodule_diff_summary(struct diff_options *o, const char *path,
Nguyễn Thái Ngọc Duy4dcd7062018-06-30 09:20:31[diff] [blame]75 struct object_id *one, struct object_id *two,
76 unsigned dirty_submodule);
77void show_submodule_inline_diff(struct diff_options *o, const char *path,
78 struct object_id *one, struct object_id *two,
79 unsigned dirty_submodule);
Stefan Beller84f89252017-03-14 21:46:34[diff] [blame]80/* Check if we want to update any submodule.*/
Nguyễn Thái Ngọc Duy4dcd7062018-06-30 09:20:31[diff] [blame]81int should_update_submodules(void);
Stefan Beller84f89252017-03-14 21:46:34[diff] [blame]82/*
83 * Returns the submodule struct if the given ce entry is a submodule
84 * and it should be updated. Returns NULL otherwise.
85 */
Nguyễn Thái Ngọc Duy4dcd7062018-06-30 09:20:31[diff] [blame]86const struct submodule *submodule_from_ce(const struct cache_entry *ce);
87void check_for_new_submodule_commits(struct object_id *oid);
88int fetch_populated_submodules(struct repository *r,
Jeff King873cd282020-07-28 20:23:25[diff] [blame]89 const struct strvec *options,
Nguyễn Thái Ngọc Duy4dcd7062018-06-30 09:20:31[diff] [blame]90 const char *prefix,
91 int command_line_option,
92 int default_option,
93 int quiet, int max_parallel_jobs);
94unsigned is_submodule_modified(const char *path, int ignore_untracked);
95int submodule_uses_gitfile(const char *path);
Stefan Beller83b76962016-12-20 23:20:11[diff] [blame]96
97#define SUBMODULE_REMOVAL_DIE_ON_ERROR (1<<0)
98#define SUBMODULE_REMOVAL_IGNORE_UNTRACKED (1<<1)
99#define SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED (1<<2)
Nguyễn Thái Ngọc Duy4dcd7062018-06-30 09:20:31[diff] [blame]100int bad_to_remove_submodule(const char *path, unsigned flags);
Stefan Beller18cfc082018-05-15 20:00:28[diff] [blame]101
Jonathan Tana35e03d2021-08-16 21:09:51[diff] [blame]102/*
103 * Call add_submodule_odb() to add the submodule at the given path to a list.
104 * When register_all_submodule_odb_as_alternates() is called, the object stores
105 * of all submodules in that list will be added as alternates in
106 * the_repository.
107 */
Stefan Beller18cfc082018-05-15 20:00:28[diff] [blame]108int add_submodule_odb(const char *path);
Jonathan Tan8d33c3a2021-08-16 21:09:52[diff] [blame]109void add_submodule_odb_by_path(const char *path);
Jonathan Tana35e03d2021-08-16 21:09:51[diff] [blame]110int register_all_submodule_odb_as_alternates(void);
Stefan Bellera6d7eb22017-06-23 19:13:02[diff] [blame]111
Jonathan Tan4d36f882018-05-24 20:47:29[diff] [blame]112/*
113 * Checks if there are submodule changes in a..b. If a is the null OID,
114 * checks b and all its ancestors instead.
115 */
Nguyễn Thái Ngọc Duy6245b982018-10-19 17:34:43[diff] [blame]116int submodule_touches_in_range(struct repository *r,
Nguyễn Thái Ngọc Duy174d1312018-09-21 15:57:35[diff] [blame]117 struct object_id *a,
Nguyễn Thái Ngọc Duy4dcd7062018-06-30 09:20:31[diff] [blame]118 struct object_id *b);
Nguyễn Thái Ngọc Duy6245b982018-10-19 17:34:43[diff] [blame]119int find_unpushed_submodules(struct repository *r,
Nguyễn Thái Ngọc Duy174d1312018-09-21 15:57:35[diff] [blame]120 struct oid_array *commits,
Nguyễn Thái Ngọc Duy4dcd7062018-06-30 09:20:31[diff] [blame]121 const char *remotes_name,
122 struct string_list *needs_pushing);
Brandon Williams60fba4b2018-05-16 22:58:23[diff] [blame]123struct refspec;
Nguyễn Thái Ngọc Duy6245b982018-10-19 17:34:43[diff] [blame]124int push_unpushed_submodules(struct repository *r,
Nguyễn Thái Ngọc Duy174d1312018-09-21 15:57:35[diff] [blame]125 struct oid_array *commits,
Nguyễn Thái Ngọc Duy4dcd7062018-06-30 09:20:31[diff] [blame]126 const struct remote *remote,
127 const struct refspec *rs,
128 const struct string_list *push_options,
129 int dry_run);
Nguyễn Thái Ngọc Duybbbb7de2017-03-26 02:42:30[diff] [blame]130/*
131 * Given a submodule path (as in the index), return the repository
132 * path of that submodule in 'buf'. Return -1 on error or when the
133 * submodule is not initialized.
134 */
135int submodule_to_gitdir(struct strbuf *buf, const char *submodule);
Johannes Schindelin752c0c22009-10-19 12:38:32[diff] [blame]136
Johannes Schindelina8dee3c2019-10-01 21:27:18[diff] [blame]137/*
Jonathan Tance125d42021-09-15 18:59:19[diff] [blame]138 * Given a submodule name, create a path to where the submodule's gitdir lives
139 * inside of the provided repository's 'modules' directory.
140 */
141void submodule_name_to_gitdir(struct strbuf *buf, struct repository *r,
142 const char *submodule_name);
143
144/*
Johannes Schindelina8dee3c2019-10-01 21:27:18[diff] [blame]145 * Make sure that no submodule's git dir is nested in a sibling submodule's.
146 */
147int validate_submodule_git_dir(char *git_dir, const char *submodule_name);
148
Stefan Beller6e3c1592017-03-14 21:46:37[diff] [blame]149#define SUBMODULE_MOVE_HEAD_DRY_RUN (1<<0)
150#define SUBMODULE_MOVE_HEAD_FORCE (1<<1)
Nguyễn Thái Ngọc Duy4dcd7062018-06-30 09:20:31[diff] [blame]151int submodule_move_head(const char *path,
152 const char *old,
153 const char *new_head,
154 unsigned flags);
Stefan Beller6e3c1592017-03-14 21:46:37[diff] [blame]155
Stefan Beller898c2e62018-12-14 23:59:43[diff] [blame]156void submodule_unset_core_worktree(const struct submodule *sub);
157
Jeff King46387282016-04-28 13:38:20[diff] [blame]158/*
Jeff King46387282016-04-28 13:38:20[diff] [blame]159 * Prepare the "env_array" parameter of a "struct child_process" for executing
Han-Wen Nienhuys217bb562017-09-21 12:43:37[diff] [blame]160 * a submodule by clearing any repo-specific environment variables, but
Jeff King89044ba2016-05-05 01:22:19[diff] [blame]161 * retaining any config in the environment.
Jeff King46387282016-04-28 13:38:20[diff] [blame]162 */
Jeff King873cd282020-07-28 20:23:25[diff] [blame]163void prepare_submodule_repo_env(struct strvec *out);
Jeff King46387282016-04-28 13:38:20[diff] [blame]164
Stefan Bellerf6f85862016-12-12 19:04:35[diff] [blame]165#define ABSORB_GITDIR_RECURSE_SUBMODULES (1<<0)
Jeff Kingcf7a9012019-05-09 21:27:31[diff] [blame]166void absorb_git_dir_into_superproject(const char *path,
Nguyễn Thái Ngọc Duy4dcd7062018-06-30 09:20:31[diff] [blame]167 unsigned flags);
Stefan Bellerbf0231c2017-03-08 23:07:42[diff] [blame]168
169/*
170 * Return the absolute path of the working tree of the superproject, which this
171 * project is a submodule of. If this repository is not a submodule of
Alexandr Miloslavskiy49d3c4b2020-03-10 13:11:24[diff] [blame]172 * another repository, return 0.
Stefan Bellerbf0231c2017-03-08 23:07:42[diff] [blame]173 */
Alexandr Miloslavskiy49d3c4b2020-03-10 13:11:24[diff] [blame]174int get_superproject_working_tree(struct strbuf *buf);
Stefan Bellerbf0231c2017-03-08 23:07:42[diff] [blame]175
Johannes Schindelin752c0c22009-10-19 12:38:32[diff] [blame]176#endif