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