Johannes Schindelin | 752c0c2 | 2009-10-19 14:38:32 +0200 | [diff] [blame] | 1 | #ifndef SUBMODULE_H |
| 2 | #define SUBMODULE_H |
| 3 | |
Jens Lehmann | 46a958b | 2010-06-25 16:56:47 +0200 | [diff] [blame] | 4 | struct diff_options; |
Jens Lehmann | 50d89ad | 2012-09-01 17:27:06 +0200 | [diff] [blame] | 5 | struct argv_array; |
brian m. carlson | 910650d | 2017-03-31 01:40:00 +0000 | [diff] [blame] | 6 | struct oid_array; |
Brandon Williams | 06bf4ad | 2017-04-05 10:47:19 -0700 | [diff] [blame] | 7 | struct remote; |
Jens Lehmann | 46a958b | 2010-06-25 16:56:47 +0200 | [diff] [blame] | 8 | |
Jens Lehmann | 88a2197 | 2011-03-06 23:10:46 +0100 | [diff] [blame] | 9 | enum { |
Brandon Williams | 6c656c3 | 2016-12-19 10:25:32 -0800 | [diff] [blame] | 10 | RECURSE_SUBMODULES_ONLY = -5, |
Mike Crowe | b33a15b | 2015-11-17 11:05:56 +0000 | [diff] [blame] | 11 | RECURSE_SUBMODULES_CHECK = -4, |
Heiko Voigt | 027771f | 2015-08-17 17:22:00 -0700 | [diff] [blame] | 12 | RECURSE_SUBMODULES_ERROR = -3, |
Heiko Voigt | 959b545 | 2015-08-17 17:21:57 -0700 | [diff] [blame] | 13 | RECURSE_SUBMODULES_NONE = -2, |
Jens Lehmann | 88a2197 | 2011-03-06 23:10:46 +0100 | [diff] [blame] | 14 | RECURSE_SUBMODULES_ON_DEMAND = -1, |
| 15 | RECURSE_SUBMODULES_OFF = 0, |
| 16 | RECURSE_SUBMODULES_DEFAULT = 1, |
| 17 | RECURSE_SUBMODULES_ON = 2 |
| 18 | }; |
| 19 | |
Stefan Beller | ea2fa5a | 2016-02-29 18:07:11 -0800 | [diff] [blame] | 20 | enum 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 | |
| 29 | struct submodule_update_strategy { |
| 30 | enum submodule_update_type type; |
| 31 | const char *command; |
| 32 | }; |
Stefan Beller | a028a19 | 2016-02-29 18:07:13 -0800 | [diff] [blame] | 33 | #define SUBMODULE_UPDATE_STRATEGY_INIT {SM_UPDATE_UNSPECIFIED, NULL} |
Stefan Beller | ea2fa5a | 2016-02-29 18:07:11 -0800 | [diff] [blame] | 34 | |
Stefan Beller | bd26756 | 2016-12-20 15:20:09 -0800 | [diff] [blame] | 35 | extern int is_staging_gitmodules_ok(void); |
| 36 | extern int update_path_in_gitmodules(const char *oldpath, const char *newpath); |
| 37 | extern int remove_path_from_gitmodules(const char *path); |
| 38 | extern void stage_updated_gitmodules(void); |
| 39 | extern void set_diffopt_flags_from_submodule_config(struct diff_options *, |
Jens Lehmann | aee9c7d | 2010-08-06 00:39:25 +0200 | [diff] [blame] | 40 | const char *path); |
Stefan Beller | bd26756 | 2016-12-20 15:20:09 -0800 | [diff] [blame] | 41 | extern int submodule_config(const char *var, const char *value, void *cb); |
| 42 | extern void gitmodules_config(void); |
Brandon Williams | 9ebf689 | 2016-12-16 11:03:18 -0800 | [diff] [blame] | 43 | extern void gitmodules_config_sha1(const unsigned char *commit_sha1); |
Brandon Williams | f9f4256 | 2016-12-16 11:03:17 -0800 | [diff] [blame] | 44 | extern int is_submodule_initialized(const char *path); |
Stefan Beller | 15cdc64 | 2017-03-14 14:46:31 -0700 | [diff] [blame] | 45 | /* |
| 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 | */ |
| 51 | extern int is_submodule_populated_gently(const char *path, int *return_error_code); |
Stefan Beller | bd26756 | 2016-12-20 15:20:09 -0800 | [diff] [blame] | 52 | extern int parse_submodule_update_strategy(const char *value, |
Stefan Beller | ea2fa5a | 2016-02-29 18:07:11 -0800 | [diff] [blame] | 53 | struct submodule_update_strategy *dst); |
Stefan Beller | bd26756 | 2016-12-20 15:20:09 -0800 | [diff] [blame] | 54 | extern const char *submodule_strategy_to_string(const struct submodule_update_strategy *s); |
| 55 | extern void handle_ignore_submodules_arg(struct diff_options *, const char *); |
| 56 | extern void show_submodule_summary(FILE *f, const char *path, |
John Keeping | 0f33a06 | 2013-04-05 17:12:08 +0100 | [diff] [blame] | 57 | const char *line_prefix, |
Jacob Keller | 602a283 | 2016-08-31 16:27:23 -0700 | [diff] [blame] | 58 | struct object_id *one, struct object_id *two, |
Ramkumar Ramachandra | 4e21513 | 2012-11-13 21:12:47 +0530 | [diff] [blame] | 59 | unsigned dirty_submodule, const char *meta, |
Johannes Schindelin | 752c0c2 | 2009-10-19 14:38:32 +0200 | [diff] [blame] | 60 | const char *del, const char *add, const char *reset); |
Stefan Beller | bd26756 | 2016-12-20 15:20:09 -0800 | [diff] [blame] | 61 | extern void show_submodule_inline_diff(FILE *f, const char *path, |
Jacob Keller | fd47ae6 | 2016-08-31 16:27:25 -0700 | [diff] [blame] | 62 | 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 Beller | bd26756 | 2016-12-20 15:20:09 -0800 | [diff] [blame] | 67 | extern void set_config_fetch_recurse_submodules(int value); |
Stefan Beller | cf055e4 | 2017-03-14 14:46:33 -0700 | [diff] [blame] | 68 | extern void set_config_update_recurse_submodules(int value); |
Stefan Beller | 84f8925 | 2017-03-14 14:46:34 -0700 | [diff] [blame] | 69 | /* Check if we want to update any submodule.*/ |
| 70 | extern 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 | */ |
| 75 | extern const struct submodule *submodule_from_ce(const struct cache_entry *ce); |
brian m. carlson | 2eb80bc | 2017-03-26 16:01:35 +0000 | [diff] [blame] | 76 | extern void check_for_new_submodule_commits(struct object_id *oid); |
Stefan Beller | bd26756 | 2016-12-20 15:20:09 -0800 | [diff] [blame] | 77 | extern int fetch_populated_submodules(const struct argv_array *options, |
Jens Lehmann | 8f0700d | 2011-03-06 23:11:21 +0100 | [diff] [blame] | 78 | const char *prefix, int command_line_option, |
Stefan Beller | 62104ba | 2015-12-15 16:04:12 -0800 | [diff] [blame] | 79 | int quiet, int max_parallel_jobs); |
Stefan Beller | bd26756 | 2016-12-20 15:20:09 -0800 | [diff] [blame] | 80 | extern unsigned is_submodule_modified(const char *path, int ignore_untracked); |
| 81 | extern int submodule_uses_gitfile(const char *path); |
Stefan Beller | 83b7696 | 2016-12-20 15:20:11 -0800 | [diff] [blame] | 82 | |
| 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) |
| 86 | extern int bad_to_remove_submodule(const char *path, unsigned flags); |
Stefan Beller | bd26756 | 2016-12-20 15:20:09 -0800 | [diff] [blame] | 87 | extern 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. carlson | 910650d | 2017-03-31 01:40:00 +0000 | [diff] [blame] | 91 | extern int find_unpushed_submodules(struct oid_array *commits, |
Stefan Beller | bd26756 | 2016-12-20 15:20:09 -0800 | [diff] [blame] | 92 | const char *remotes_name, |
| 93 | struct string_list *needs_pushing); |
brian m. carlson | 910650d | 2017-03-31 01:40:00 +0000 | [diff] [blame] | 94 | extern int push_unpushed_submodules(struct oid_array *commits, |
Brandon Williams | 06bf4ad | 2017-04-05 10:47:19 -0700 | [diff] [blame] | 95 | const struct remote *remote, |
| 96 | const char **refspec, int refspec_nr, |
Brandon Williams | 2a90556 | 2017-04-05 10:47:16 -0700 | [diff] [blame] | 97 | const struct string_list *push_options, |
Brandon Williams | 0301c82 | 2016-11-17 10:46:04 -0800 | [diff] [blame] | 98 | int dry_run); |
Stefan Beller | bd26756 | 2016-12-20 15:20:09 -0800 | [diff] [blame] | 99 | extern void connect_work_tree_and_git_dir(const char *work_tree, const char *git_dir); |
| 100 | extern int parallel_submodules(void); |
Nguyễn Thái Ngọc Duy | bbbb7de | 2017-03-26 09:42:30 +0700 | [diff] [blame] | 101 | /* |
| 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 | */ |
| 106 | int submodule_to_gitdir(struct strbuf *buf, const char *submodule); |
Johannes Schindelin | 752c0c2 | 2009-10-19 14:38:32 +0200 | [diff] [blame] | 107 | |
Stefan Beller | 6e3c159 | 2017-03-14 14:46:37 -0700 | [diff] [blame] | 108 | #define SUBMODULE_MOVE_HEAD_DRY_RUN (1<<0) |
| 109 | #define SUBMODULE_MOVE_HEAD_FORCE (1<<1) |
| 110 | extern int submodule_move_head(const char *path, |
| 111 | const char *old, |
| 112 | const char *new, |
| 113 | unsigned flags); |
| 114 | |
Jeff King | 4638728 | 2016-04-28 09:38:20 -0400 | [diff] [blame] | 115 | /* |
Jeff King | 4638728 | 2016-04-28 09:38:20 -0400 | [diff] [blame] | 116 | * Prepare the "env_array" parameter of a "struct child_process" for executing |
| 117 | * a submodule by clearing any repo-specific envirionment variables, but |
Jeff King | 89044ba | 2016-05-04 21:22:19 -0400 | [diff] [blame] | 118 | * retaining any config in the environment. |
Jeff King | 4638728 | 2016-04-28 09:38:20 -0400 | [diff] [blame] | 119 | */ |
Stefan Beller | bd26756 | 2016-12-20 15:20:09 -0800 | [diff] [blame] | 120 | extern void prepare_submodule_repo_env(struct argv_array *out); |
Jeff King | 4638728 | 2016-04-28 09:38:20 -0400 | [diff] [blame] | 121 | |
Stefan Beller | f6f8586 | 2016-12-12 11:04:35 -0800 | [diff] [blame] | 122 | #define ABSORB_GITDIR_RECURSE_SUBMODULES (1<<0) |
| 123 | extern void absorb_git_dir_into_superproject(const char *prefix, |
| 124 | const char *path, |
| 125 | unsigned flags); |
Stefan Beller | bf0231c | 2017-03-08 15:07:42 -0800 | [diff] [blame] | 126 | |
| 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 | */ |
| 132 | extern const char *get_superproject_working_tree(void); |
| 133 | |
Johannes Schindelin | 752c0c2 | 2009-10-19 14:38:32 +0200 | [diff] [blame] | 134 | #endif |