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 int is_staging_gitmodules_ok(void);
  34 int update_path_in_gitmodules(const char *oldpath, const char *newpath);
  35 int remove_path_from_gitmodules(const char *path);
  36 void stage_updated_gitmodules(void);
  37 void set_diffopt_flags_from_submodule_config(struct diff_options *diffopt,
  38                 const char *path);
  39 int submodule_config(const char *var, const char *value, void *cb);
  40 void gitmodules_config(void);
  41 int parse_submodule_update_strategy(const char *value,
  42                 struct submodule_update_strategy *dst);
  43 const char *submodule_strategy_to_string(const struct submodule_update_strategy *s);
  44 void handle_ignore_submodules_arg(struct diff_options *diffopt, const char *);
  45 void show_submodule_summary(FILE *f, const char *path,
  46                 const char *line_prefix,
  47                 struct object_id *one, struct object_id *two,
  48                 unsigned dirty_submodule, const char *meta,
  49                 const char *del, const char *add, const char *reset);
  50 void show_submodule_inline_diff(FILE *f, const char *path,
  51                 const char *line_prefix,
  52                 struct object_id *one, struct object_id *two,
  53                 unsigned dirty_submodule, const char *meta,
  54                 const char *del, const char *add, const char *reset,
  55                 const struct diff_options *opt);
  56 void set_config_fetch_recurse_submodules(int value);
  57 void check_for_new_submodule_commits(unsigned char new_sha1[20]);
  58 int fetch_populated_submodules(const struct argv_array *options,
  59                                const char *prefix, int command_line_option,
  60                                int quiet, int max_parallel_jobs);
  61 unsigned is_submodule_modified(const char *path, int ignore_untracked);
  62 int submodule_uses_gitfile(const char *path);
  63 int ok_to_remove_submodule(const char *path);
  64 int merge_submodule(unsigned char result[20], const char *path, const unsigned char base[20],
  65                     const unsigned char a[20], const unsigned char b[20], int search);
  66 int find_unpushed_submodules(struct sha1_array *commits, const char *remotes_name,
  67                 struct string_list *needs_pushing);
  68 int push_unpushed_submodules(struct sha1_array *commits, const char *remotes_name);
  69 void connect_work_tree_and_git_dir(const char *work_tree, const char *git_dir);
  70 int parallel_submodules(void);
  71
  72 /*
  73  * Prepare the "env_array" parameter of a "struct child_process" for executing
  74  * a submodule by clearing any repo-specific envirionment variables, but
  75  * retaining any config in the environment.
  76  */
  77 void prepare_submodule_repo_env(struct argv_array *out);
  78
  79 #endif