submodule.h

   1 #ifndef SUBMODULE_H
   2 #define SUBMODULE_H
   3
   4 struct repository;
   5 struct diff_options;
   6 struct argv_array;
   7 struct oid_array;
   8 struct remote;
   9
  10 enum {
  11         RECURSE_SUBMODULES_ONLY = -5,
  12         RECURSE_SUBMODULES_CHECK = -4,
  13         RECURSE_SUBMODULES_ERROR = -3,
  14         RECURSE_SUBMODULES_NONE = -2,
  15         RECURSE_SUBMODULES_ON_DEMAND = -1,
  16         RECURSE_SUBMODULES_OFF = 0,
  17         RECURSE_SUBMODULES_DEFAULT = 1,
  18         RECURSE_SUBMODULES_ON = 2
  19 };
  20
  21 enum submodule_update_type {
  22         SM_UPDATE_UNSPECIFIED = 0,
  23         SM_UPDATE_CHECKOUT,
  24         SM_UPDATE_REBASE,
  25         SM_UPDATE_MERGE,
  26         SM_UPDATE_NONE,
  27         SM_UPDATE_COMMAND
  28 };
  29
  30 struct submodule_update_strategy {
  31         enum submodule_update_type type;
  32         const char *command;
  33 };
  34 #define SUBMODULE_UPDATE_STRATEGY_INIT {SM_UPDATE_UNSPECIFIED, NULL}
  35
  36 int is_gitmodules_unmerged(const struct index_state *istate);
  37 int is_staging_gitmodules_ok(struct index_state *istate);
  38 int update_path_in_gitmodules(const char *oldpath, const char *newpath);
  39 int remove_path_from_gitmodules(const char *path);
  40 void stage_updated_gitmodules(struct index_state *istate);
  41 void set_diffopt_flags_from_submodule_config(struct diff_options *,
  42                                              const char *path);
  43 int git_default_submodule_config(const char *var, const char *value, void *cb);
  44
  45 struct option;
  46 int option_parse_recurse_submodules_worktree_updater(const struct option *opt,
  47                                                      const char *arg, int unset);
  48 int is_submodule_active(struct repository *repo, const char *path);
  49 /*
  50  * Determine if a submodule has been populated at a given 'path' by checking if
  51  * the <path>/.git resolves to a valid git repository.
  52  * If return_error_code is NULL, die on error.
  53  * Otherwise the return error code is the same as of resolve_gitdir_gently.
  54  */
  55 int is_submodule_populated_gently(const char *path, int *return_error_code);
  56 void die_in_unpopulated_submodule(const struct index_state *istate,
  57                                   const char *prefix);
  58 void die_path_inside_submodule(const struct index_state *istate,
  59                                const struct pathspec *ps);
  60 enum submodule_update_type parse_submodule_update_type(const char *value);
  61 int parse_submodule_update_strategy(const char *value,
  62                                     struct submodule_update_strategy *dst);
  63 const char *submodule_strategy_to_string(const struct submodule_update_strategy *s);
  64 void handle_ignore_submodules_arg(struct diff_options *, const char *);
  65 void show_submodule_summary(struct diff_options *o, const char *path,
  66                             struct object_id *one, struct object_id *two,
  67                             unsigned dirty_submodule);
  68 void show_submodule_inline_diff(struct diff_options *o, const char *path,
  69                                 struct object_id *one, struct object_id *two,
  70                                 unsigned dirty_submodule);
  71 /* Check if we want to update any submodule.*/
  72 int should_update_submodules(void);
  73 /*
  74  * Returns the submodule struct if the given ce entry is a submodule
  75  * and it should be updated. Returns NULL otherwise.
  76  */
  77 const struct submodule *submodule_from_ce(const struct cache_entry *ce);
  78 void check_for_new_submodule_commits(struct object_id *oid);
  79 int fetch_populated_submodules(struct repository *r,
  80                                const struct argv_array *options,
  81                                const char *prefix,
  82                                int command_line_option,
  83                                int default_option,
  84                                int quiet, int max_parallel_jobs);
  85 unsigned is_submodule_modified(const char *path, int ignore_untracked);
  86 int submodule_uses_gitfile(const char *path);
  87
  88 #define SUBMODULE_REMOVAL_DIE_ON_ERROR (1<<0)
  89 #define SUBMODULE_REMOVAL_IGNORE_UNTRACKED (1<<1)
  90 #define SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED (1<<2)
  91 int bad_to_remove_submodule(const char *path, unsigned flags);
  92
  93 int add_submodule_odb(const char *path);
  94
  95 /*
  96  * Checks if there are submodule changes in a..b. If a is the null OID,
  97  * checks b and all its ancestors instead.
  98  */
  99 int submodule_touches_in_range(struct object_id *a,
 100                                struct object_id *b);
 101 int find_unpushed_submodules(struct oid_array *commits,
 102                              const char *remotes_name,
 103                              struct string_list *needs_pushing);
 104 struct refspec;
 105 int push_unpushed_submodules(struct oid_array *commits,
 106                              const struct remote *remote,
 107                              const struct refspec *rs,
 108                              const struct string_list *push_options,
 109                              int dry_run);
 110 /*
 111  * Given a submodule path (as in the index), return the repository
 112  * path of that submodule in 'buf'. Return -1 on error or when the
 113  * submodule is not initialized.
 114  */
 115 int submodule_to_gitdir(struct strbuf *buf, const char *submodule);
 116
 117 #define SUBMODULE_MOVE_HEAD_DRY_RUN (1<<0)
 118 #define SUBMODULE_MOVE_HEAD_FORCE   (1<<1)
 119 int submodule_move_head(const char *path,
 120                         const char *old,
 121                         const char *new_head,
 122                         unsigned flags);
 123
 124 void submodule_unset_core_worktree(const struct submodule *sub);
 125
 126 /*
 127  * Prepare the "env_array" parameter of a "struct child_process" for executing
 128  * a submodule by clearing any repo-specific environment variables, but
 129  * retaining any config in the environment.
 130  */
 131 void prepare_submodule_repo_env(struct argv_array *out);
 132
 133 #define ABSORB_GITDIR_RECURSE_SUBMODULES (1<<0)
 134 void absorb_git_dir_into_superproject(const char *prefix,
 135                                       const char *path,
 136                                       unsigned flags);
 137
 138 /*
 139  * Return the absolute path of the working tree of the superproject, which this
 140  * project is a submodule of. If this repository is not a submodule of
 141  * another repository, return NULL.
 142  */
 143 const char *get_superproject_working_tree(void);
 144
 145 #endif