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