blob: 1277480add48140c6bf8c6cbc51cb962e27637ae [file] [log] [blame]
Johannes Schindelin752c0c22009-10-19 14:38:32 +02001#ifndef SUBMODULE_H
2#define SUBMODULE_H
3
Jens Lehmann46a958b2010-06-25 16:56:47 +02004struct diff_options;
Jens Lehmann50d89ad2012-09-01 17:27:06 +02005struct argv_array;
brian m. carlson910650d2017-03-31 01:40:00 +00006struct oid_array;
Brandon Williams06bf4ad2017-04-05 10:47:19 -07007struct remote;
Jens Lehmann46a958b2010-06-25 16:56:47 +02008
Jens Lehmann88a21972011-03-06 23:10:46 +01009enum {
Brandon Williams6c656c32016-12-19 10:25:32 -080010 RECURSE_SUBMODULES_ONLY = -5,
Mike Croweb33a15b2015-11-17 11:05:56 +000011 RECURSE_SUBMODULES_CHECK = -4,
Heiko Voigt027771f2015-08-17 17:22:00 -070012 RECURSE_SUBMODULES_ERROR = -3,
Heiko Voigt959b5452015-08-17 17:21:57 -070013 RECURSE_SUBMODULES_NONE = -2,
Jens Lehmann88a21972011-03-06 23:10:46 +010014 RECURSE_SUBMODULES_ON_DEMAND = -1,
15 RECURSE_SUBMODULES_OFF = 0,
16 RECURSE_SUBMODULES_DEFAULT = 1,
17 RECURSE_SUBMODULES_ON = 2
18};
19
Stefan Bellerea2fa5a2016-02-29 18:07:11 -080020enum 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};
Stefan Bellera028a192016-02-29 18:07:13 -080033#define SUBMODULE_UPDATE_STRATEGY_INIT {SM_UPDATE_UNSPECIFIED, NULL}
Stefan Bellerea2fa5a2016-02-29 18:07:11 -080034
Stefan Bellerbd267562016-12-20 15:20:09 -080035extern 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 *,
Jens Lehmannaee9c7d2010-08-06 00:39:25 +020040 const char *path);
Stefan Bellerbd267562016-12-20 15:20:09 -080041extern int submodule_config(const char *var, const char *value, void *cb);
42extern void gitmodules_config(void);
Brandon Williams9ebf6892016-12-16 11:03:18 -080043extern void gitmodules_config_sha1(const unsigned char *commit_sha1);
Brandon Williamsf9f42562016-12-16 11:03:17 -080044extern int is_submodule_initialized(const char *path);
Stefan Beller15cdc642017-03-14 14:46:31 -070045/*
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);
Stefan Bellerbd267562016-12-20 15:20:09 -080052extern int parse_submodule_update_strategy(const char *value,
Stefan Bellerea2fa5a2016-02-29 18:07:11 -080053 struct submodule_update_strategy *dst);
Stefan Bellerbd267562016-12-20 15:20:09 -080054extern const char *submodule_strategy_to_string(const struct submodule_update_strategy *s);
55extern void handle_ignore_submodules_arg(struct diff_options *, const char *);
56extern void show_submodule_summary(FILE *f, const char *path,
John Keeping0f33a062013-04-05 17:12:08 +010057 const char *line_prefix,
Jacob Keller602a2832016-08-31 16:27:23 -070058 struct object_id *one, struct object_id *two,
Ramkumar Ramachandra4e215132012-11-13 21:12:47 +053059 unsigned dirty_submodule, const char *meta,
Johannes Schindelin752c0c22009-10-19 14:38:32 +020060 const char *del, const char *add, const char *reset);
Stefan Bellerbd267562016-12-20 15:20:09 -080061extern void show_submodule_inline_diff(FILE *f, const char *path,
Jacob Kellerfd47ae62016-08-31 16:27:25 -070062 const char *line_prefix,
63 struct object_id *one, struct object_id *two,
64 unsigned dirty_submodule, const char *meta,
65 const char *del, const char *add, const char *reset,
66 const struct diff_options *opt);
Stefan Bellerbd267562016-12-20 15:20:09 -080067extern void set_config_fetch_recurse_submodules(int value);
Stefan Bellercf055e42017-03-14 14:46:33 -070068extern void set_config_update_recurse_submodules(int value);
Stefan Beller84f89252017-03-14 14:46:34 -070069/* Check if we want to update any submodule.*/
70extern int should_update_submodules(void);
71/*
72 * Returns the submodule struct if the given ce entry is a submodule
73 * and it should be updated. Returns NULL otherwise.
74 */
75extern const struct submodule *submodule_from_ce(const struct cache_entry *ce);
brian m. carlson2eb80bc2017-03-26 16:01:35 +000076extern void check_for_new_submodule_commits(struct object_id *oid);
Stefan Bellerbd267562016-12-20 15:20:09 -080077extern int fetch_populated_submodules(const struct argv_array *options,
Jens Lehmann8f0700d2011-03-06 23:11:21 +010078 const char *prefix, int command_line_option,
Stefan Beller62104ba2015-12-15 16:04:12 -080079 int quiet, int max_parallel_jobs);
Stefan Bellerbd267562016-12-20 15:20:09 -080080extern unsigned is_submodule_modified(const char *path, int ignore_untracked);
81extern int submodule_uses_gitfile(const char *path);
Stefan Beller83b76962016-12-20 15:20:11 -080082
83#define SUBMODULE_REMOVAL_DIE_ON_ERROR (1<<0)
84#define SUBMODULE_REMOVAL_IGNORE_UNTRACKED (1<<1)
85#define SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED (1<<2)
86extern int bad_to_remove_submodule(const char *path, unsigned flags);
Stefan Bellerbd267562016-12-20 15:20:09 -080087extern int merge_submodule(unsigned char result[20], const char *path,
88 const unsigned char base[20],
89 const unsigned char a[20],
90 const unsigned char b[20], int search);
brian m. carlson910650d2017-03-31 01:40:00 +000091extern int find_unpushed_submodules(struct oid_array *commits,
Stefan Bellerbd267562016-12-20 15:20:09 -080092 const char *remotes_name,
93 struct string_list *needs_pushing);
brian m. carlson910650d2017-03-31 01:40:00 +000094extern int push_unpushed_submodules(struct oid_array *commits,
Brandon Williams06bf4ad2017-04-05 10:47:19 -070095 const struct remote *remote,
96 const char **refspec, int refspec_nr,
Brandon Williams2a905562017-04-05 10:47:16 -070097 const struct string_list *push_options,
Brandon Williams0301c822016-11-17 10:46:04 -080098 int dry_run);
Stefan Bellerbd267562016-12-20 15:20:09 -080099extern void connect_work_tree_and_git_dir(const char *work_tree, const char *git_dir);
100extern int parallel_submodules(void);
Nguyễn Thái Ngọc Duybbbb7de2017-03-26 09:42:30 +0700101/*
102 * Given a submodule path (as in the index), return the repository
103 * path of that submodule in 'buf'. Return -1 on error or when the
104 * submodule is not initialized.
105 */
106int submodule_to_gitdir(struct strbuf *buf, const char *submodule);
Johannes Schindelin752c0c22009-10-19 14:38:32 +0200107
Stefan Beller6e3c1592017-03-14 14:46:37 -0700108#define SUBMODULE_MOVE_HEAD_DRY_RUN (1<<0)
109#define SUBMODULE_MOVE_HEAD_FORCE (1<<1)
110extern int submodule_move_head(const char *path,
111 const char *old,
112 const char *new,
113 unsigned flags);
114
Jeff King46387282016-04-28 09:38:20 -0400115/*
Jeff King46387282016-04-28 09:38:20 -0400116 * Prepare the "env_array" parameter of a "struct child_process" for executing
117 * a submodule by clearing any repo-specific envirionment variables, but
Jeff King89044ba2016-05-04 21:22:19 -0400118 * retaining any config in the environment.
Jeff King46387282016-04-28 09:38:20 -0400119 */
Stefan Bellerbd267562016-12-20 15:20:09 -0800120extern void prepare_submodule_repo_env(struct argv_array *out);
Jeff King46387282016-04-28 09:38:20 -0400121
Stefan Bellerf6f85862016-12-12 11:04:35 -0800122#define ABSORB_GITDIR_RECURSE_SUBMODULES (1<<0)
123extern void absorb_git_dir_into_superproject(const char *prefix,
124 const char *path,
125 unsigned flags);
Stefan Bellerbf0231c2017-03-08 15:07:42 -0800126
127/*
128 * Return the absolute path of the working tree of the superproject, which this
129 * project is a submodule of. If this repository is not a submodule of
130 * another repository, return NULL.
131 */
132extern const char *get_superproject_working_tree(void);
133
Johannes Schindelin752c0c22009-10-19 14:38:32 +0200134#endif