🌐 AI搜索 & 代理 主页
Google Git
Sign in
chromium / external / github.com / git / git / refs/tags/v2.14.2 / . / submodule.h
blob: e85b1448638ac7255a48a1bc1e2d6409c3a85ba6 [file] [log] [blame]
Johannes Schindelin752c0c22009-10-19 12:38:32[diff] [blame]1#ifndef SUBMODULE_H
2#define SUBMODULE_H
3
Brandon Williams69aba532017-06-22 18:43:45[diff] [blame]4struct repository;
Jens Lehmann46a958b2010-06-25 14:56:47[diff] [blame]5struct diff_options;
Jens Lehmann50d89ad2012-09-01 15:27:06[diff] [blame]6struct argv_array;
brian m. carlson910650d2017-03-31 01:40:00[diff] [blame]7struct oid_array;
Brandon Williams06bf4ad2017-04-05 17:47:19[diff] [blame]8struct remote;
Jens Lehmann46a958b2010-06-25 14:56:47[diff] [blame]9
Jens Lehmann88a21972011-03-06 22:10:46[diff] [blame]10enum {
Brandon Williams6c656c32016-12-19 18:25:32[diff] [blame]11 RECURSE_SUBMODULES_ONLY = -5,
Mike Croweb33a15b2015-11-17 11:05:56[diff] [blame]12 RECURSE_SUBMODULES_CHECK = -4,
Heiko Voigt027771f2015-08-18 00:22:00[diff] [blame]13 RECURSE_SUBMODULES_ERROR = -3,
Heiko Voigt959b5452015-08-18 00:21:57[diff] [blame]14 RECURSE_SUBMODULES_NONE = -2,
Jens Lehmann88a21972011-03-06 22:10:46[diff] [blame]15 RECURSE_SUBMODULES_ON_DEMAND = -1,
16 RECURSE_SUBMODULES_OFF = 0,
17 RECURSE_SUBMODULES_DEFAULT = 1,
18 RECURSE_SUBMODULES_ON = 2
19};
20
Stefan Bellerea2fa5a2016-03-01 02:07:11[diff] [blame]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};
Stefan Bellera028a192016-03-01 02:07:13[diff] [blame]34#define SUBMODULE_UPDATE_STRATEGY_INIT {SM_UPDATE_UNSPECIFIED, NULL}
Stefan Bellerea2fa5a2016-03-01 02:07:11[diff] [blame]35
Stefan Bellerbd267562016-12-20 23:20:09[diff] [blame]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 *,
Jens Lehmannaee9c7d2010-08-05 22:39:25[diff] [blame]41 const char *path);
Stefan Bellerbd267562016-12-20 23:20:09[diff] [blame]42extern int submodule_config(const char *var, const char *value, void *cb);
Stefan Beller046b4822017-06-01 00:30:47[diff] [blame]43extern int git_default_submodule_config(const char *var, const char *value, void *cb);
Stefan Bellerd7a38032017-05-26 19:10:12[diff] [blame]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);
Stefan Bellerbd267562016-12-20 23:20:09[diff] [blame]49extern void gitmodules_config(void);
Brandon Williams69aba532017-06-22 18:43:45[diff] [blame]50extern void repo_read_gitmodules(struct repository *repo);
Brandon Williams9ebf6892016-12-16 19:03:18[diff] [blame]51extern void gitmodules_config_sha1(const unsigned char *commit_sha1);
Brandon Williams627d9342017-06-22 18:43:46[diff] [blame]52extern int is_submodule_active(struct repository *repo, const char *path);
Stefan Beller15cdc642017-03-14 21:46:31[diff] [blame]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);
Brandon Williamsbdab9722017-05-09 19:17:59[diff] [blame]60extern void die_in_unpopulated_submodule(const struct index_state *istate,
61 const char *prefix);
Brandon Williamsc08397e2017-05-11 22:04:24[diff] [blame]62extern void die_path_inside_submodule(const struct index_state *istate,
63 const struct pathspec *ps);
Stefan Bellerbd267562016-12-20 23:20:09[diff] [blame]64extern int parse_submodule_update_strategy(const char *value,
Stefan Bellerea2fa5a2016-03-01 02:07:11[diff] [blame]65 struct submodule_update_strategy *dst);
Stefan Bellerbd267562016-12-20 23:20:09[diff] [blame]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,
John Keeping0f33a062013-04-05 16:12:08[diff] [blame]69 const char *line_prefix,
Jacob Keller602a2832016-08-31 23:27:23[diff] [blame]70 struct object_id *one, struct object_id *two,
Ramkumar Ramachandra4e215132012-11-13 15:42:47[diff] [blame]71 unsigned dirty_submodule, const char *meta,
Johannes Schindelin752c0c22009-10-19 12:38:32[diff] [blame]72 const char *del, const char *add, const char *reset);
Stefan Bellerbd267562016-12-20 23:20:09[diff] [blame]73extern void show_submodule_inline_diff(FILE *f, const char *path,
Jacob Kellerfd47ae62016-08-31 23:27:25[diff] [blame]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);
Stefan Bellerbd267562016-12-20 23:20:09[diff] [blame]79extern void set_config_fetch_recurse_submodules(int value);
Stefan Beller84f89252017-03-14 21:46:34[diff] [blame]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);
brian m. carlson2eb80bc2017-03-26 16:01:35[diff] [blame]87extern void check_for_new_submodule_commits(struct object_id *oid);
Stefan Bellerbd267562016-12-20 23:20:09[diff] [blame]88extern int fetch_populated_submodules(const struct argv_array *options,
Jens Lehmann8f0700d2011-03-06 22:11:21[diff] [blame]89 const char *prefix, int command_line_option,
Stefan Beller62104ba2015-12-16 00:04:12[diff] [blame]90 int quiet, int max_parallel_jobs);
Stefan Bellerbd267562016-12-20 23:20:09[diff] [blame]91extern unsigned is_submodule_modified(const char *path, int ignore_untracked);
92extern int submodule_uses_gitfile(const char *path);
Stefan Beller83b76962016-12-20 23:20:11[diff] [blame]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);
brian m. carlson71f35d52017-05-06 22:09:57[diff] [blame]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);
Stefan Bellera6d7eb22017-06-23 19:13:02[diff] [blame]102
103/* Checks if there are submodule changes in a..b. */
104extern int submodule_touches_in_range(struct object_id *a,
105 struct object_id *b);
brian m. carlson910650d2017-03-31 01:40:00[diff] [blame]106extern int find_unpushed_submodules(struct oid_array *commits,
Stefan Bellerbd267562016-12-20 23:20:09[diff] [blame]107 const char *remotes_name,
108 struct string_list *needs_pushing);
brian m. carlson910650d2017-03-31 01:40:00[diff] [blame]109extern int push_unpushed_submodules(struct oid_array *commits,
Brandon Williams06bf4ad2017-04-05 17:47:19[diff] [blame]110 const struct remote *remote,
111 const char **refspec, int refspec_nr,
Brandon Williams2a905562017-04-05 17:47:16[diff] [blame]112 const struct string_list *push_options,
Brandon Williams0301c822016-11-17 18:46:04[diff] [blame]113 int dry_run);
Stefan Bellerbd267562016-12-20 23:20:09[diff] [blame]114extern void connect_work_tree_and_git_dir(const char *work_tree, const char *git_dir);
115extern int parallel_submodules(void);
Nguyễn Thái Ngọc Duybbbb7de2017-03-26 02:42:30[diff] [blame]116/*
117 * Given a submodule path (as in the index), return the repository
118 * path of that submodule in 'buf'. Return -1 on error or when the
119 * submodule is not initialized.
120 */
121int submodule_to_gitdir(struct strbuf *buf, const char *submodule);
Johannes Schindelin752c0c22009-10-19 12:38:32[diff] [blame]122
Stefan Beller6e3c1592017-03-14 21:46:37[diff] [blame]123#define SUBMODULE_MOVE_HEAD_DRY_RUN (1<<0)
124#define SUBMODULE_MOVE_HEAD_FORCE (1<<1)
125extern int submodule_move_head(const char *path,
126 const char *old,
127 const char *new,
128 unsigned flags);
129
Jeff King46387282016-04-28 13:38:20[diff] [blame]130/*
Jeff King46387282016-04-28 13:38:20[diff] [blame]131 * Prepare the "env_array" parameter of a "struct child_process" for executing
132 * a submodule by clearing any repo-specific envirionment variables, but
Jeff King89044ba2016-05-05 01:22:19[diff] [blame]133 * retaining any config in the environment.
Jeff King46387282016-04-28 13:38:20[diff] [blame]134 */
Stefan Bellerbd267562016-12-20 23:20:09[diff] [blame]135extern void prepare_submodule_repo_env(struct argv_array *out);
Jeff King46387282016-04-28 13:38:20[diff] [blame]136
Stefan Bellerf6f85862016-12-12 19:04:35[diff] [blame]137#define ABSORB_GITDIR_RECURSE_SUBMODULES (1<<0)
138extern void absorb_git_dir_into_superproject(const char *prefix,
139 const char *path,
140 unsigned flags);
Stefan Bellerbf0231c2017-03-08 23:07:42[diff] [blame]141
142/*
143 * Return the absolute path of the working tree of the superproject, which this
144 * project is a submodule of. If this repository is not a submodule of
145 * another repository, return NULL.
146 */
147extern const char *get_superproject_working_tree(void);
148
Johannes Schindelin752c0c22009-10-19 12:38:32[diff] [blame]149#endif