Andrew's git - gitweb.git/blob

   1#ifndef SUBMODULE_H
   2#define SUBMODULE_H
   3
   4struct diff_options;
   5struct argv_array;
   6struct oid_array;
   7struct remote;
   8
   9enum {
  10        RECURSE_SUBMODULES_ONLY = -5,
  11        RECURSE_SUBMODULES_CHECK = -4,
  12        RECURSE_SUBMODULES_ERROR = -3,
  13        RECURSE_SUBMODULES_NONE = -2,
  14        RECURSE_SUBMODULES_ON_DEMAND = -1,
  15        RECURSE_SUBMODULES_OFF = 0,
  16        RECURSE_SUBMODULES_DEFAULT = 1,
  17        RECURSE_SUBMODULES_ON = 2
  18};
  19
  20enum submodule_update_type {
  21        SM_UPDATE_UNSPECIFIED = 0,
  22        SM_UPDATE_CHECKOUT,
  23        SM_UPDATE_REBASE,
  24        SM_UPDATE_MERGE,
  25        SM_UPDATE_NONE,
  26        SM_UPDATE_COMMAND
  27};
  28
  29struct submodule_update_strategy {
  30        enum submodule_update_type type;
  31        const char *command;
  32};
  33#define SUBMODULE_UPDATE_STRATEGY_INIT {SM_UPDATE_UNSPECIFIED, NULL}
  34
  35extern int is_staging_gitmodules_ok(void);
  36extern int update_path_in_gitmodules(const char *oldpath, const char *newpath);
  37extern int remove_path_from_gitmodules(const char *path);
  38extern void stage_updated_gitmodules(void);
  39extern void set_diffopt_flags_from_submodule_config(struct diff_options *,
  40                const char *path);
  41extern int submodule_config(const char *var, const char *value, void *cb);
  42extern int git_default_submodule_config(const char *var, const char *value, void *cb);
  43
  44struct option;
  45int option_parse_recurse_submodules_worktree_updater(const struct option *opt,
  46                                                     const char *arg, int unset);
  47void load_submodule_cache(void);
  48extern void gitmodules_config(void);
  49extern void gitmodules_config_sha1(const unsigned char *commit_sha1);
  50extern int is_submodule_initialized(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 */
  57extern int is_submodule_populated_gently(const char *path, int *return_error_code);
  58extern int parse_submodule_update_strategy(const char *value,
  59                struct submodule_update_strategy *dst);
  60extern const char *submodule_strategy_to_string(const struct submodule_update_strategy *s);
  61extern void handle_ignore_submodules_arg(struct diff_options *, const char *);
  62extern void show_submodule_summary(FILE *f, const char *path,
  63                const char *line_prefix,
  64                struct object_id *one, struct object_id *two,
  65                unsigned dirty_submodule, const char *meta,
  66                const char *del, const char *add, const char *reset);
  67extern void show_submodule_inline_diff(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                const struct diff_options *opt);
  73extern void set_config_fetch_recurse_submodules(int value);
  74/* Check if we want to update any submodule.*/
  75extern int should_update_submodules(void);
  76/*
  77 * Returns the submodule struct if the given ce entry is a submodule
  78 * and it should be updated. Returns NULL otherwise.
  79 */
  80extern const struct submodule *submodule_from_ce(const struct cache_entry *ce);
  81extern void check_for_new_submodule_commits(struct object_id *oid);
  82extern int fetch_populated_submodules(const struct argv_array *options,
  83                               const char *prefix, int command_line_option,
  84                               int quiet, int max_parallel_jobs);
  85extern unsigned is_submodule_modified(const char *path, int ignore_untracked);
  86extern 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)
  91extern int bad_to_remove_submodule(const char *path, unsigned flags);
  92extern int merge_submodule(unsigned char result[20], const char *path,
  93                           const unsigned char base[20],
  94                           const unsigned char a[20],
  95                           const unsigned char b[20], int search);
  96extern int find_unpushed_submodules(struct oid_array *commits,
  97                                    const char *remotes_name,
  98                                    struct string_list *needs_pushing);
  99extern int push_unpushed_submodules(struct oid_array *commits,
 100                                    const struct remote *remote,
 101                                    const char **refspec, int refspec_nr,
 102                                    const struct string_list *push_options,
 103                                    int dry_run);
 104extern void connect_work_tree_and_git_dir(const char *work_tree, const char *git_dir);
 105extern int parallel_submodules(void);
 106/*
 107 * Given a submodule path (as in the index), return the repository
 108 * path of that submodule in 'buf'. Return -1 on error or when the
 109 * submodule is not initialized.
 110 */
 111int submodule_to_gitdir(struct strbuf *buf, const char *submodule);
 112
 113#define SUBMODULE_MOVE_HEAD_DRY_RUN (1<<0)
 114#define SUBMODULE_MOVE_HEAD_FORCE   (1<<1)
 115extern int submodule_move_head(const char *path,
 116                               const char *old,
 117                               const char *new,
 118                               unsigned flags);
 119
 120/*
 121 * Prepare the "env_array" parameter of a "struct child_process" for executing
 122 * a submodule by clearing any repo-specific envirionment variables, but
 123 * retaining any config in the environment.
 124 */
 125extern void prepare_submodule_repo_env(struct argv_array *out);
 126
 127#define ABSORB_GITDIR_RECURSE_SUBMODULES (1<<0)
 128extern void absorb_git_dir_into_superproject(const char *prefix,
 129                                             const char *path,
 130                                             unsigned flags);
 131
 132/*
 133 * Return the absolute path of the working tree of the superproject, which this
 134 * project is a submodule of. If this repository is not a submodule of
 135 * another repository, return NULL.
 136 */
 137extern const char *get_superproject_working_tree(void);
 138
 139#endif