submodules doc: update documentation for "." used for submodule branches
[alt-git.git] / submodule.h
blob2af9390998194c7d51a3e23b14723574d6696926
1 #ifndef SUBMODULE_H
2 #define SUBMODULE_H
4 struct diff_options;
5 struct argv_array;
7 enum {
8 RECURSE_SUBMODULES_CHECK = -4,
9 RECURSE_SUBMODULES_ERROR = -3,
10 RECURSE_SUBMODULES_NONE = -2,
11 RECURSE_SUBMODULES_ON_DEMAND = -1,
12 RECURSE_SUBMODULES_OFF = 0,
13 RECURSE_SUBMODULES_DEFAULT = 1,
14 RECURSE_SUBMODULES_ON = 2
17 enum submodule_update_type {
18 SM_UPDATE_UNSPECIFIED = 0,
19 SM_UPDATE_CHECKOUT,
20 SM_UPDATE_REBASE,
21 SM_UPDATE_MERGE,
22 SM_UPDATE_NONE,
23 SM_UPDATE_COMMAND
26 struct submodule_update_strategy {
27 enum submodule_update_type type;
28 const char *command;
30 #define SUBMODULE_UPDATE_STRATEGY_INIT {SM_UPDATE_UNSPECIFIED, NULL}
32 int is_staging_gitmodules_ok(void);
33 int update_path_in_gitmodules(const char *oldpath, const char *newpath);
34 int remove_path_from_gitmodules(const char *path);
35 void stage_updated_gitmodules(void);
36 void set_diffopt_flags_from_submodule_config(struct diff_options *diffopt,
37 const char *path);
38 int submodule_config(const char *var, const char *value, void *cb);
39 void gitmodules_config(void);
40 int parse_submodule_update_strategy(const char *value,
41 struct submodule_update_strategy *dst);
42 const char *submodule_strategy_to_string(const struct submodule_update_strategy *s);
43 void handle_ignore_submodules_arg(struct diff_options *diffopt, const char *);
44 void show_submodule_summary(FILE *f, const char *path,
45 const char *line_prefix,
46 unsigned char one[20], unsigned char two[20],
47 unsigned dirty_submodule, const char *meta,
48 const char *del, const char *add, const char *reset);
49 void set_config_fetch_recurse_submodules(int value);
50 void check_for_new_submodule_commits(unsigned char new_sha1[20]);
51 int fetch_populated_submodules(const struct argv_array *options,
52 const char *prefix, int command_line_option,
53 int quiet, int max_parallel_jobs);
54 unsigned is_submodule_modified(const char *path, int ignore_untracked);
55 int submodule_uses_gitfile(const char *path);
56 int ok_to_remove_submodule(const char *path);
57 int merge_submodule(unsigned char result[20], const char *path, const unsigned char base[20],
58 const unsigned char a[20], const unsigned char b[20], int search);
59 int find_unpushed_submodules(unsigned char new_sha1[20], const char *remotes_name,
60 struct string_list *needs_pushing);
61 int push_unpushed_submodules(unsigned char new_sha1[20], const char *remotes_name);
62 void connect_work_tree_and_git_dir(const char *work_tree, const char *git_dir);
63 int parallel_submodules(void);
66 * Prepare the "env_array" parameter of a "struct child_process" for executing
67 * a submodule by clearing any repo-specific envirionment variables, but
68 * retaining any config in the environment.
70 void prepare_submodule_repo_env(struct argv_array *out);
72 #endif