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 extern int is_gitmodules_unmerged(const struct index_state *istate);
  37 extern int is_staging_gitmodules_ok(const struct index_state *istate);
  38 extern int update_path_in_gitmodules(const char *oldpath, const char *newpath);
  39 extern int remove_path_from_gitmodules(const char *path);
  40 extern void stage_updated_gitmodules(void);
  41 extern void set_diffopt_flags_from_submodule_config(struct diff_options *,
  42                 const char *path);
  43 extern 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 void load_submodule_cache(void);
  49 extern void gitmodules_config(void);
  50 extern int is_submodule_active(struct repository *repo, const char *path);
  51 /*
  52  * Determine if a submodule has been populated at a given 'path' by checking if
  53  * the <path>/.git resolves to a valid git repository.
  54  * If return_error_code is NULL, die on error.
  55  * Otherwise the return error code is the same as of resolve_gitdir_gently.
  56  */
  57 extern int is_submodule_populated_gently(const char *path, int *return_error_code);
  58 extern void die_in_unpopulated_submodule(const struct index_state *istate,
  59                                          const char *prefix);
  60 extern void die_path_inside_submodule(const struct index_state *istate,
  61                                       const struct pathspec *ps);
  62 extern enum submodule_update_type parse_submodule_update_type(const char *value);
  63 extern int parse_submodule_update_strategy(const char *value,
  64                 struct submodule_update_strategy *dst);
  65 extern const char *submodule_strategy_to_string(const struct submodule_update_strategy *s);
  66 extern void handle_ignore_submodules_arg(struct diff_options *, const char *);
  67 extern void show_submodule_summary(FILE *f, const char *path,
  68                 const char *line_prefix,
  69                 struct object_id *one, struct object_id *two,
  70                 unsigned dirty_submodule, const char *meta,
  71                 const char *del, const char *add, const char *reset);
  72 extern void show_submodule_inline_diff(FILE *f, const char *path,
  73                 const char *line_prefix,
  74                 struct object_id *one, struct object_id *two,
  75                 unsigned dirty_submodule, const char *meta,
  76                 const char *del, const char *add, const char *reset,
  77                 const struct diff_options *opt);
  78 /* Check if we want to update any submodule.*/
  79 extern 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 extern const struct submodule *submodule_from_ce(const struct cache_entry *ce);
  85 extern void check_for_new_submodule_commits(struct object_id *oid);
  86 extern int fetch_populated_submodules(const struct argv_array *options,
  87                                const char *prefix, int command_line_option,
  88                                int default_option,
  89                                int quiet, int max_parallel_jobs);
  90 extern unsigned is_submodule_modified(const char *path, int ignore_untracked);
  91 extern int submodule_uses_gitfile(const char *path);
  92
  93 #define SUBMODULE_REMOVAL_DIE_ON_ERROR (1<<0)
  94 #define SUBMODULE_REMOVAL_IGNORE_UNTRACKED (1<<1)
  95 #define SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED (1<<2)
  96 extern int bad_to_remove_submodule(const char *path, unsigned flags);
  97 extern int merge_submodule(struct object_id *result, const char *path,
  98                            const struct object_id *base,
  99                            const struct object_id *a,
 100                            const struct object_id *b, int search);
 101
 102 /* Checks if there are submodule changes in a..b. */
 103 extern int submodule_touches_in_range(struct object_id *a,
 104                                       struct object_id *b);
 105 extern int find_unpushed_submodules(struct oid_array *commits,
 106                                     const char *remotes_name,
 107                                     struct string_list *needs_pushing);
 108 extern int push_unpushed_submodules(struct oid_array *commits,
 109                                     const struct remote *remote,
 110                                     const char **refspec, int refspec_nr,
 111                                     const struct string_list *push_options,
 112                                     int dry_run);
 113 extern void connect_work_tree_and_git_dir(const char *work_tree, const char *git_dir);
 114 /*
 115  * Given a submodule path (as in the index), return the repository
 116  * path of that submodule in 'buf'. Return -1 on error or when the
 117  * submodule is not initialized.
 118  */
 119 int submodule_to_gitdir(struct strbuf *buf, const char *submodule);
 120
 121 #define SUBMODULE_MOVE_HEAD_DRY_RUN (1<<0)
 122 #define SUBMODULE_MOVE_HEAD_FORCE   (1<<1)
 123 extern int submodule_move_head(const char *path,
 124                                const char *old,
 125                                const char *new,
 126                                unsigned flags);
 127
 128 /*
 129  * Prepare the "env_array" parameter of a "struct child_process" for executing
 130  * a submodule by clearing any repo-specific envirionment variables, but
 131  * retaining any config in the environment.
 132  */
 133 extern void prepare_submodule_repo_env(struct argv_array *out);
 134
 135 #define ABSORB_GITDIR_RECURSE_SUBMODULES (1<<0)
 136 extern void absorb_git_dir_into_superproject(const char *prefix,
 137                                              const char *path,
 138                                              unsigned flags);
 139
 140 /*
 141  * Return the absolute path of the working tree of the superproject, which this
 142  * project is a submodule of. If this repository is not a submodule of
 143  * another repository, return NULL.
 144  */
 145 extern const char *get_superproject_working_tree(void);
 146
 147 #endif