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