submodule.h

   1 #ifndef SUBMODULE_H
   2 #define SUBMODULE_H
   3
   4 struct diff_options;
   5 struct argv_array;
   6 struct sha1_array;
   7
   8 enum {
   9         RECURSE_SUBMODULES_CHECK = -4,
  10         RECURSE_SUBMODULES_ERROR = -3,
  11         RECURSE_SUBMODULES_NONE = -2,
  12         RECURSE_SUBMODULES_ON_DEMAND = -1,
  13         RECURSE_SUBMODULES_OFF = 0,
  14         RECURSE_SUBMODULES_DEFAULT = 1,
  15         RECURSE_SUBMODULES_ON = 2
  16 };
  17
  18 enum submodule_update_type {
  19         SM_UPDATE_UNSPECIFIED = 0,
  20         SM_UPDATE_CHECKOUT,
  21         SM_UPDATE_REBASE,
  22         SM_UPDATE_MERGE,
  23         SM_UPDATE_NONE,
  24         SM_UPDATE_COMMAND
  25 };
  26
  27 struct submodule_update_strategy {
  28         enum submodule_update_type type;
  29         const char *command;
  30 };
  31 #define SUBMODULE_UPDATE_STRATEGY_INIT {SM_UPDATE_UNSPECIFIED, NULL}
  32
  33 extern int is_staging_gitmodules_ok(void);
  34 extern int update_path_in_gitmodules(const char *oldpath, const char *newpath);
  35 extern int remove_path_from_gitmodules(const char *path);
  36 extern void stage_updated_gitmodules(void);
  37 extern void set_diffopt_flags_from_submodule_config(struct diff_options *,
  38                 const char *path);
  39 extern int submodule_config(const char *var, const char *value, void *cb);
  40 extern void gitmodules_config(void);
  41 extern void gitmodules_config_sha1(const unsigned char *commit_sha1);
  42 extern int is_submodule_initialized(const char *path);
  43 extern int is_submodule_populated(const char *path);
  44 extern int parse_submodule_update_strategy(const char *value,
  45                 struct submodule_update_strategy *dst);
  46 extern const char *submodule_strategy_to_string(const struct submodule_update_strategy *s);
  47 extern void handle_ignore_submodules_arg(struct diff_options *, const char *);
  48 extern void show_submodule_summary(FILE *f, const char *path,
  49                 const char *line_prefix,
  50                 struct object_id *one, struct object_id *two,
  51                 unsigned dirty_submodule, const char *meta,
  52                 const char *del, const char *add, const char *reset);
  53 extern void show_submodule_inline_diff(FILE *f, const char *path,
  54                 const char *line_prefix,
  55                 struct object_id *one, struct object_id *two,
  56                 unsigned dirty_submodule, const char *meta,
  57                 const char *del, const char *add, const char *reset,
  58                 const struct diff_options *opt);
  59 extern void set_config_fetch_recurse_submodules(int value);
  60 extern void check_for_new_submodule_commits(unsigned char new_sha1[20]);
  61 extern int fetch_populated_submodules(const struct argv_array *options,
  62                                const char *prefix, int command_line_option,
  63                                int quiet, int max_parallel_jobs);
  64 extern unsigned is_submodule_modified(const char *path, int ignore_untracked);
  65 extern int submodule_uses_gitfile(const char *path);
  66
  67 #define SUBMODULE_REMOVAL_DIE_ON_ERROR (1<<0)
  68 #define SUBMODULE_REMOVAL_IGNORE_UNTRACKED (1<<1)
  69 #define SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED (1<<2)
  70 extern int bad_to_remove_submodule(const char *path, unsigned flags);
  71 extern int merge_submodule(unsigned char result[20], const char *path,
  72                            const unsigned char base[20],
  73                            const unsigned char a[20],
  74                            const unsigned char b[20], int search);
  75 extern int find_unpushed_submodules(struct sha1_array *commits,
  76                                     const char *remotes_name,
  77                                     struct string_list *needs_pushing);
  78 extern int push_unpushed_submodules(struct sha1_array *commits,
  79                                     const char *remotes_name,
  80                                     int dry_run);
  81 extern void connect_work_tree_and_git_dir(const char *work_tree, const char *git_dir);
  82 extern int parallel_submodules(void);
  83
  84 /*
  85  * Prepare the "env_array" parameter of a "struct child_process" for executing
  86  * a submodule by clearing any repo-specific envirionment variables, but
  87  * retaining any config in the environment.
  88  */
  89 extern void prepare_submodule_repo_env(struct argv_array *out);
  90
  91 #define ABSORB_GITDIR_RECURSE_SUBMODULES (1<<0)
  92 extern void absorb_git_dir_into_superproject(const char *prefix,
  93                                              const char *path,
  94                                              unsigned flags);
  95 #endif