Andrew's git - gitweb.git/blob

   1#ifndef SUBMODULE_H
   2#define SUBMODULE_H
   3
   4struct diff_options;
   5struct argv_array;
   6struct sha1_array;
   7
   8enum {
   9        RECURSE_SUBMODULES_ONLY = -5,
  10        RECURSE_SUBMODULES_CHECK = -4,
  11        RECURSE_SUBMODULES_ERROR = -3,
  12        RECURSE_SUBMODULES_NONE = -2,
  13        RECURSE_SUBMODULES_ON_DEMAND = -1,
  14        RECURSE_SUBMODULES_OFF = 0,
  15        RECURSE_SUBMODULES_DEFAULT = 1,
  16        RECURSE_SUBMODULES_ON = 2
  17};
  18
  19enum submodule_update_type {
  20        SM_UPDATE_UNSPECIFIED = 0,
  21        SM_UPDATE_CHECKOUT,
  22        SM_UPDATE_REBASE,
  23        SM_UPDATE_MERGE,
  24        SM_UPDATE_NONE,
  25        SM_UPDATE_COMMAND
  26};
  27
  28struct submodule_update_strategy {
  29        enum submodule_update_type type;
  30        const char *command;
  31};
  32#define SUBMODULE_UPDATE_STRATEGY_INIT {SM_UPDATE_UNSPECIFIED, NULL}
  33
  34extern int is_staging_gitmodules_ok(void);
  35extern int update_path_in_gitmodules(const char *oldpath, const char *newpath);
  36extern int remove_path_from_gitmodules(const char *path);
  37extern void stage_updated_gitmodules(void);
  38extern void set_diffopt_flags_from_submodule_config(struct diff_options *,
  39                const char *path);
  40extern int submodule_config(const char *var, const char *value, void *cb);
  41extern void gitmodules_config(void);
  42extern void gitmodules_config_sha1(const unsigned char *commit_sha1);
  43extern int is_submodule_initialized(const char *path);
  44/*
  45 * Determine if a submodule has been populated at a given 'path' by checking if
  46 * the <path>/.git resolves to a valid git repository.
  47 * If return_error_code is NULL, die on error.
  48 * Otherwise the return error code is the same as of resolve_gitdir_gently.
  49 */
  50extern int is_submodule_populated_gently(const char *path, int *return_error_code);
  51extern int parse_submodule_update_strategy(const char *value,
  52                struct submodule_update_strategy *dst);
  53extern const char *submodule_strategy_to_string(const struct submodule_update_strategy *s);
  54extern void handle_ignore_submodules_arg(struct diff_options *, const char *);
  55extern void show_submodule_summary(FILE *f, const char *path,
  56                const char *line_prefix,
  57                struct object_id *one, struct object_id *two,
  58                unsigned dirty_submodule, const char *meta,
  59                const char *del, const char *add, const char *reset);
  60extern void show_submodule_inline_diff(FILE *f, const char *path,
  61                const char *line_prefix,
  62                struct object_id *one, struct object_id *two,
  63                unsigned dirty_submodule, const char *meta,
  64                const char *del, const char *add, const char *reset,
  65                const struct diff_options *opt);
  66extern void set_config_fetch_recurse_submodules(int value);
  67extern void set_config_update_recurse_submodules(int value);
  68/* Check if we want to update any submodule.*/
  69extern int should_update_submodules(void);
  70/*
  71 * Returns the submodule struct if the given ce entry is a submodule
  72 * and it should be updated. Returns NULL otherwise.
  73 */
  74extern const struct submodule *submodule_from_ce(const struct cache_entry *ce);
  75extern void check_for_new_submodule_commits(unsigned char new_sha1[20]);
  76extern int fetch_populated_submodules(const struct argv_array *options,
  77                               const char *prefix, int command_line_option,
  78                               int quiet, int max_parallel_jobs);
  79extern unsigned is_submodule_modified(const char *path, int ignore_untracked);
  80extern int submodule_uses_gitfile(const char *path);
  81
  82#define SUBMODULE_REMOVAL_DIE_ON_ERROR (1<<0)
  83#define SUBMODULE_REMOVAL_IGNORE_UNTRACKED (1<<1)
  84#define SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED (1<<2)
  85extern int bad_to_remove_submodule(const char *path, unsigned flags);
  86extern int merge_submodule(unsigned char result[20], const char *path,
  87                           const unsigned char base[20],
  88                           const unsigned char a[20],
  89                           const unsigned char b[20], int search);
  90extern int find_unpushed_submodules(struct sha1_array *commits,
  91                                    const char *remotes_name,
  92                                    struct string_list *needs_pushing);
  93extern int push_unpushed_submodules(struct sha1_array *commits,
  94                                    const char *remotes_name,
  95                                    int dry_run);
  96extern void connect_work_tree_and_git_dir(const char *work_tree, const char *git_dir);
  97extern int parallel_submodules(void);
  98
  99#define SUBMODULE_MOVE_HEAD_DRY_RUN (1<<0)
 100#define SUBMODULE_MOVE_HEAD_FORCE   (1<<1)
 101extern int submodule_move_head(const char *path,
 102                               const char *old,
 103                               const char *new,
 104                               unsigned flags);
 105
 106/*
 107 * Prepare the "env_array" parameter of a "struct child_process" for executing
 108 * a submodule by clearing any repo-specific envirionment variables, but
 109 * retaining any config in the environment.
 110 */
 111extern void prepare_submodule_repo_env(struct argv_array *out);
 112
 113#define ABSORB_GITDIR_RECURSE_SUBMODULES (1<<0)
 114extern void absorb_git_dir_into_superproject(const char *prefix,
 115                                             const char *path,
 116                                             unsigned flags);
 117
 118/*
 119 * Return the absolute path of the working tree of the superproject, which this
 120 * project is a submodule of. If this repository is not a submodule of
 121 * another repository, return NULL.
 122 */
 123extern const char *get_superproject_working_tree(void);
 124
 125#endif