submodule.h 5.38 KB
Newer Older
1 2 3
#ifndef SUBMODULE_H
#define SUBMODULE_H

4
struct argv_array;
5 6 7 8
struct cache_entry;
struct diff_options;
struct index_state;
struct object_id;
9
struct oid_array;
10
struct pathspec;
11
struct remote;
12 13 14
struct repository;
struct string_list;
struct strbuf;
15

16
enum {
17
	RECURSE_SUBMODULES_ONLY = -5,
18
	RECURSE_SUBMODULES_CHECK = -4,
19
	RECURSE_SUBMODULES_ERROR = -3,
20
	RECURSE_SUBMODULES_NONE = -2,
21 22 23 24 25 26
	RECURSE_SUBMODULES_ON_DEMAND = -1,
	RECURSE_SUBMODULES_OFF = 0,
	RECURSE_SUBMODULES_DEFAULT = 1,
	RECURSE_SUBMODULES_ON = 2
};

27 28 29 30 31 32 33 34 35 36 37 38 39
enum submodule_update_type {
	SM_UPDATE_UNSPECIFIED = 0,
	SM_UPDATE_CHECKOUT,
	SM_UPDATE_REBASE,
	SM_UPDATE_MERGE,
	SM_UPDATE_NONE,
	SM_UPDATE_COMMAND
};

struct submodule_update_strategy {
	enum submodule_update_type type;
	const char *command;
};
40
#define SUBMODULE_UPDATE_STRATEGY_INIT {SM_UPDATE_UNSPECIFIED, NULL}
41

42
int is_gitmodules_unmerged(const struct index_state *istate);
43
int is_writing_gitmodules_ok(void);
44 45 46 47 48 49 50
int is_staging_gitmodules_ok(struct index_state *istate);
int update_path_in_gitmodules(const char *oldpath, const char *newpath);
int remove_path_from_gitmodules(const char *path);
void stage_updated_gitmodules(struct index_state *istate);
void set_diffopt_flags_from_submodule_config(struct diff_options *,
					     const char *path);
int git_default_submodule_config(const char *var, const char *value, void *cb);
51 52 53 54

struct option;
int option_parse_recurse_submodules_worktree_updater(const struct option *opt,
						     const char *arg, int unset);
55
int is_submodule_active(struct repository *repo, const char *path);
56 57 58 59 60 61
/*
 * Determine if a submodule has been populated at a given 'path' by checking if
 * the <path>/.git resolves to a valid git repository.
 * If return_error_code is NULL, die on error.
 * Otherwise the return error code is the same as of resolve_gitdir_gently.
 */
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
int is_submodule_populated_gently(const char *path, int *return_error_code);
void die_in_unpopulated_submodule(const struct index_state *istate,
				  const char *prefix);
void die_path_inside_submodule(const struct index_state *istate,
			       const struct pathspec *ps);
enum submodule_update_type parse_submodule_update_type(const char *value);
int parse_submodule_update_strategy(const char *value,
				    struct submodule_update_strategy *dst);
const char *submodule_strategy_to_string(const struct submodule_update_strategy *s);
void handle_ignore_submodules_arg(struct diff_options *, const char *);
void show_submodule_summary(struct diff_options *o, const char *path,
			    struct object_id *one, struct object_id *two,
			    unsigned dirty_submodule);
void show_submodule_inline_diff(struct diff_options *o, const char *path,
				struct object_id *one, struct object_id *two,
				unsigned dirty_submodule);
78
/* Check if we want to update any submodule.*/
79
int should_update_submodules(void);
80 81 82 83
/*
 * Returns the submodule struct if the given ce entry is a submodule
 * and it should be updated. Returns NULL otherwise.
 */
84 85 86 87 88 89 90 91 92 93
const struct submodule *submodule_from_ce(const struct cache_entry *ce);
void check_for_new_submodule_commits(struct object_id *oid);
int fetch_populated_submodules(struct repository *r,
			       const struct argv_array *options,
			       const char *prefix,
			       int command_line_option,
			       int default_option,
			       int quiet, int max_parallel_jobs);
unsigned is_submodule_modified(const char *path, int ignore_untracked);
int submodule_uses_gitfile(const char *path);
94 95 96 97

#define SUBMODULE_REMOVAL_DIE_ON_ERROR (1<<0)
#define SUBMODULE_REMOVAL_IGNORE_UNTRACKED (1<<1)
#define SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED (1<<2)
98
int bad_to_remove_submodule(const char *path, unsigned flags);
99 100

int add_submodule_odb(const char *path);
101

102 103 104 105
/*
 * Checks if there are submodule changes in a..b. If a is the null OID,
 * checks b and all its ancestors instead.
 */
106
int submodule_touches_in_range(struct repository *r,
107
			       struct object_id *a,
108
			       struct object_id *b);
109
int find_unpushed_submodules(struct repository *r,
110
			     struct oid_array *commits,
111 112
			     const char *remotes_name,
			     struct string_list *needs_pushing);
113
struct refspec;
114
int push_unpushed_submodules(struct repository *r,
115
			     struct oid_array *commits,
116 117 118 119
			     const struct remote *remote,
			     const struct refspec *rs,
			     const struct string_list *push_options,
			     int dry_run);
120 121 122 123 124 125
/*
 * Given a submodule path (as in the index), return the repository
 * path of that submodule in 'buf'. Return -1 on error or when the
 * submodule is not initialized.
 */
int submodule_to_gitdir(struct strbuf *buf, const char *submodule);
126

127 128
#define SUBMODULE_MOVE_HEAD_DRY_RUN (1<<0)
#define SUBMODULE_MOVE_HEAD_FORCE   (1<<1)
129 130 131 132
int submodule_move_head(const char *path,
			const char *old,
			const char *new_head,
			unsigned flags);
133

134 135
void submodule_unset_core_worktree(const struct submodule *sub);

136 137
/*
 * Prepare the "env_array" parameter of a "struct child_process" for executing
Han-Wen Nienhuys's avatar
Han-Wen Nienhuys committed
138
 * a submodule by clearing any repo-specific environment variables, but
139
 * retaining any config in the environment.
140
 */
141
void prepare_submodule_repo_env(struct argv_array *out);
142

143
#define ABSORB_GITDIR_RECURSE_SUBMODULES (1<<0)
144 145 146
void absorb_git_dir_into_superproject(const char *prefix,
				      const char *path,
				      unsigned flags);
147 148 149 150 151 152

/*
 * Return the absolute path of the working tree of the superproject, which this
 * project is a submodule of. If this repository is not a submodule of
 * another repository, return NULL.
 */
153
const char *get_superproject_working_tree(void);
154

155
#endif