1 #ifndef SUBMODULE_H 2 #define SUBMODULE_H 3 4 struct argv_array; 5 struct cache_entry; 6 struct diff_options; 7 struct index_state; 8 struct object_id; 9 struct oid_array; 10 struct pathspec; 11 struct remote; 12 struct repository; 13 struct string_list; 14 struct strbuf; 15 16 enum { 17 RECURSE_SUBMODULES_ONLY = -5, 18 RECURSE_SUBMODULES_CHECK = -4, 19 RECURSE_SUBMODULES_ERROR = -3, 20 RECURSE_SUBMODULES_NONE = -2, 21 RECURSE_SUBMODULES_ON_DEMAND = -1, 22 RECURSE_SUBMODULES_OFF = 0, 23 RECURSE_SUBMODULES_DEFAULT = 1, 24 RECURSE_SUBMODULES_ON = 2 25 }; 26 27 enum 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 36 struct submodule_update_strategy { 37 enum submodule_update_type type; 38 const char *command; 39 }; 40 #define SUBMODULE_UPDATE_STRATEGY_INIT {SM_UPDATE_UNSPECIFIED, NULL} 41 42 int is_gitmodules_unmerged(const struct index_state *istate); 43 int is_writing_gitmodules_ok(void); 44 int is_staging_gitmodules_ok(struct index_state *istate); 45 int update_path_in_gitmodules(const char *oldpath, const char *newpath); 46 int remove_path_from_gitmodules(const char *path); 47 void stage_updated_gitmodules(struct index_state *istate); 48 void set_diffopt_flags_from_submodule_config(struct diff_options *, 49 const char *path); 50 int git_default_submodule_config(const char *var, const char *value, void *cb); 51 52 struct option; 53 int option_parse_recurse_submodules_worktree_updater(const struct option *opt, 54 const char *arg, int unset); 55 int is_submodule_active(struct repository *repo, const char *path); 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 */ 62 int is_submodule_populated_gently(const char *path, int *return_error_code); 63 void die_in_unpopulated_submodule(const struct index_state *istate, 64 const char *prefix); 65 void die_path_inside_submodule(const struct index_state *istate, 66 const struct pathspec *ps); 67 enum submodule_update_type parse_submodule_update_type(const char *value); 68 int parse_submodule_update_strategy(const char *value, 69 struct submodule_update_strategy *dst); 70 const char *submodule_strategy_to_string(const struct submodule_update_strategy *s); 71 void handle_ignore_submodules_arg(struct diff_options *, const char *); 72 void show_submodule_summary(struct diff_options *o, const char *path, 73 struct object_id *one, struct object_id *two, 74 unsigned dirty_submodule); 75 void show_submodule_inline_diff(struct diff_options *o, const char *path, 76 struct object_id *one, struct object_id *two, 77 unsigned dirty_submodule); 78 /* Check if we want to update any submodule.*/ 79 int should_update_submodules(void); 80 /* 81 * Returns the submodule struct if the given ce entry is a submodule 82 * and it should be updated. Returns NULL otherwise. 83 */ 84 const struct submodule *submodule_from_ce(const struct cache_entry *ce); 85 void check_for_new_submodule_commits(struct object_id *oid); 86 int 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); 92 unsigned is_submodule_modified(const char *path, int ignore_untracked); 93 int submodule_uses_gitfile(const char *path); 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) 98 int bad_to_remove_submodule(const char *path, unsigned flags); 99 100 int add_submodule_odb(const char *path); 101 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 */ 106 int submodule_touches_in_range(struct repository *r, 107 struct object_id *a, 108 struct object_id *b); 109 int find_unpushed_submodules(struct repository *r, 110 struct oid_array *commits, 111 const char *remotes_name, 112 struct string_list *needs_pushing); 113 struct refspec; 114 int push_unpushed_submodules(struct repository *r, 115 struct oid_array *commits, 116 const struct remote *remote, 117 const struct refspec *rs, 118 const struct string_list *push_options, 119 int dry_run); 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 */ 125 int submodule_to_gitdir(struct strbuf *buf, const char *submodule); 126 127 /* 128 * Make sure that no submodule's git dir is nested in a sibling submodule's. 129 */ 130 int validate_submodule_git_dir(char *git_dir, const char *submodule_name); 131 132 #define SUBMODULE_MOVE_HEAD_DRY_RUN (1<<0) 133 #define SUBMODULE_MOVE_HEAD_FORCE (1<<1) 134 int submodule_move_head(const char *path, 135 const char *old, 136 const char *new_head, 137 unsigned flags); 138 139 void submodule_unset_core_worktree(const struct submodule *sub); 140 141 /* 142 * Prepare the "env_array" parameter of a "struct child_process" for executing 143 * a submodule by clearing any repo-specific environment variables, but 144 * retaining any config in the environment. 145 */ 146 void prepare_submodule_repo_env(struct argv_array *out); 147 148 #define ABSORB_GITDIR_RECURSE_SUBMODULES (1<<0) 149 void absorb_git_dir_into_superproject(const char *path, 150 unsigned flags); 151 152 /* 153 * Return the absolute path of the working tree of the superproject, which this 154 * project is a submodule of. If this repository is not a submodule of 155 * another repository, return NULL. 156 */ 157 const char *get_superproject_working_tree(void); 158 159 #endif 160