submodule.c: get_super_prefix_or_empty
[git/git.git] / submodule.h
CommitLineData
752c0c24
JS
1#ifndef SUBMODULE_H
2#define SUBMODULE_H
3
46a958b3 4struct diff_options;
50d89ad6 5struct argv_array;
9cfa1c26 6struct sha1_array;
46a958b3 7
88a21979 8enum {
6c656c3f 9 RECURSE_SUBMODULES_ONLY = -5,
b33a15b0 10 RECURSE_SUBMODULES_CHECK = -4,
027771fc 11 RECURSE_SUBMODULES_ERROR = -3,
959b5455 12 RECURSE_SUBMODULES_NONE = -2,
88a21979
JL
13 RECURSE_SUBMODULES_ON_DEMAND = -1,
14 RECURSE_SUBMODULES_OFF = 0,
15 RECURSE_SUBMODULES_DEFAULT = 1,
16 RECURSE_SUBMODULES_ON = 2
17};
18
ea2fa5a3
SB
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};
a028a193 32#define SUBMODULE_UPDATE_STRATEGY_INIT {SM_UPDATE_UNSPECIFIED, NULL}
ea2fa5a3 33
bd267561
SB
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 *,
aee9c7d6 39 const char *path);
bd267561
SB
40extern int submodule_config(const char *var, const char *value, void *cb);
41extern void gitmodules_config(void);
9ebf689a 42extern void gitmodules_config_sha1(const unsigned char *commit_sha1);
f9f42560 43extern int is_submodule_initialized(const char *path);
15cdc647
SB
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);
bd267561 51extern int parse_submodule_update_strategy(const char *value,
ea2fa5a3 52 struct submodule_update_strategy *dst);
bd267561
SB
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,
0f33a067 56 const char *line_prefix,
602a283a 57 struct object_id *one, struct object_id *two,
4e215131 58 unsigned dirty_submodule, const char *meta,
752c0c24 59 const char *del, const char *add, const char *reset);
bd267561 60extern void show_submodule_inline_diff(FILE *f, const char *path,
fd47ae6a
JK
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);
bd267561 66extern void set_config_fetch_recurse_submodules(int value);
cf055e46 67extern void set_config_update_recurse_submodules(int value);
84f8925e
SB
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);
bd267561
SB
75extern void check_for_new_submodule_commits(unsigned char new_sha1[20]);
76extern int fetch_populated_submodules(const struct argv_array *options,
8f0700dd 77 const char *prefix, int command_line_option,
62104ba1 78 int quiet, int max_parallel_jobs);
bd267561
SB
79extern unsigned is_submodule_modified(const char *path, int ignore_untracked);
80extern int submodule_uses_gitfile(const char *path);
83b76966
SB
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);
bd267561
SB
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);
3ccd681c 90extern int find_unpushed_submodules(struct sha1_array *commits,
bd267561
SB
91 const char *remotes_name,
92 struct string_list *needs_pushing);
0301c821
BW
93extern int push_unpushed_submodules(struct sha1_array *commits,
94 const char *remotes_name,
95 int dry_run);
bd267561
SB
96extern void connect_work_tree_and_git_dir(const char *work_tree, const char *git_dir);
97extern int parallel_submodules(void);
752c0c24 98
4638728c
JK
99/*
100 * Prepare the "env_array" parameter of a "struct child_process" for executing
101 * a submodule by clearing any repo-specific envirionment variables, but
89044baa 102 * retaining any config in the environment.
4638728c 103 */
bd267561 104extern void prepare_submodule_repo_env(struct argv_array *out);
4638728c 105
f6f85861
SB
106#define ABSORB_GITDIR_RECURSE_SUBMODULES (1<<0)
107extern void absorb_git_dir_into_superproject(const char *prefix,
108 const char *path,
109 unsigned flags);
752c0c24 110#endif