submodule.h

   1 #ifndef SUBMODULE_H
   2 #define SUBMODULE_H
   3
   4 struct strvec;
   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 submodule_recurse_mode {
  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 { \
  41         .type = SM_UPDATE_UNSPECIFIED, \
  42 }
  43
  44 int parse_submodule_update_strategy(const char *value,
  45                                     struct submodule_update_strategy *dst);
  46 void submodule_update_strategy_release(struct submodule_update_strategy *strategy);
  47
  48 int is_gitmodules_unmerged(struct index_state *istate);
  49 int is_writing_gitmodules_ok(void);
  50 int is_staging_gitmodules_ok(struct index_state *istate);
  51 int update_path_in_gitmodules(const char *oldpath, const char *newpath);
  52 int remove_path_from_gitmodules(const char *path);
  53 void stage_updated_gitmodules(struct index_state *istate);
  54 void set_diffopt_flags_from_submodule_config(struct diff_options *,
  55                                              const char *path);
  56 int git_default_submodule_config(const char *var, const char *value, void *cb);
  57
  58 struct option;
  59 int option_parse_recurse_submodules_worktree_updater(const struct option *opt,
  60                                                      const char *arg, int unset);
  61 int is_tree_submodule_active(struct repository *repo,
  62                              const struct object_id *treeish_name,
  63                              const char *path);
  64 int is_submodule_active(struct repository *repo, const char *path);
  65 /*
  66  * Determine if a submodule has been populated at a given 'path' by checking if
  67  * the <path>/.git resolves to a valid git repository.
  68  * If return_error_code is NULL, die on error.
  69  * Otherwise the return error code is the same as of resolve_gitdir_gently.
  70  */
  71 int is_submodule_populated_gently(const char *path, int *return_error_code);
  72 void die_in_unpopulated_submodule(struct index_state *istate,
  73                                   const char *prefix);
  74 void die_path_inside_submodule(struct index_state *istate,
  75                                const struct pathspec *ps);
  76 enum submodule_update_type parse_submodule_update_type(const char *value);
  77 const char *submodule_update_type_to_string(enum submodule_update_type type);
  78 void handle_ignore_submodules_arg(struct diff_options *, const char *);
  79 void show_submodule_diff_summary(struct diff_options *o, const char *path,
  80                             struct object_id *one, struct object_id *two,
  81                             unsigned dirty_submodule);
  82 void show_submodule_inline_diff(struct diff_options *o, const char *path,
  83                                 struct object_id *one, struct object_id *two,
  84                                 unsigned dirty_submodule);
  85 /* Check if we want to update any submodule.*/
  86 int should_update_submodules(void);
  87 /*
  88  * Returns the submodule struct if the given ce entry is a submodule
  89  * and it should be updated. Returns NULL otherwise.
  90  */
  91 const struct submodule *submodule_from_ce(const struct cache_entry *ce);
  92 void check_for_new_submodule_commits(struct object_id *oid);
  93 int fetch_submodules(struct repository *r,
  94                      const struct strvec *options,
  95                      const char *prefix,
  96                      int command_line_option,
  97                      int default_option,
  98                      int quiet, int max_parallel_jobs);
  99 unsigned is_submodule_modified(const char *path, int ignore_untracked);
 100 int submodule_uses_gitfile(const char *path);
 101
 102 #define SUBMODULE_REMOVAL_DIE_ON_ERROR (1<<0)
 103 #define SUBMODULE_REMOVAL_IGNORE_UNTRACKED (1<<1)
 104 #define SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED (1<<2)
 105 int bad_to_remove_submodule(const char *path, unsigned flags);
 106
 107 /*
 108  * Call add_submodule_odb_by_path() to add the submodule at the given
 109  * path to a list. When register_all_submodule_odb_as_alternates() is
 110  * called, the object stores of all submodules in that list will be
 111  * added as alternates in the_repository.
 112  */
 113 void add_submodule_odb_by_path(const char *path);
 114 int register_all_submodule_odb_as_alternates(void);
 115
 116 /*
 117  * Checks if there are submodule changes in a..b. If a is the null OID,
 118  * checks b and all its ancestors instead.
 119  */
 120 int submodule_touches_in_range(struct repository *r,
 121                                struct object_id *a,
 122                                struct object_id *b);
 123 int find_unpushed_submodules(struct repository *r,
 124                              struct oid_array *commits,
 125                              const char *remotes_name,
 126                              struct string_list *needs_pushing);
 127 struct refspec;
 128 int push_unpushed_submodules(struct repository *r,
 129                              struct oid_array *commits,
 130                              const struct remote *remote,
 131                              const struct refspec *rs,
 132                              const struct string_list *push_options,
 133                              int dry_run);
 134 /*
 135  * Given a submodule path (as in the index), return the repository
 136  * path of that submodule in 'buf'. Return -1 on error or when the
 137  * submodule is not initialized.
 138  */
 139 int submodule_to_gitdir(struct strbuf *buf, const char *submodule);
 140
 141 /*
 142  * Given a submodule name, create a path to where the submodule's gitdir lives
 143  * inside of the provided repository's 'modules' directory.
 144  */
 145 void submodule_name_to_gitdir(struct strbuf *buf, struct repository *r,
 146                               const char *submodule_name);
 147
 148 /*
 149  * Make sure that no submodule's git dir is nested in a sibling submodule's.
 150  */
 151 int validate_submodule_git_dir(char *git_dir, const char *submodule_name);
 152
 153 /*
 154  * Make sure that the given submodule path does not follow symlinks.
 155  */
 156 int validate_submodule_path(const char *path);
 157
 158 #define SUBMODULE_MOVE_HEAD_DRY_RUN (1<<0)
 159 #define SUBMODULE_MOVE_HEAD_FORCE   (1<<1)
 160 int submodule_move_head(const char *path, const char *super_prefix,
 161                         const char *old_head, const char *new_head,
 162                         unsigned flags);
 163
 164 void submodule_unset_core_worktree(const struct submodule *sub);
 165
 166 /*
 167  * Prepare the "env" parameter of a "struct child_process" for executing
 168  * a submodule by clearing any repo-specific environment variables, but
 169  * retaining any config in the environment.
 170  */
 171 void prepare_submodule_repo_env(struct strvec *env);
 172
 173 void absorb_git_dir_into_superproject(const char *path,
 174                                       const char *super_prefix);
 175
 176 /*
 177  * Return the absolute path of the working tree of the superproject, which this
 178  * project is a submodule of. If this repository is not a submodule of
 179  * another repository, return 0.
 180  */
 181 int get_superproject_working_tree(struct strbuf *buf);
 182
 183 #endif