stash: remove now superfluos help for "stash push"
[git.git] / submodule.h
blobf0da0277a45b49369d89cebdd4d30f44bef23d3d
1 #ifndef SUBMODULE_H
2 #define SUBMODULE_H
4 struct repository;
5 struct diff_options;
6 struct argv_array;
7 struct oid_array;
8 struct remote;
10 enum {
11 RECURSE_SUBMODULES_ONLY = -5,
12 RECURSE_SUBMODULES_CHECK = -4,
13 RECURSE_SUBMODULES_ERROR = -3,
14 RECURSE_SUBMODULES_NONE = -2,
15 RECURSE_SUBMODULES_ON_DEMAND = -1,
16 RECURSE_SUBMODULES_OFF = 0,
17 RECURSE_SUBMODULES_DEFAULT = 1,
18 RECURSE_SUBMODULES_ON = 2
21 enum submodule_update_type {
22 SM_UPDATE_UNSPECIFIED = 0,
23 SM_UPDATE_CHECKOUT,
24 SM_UPDATE_REBASE,
25 SM_UPDATE_MERGE,
26 SM_UPDATE_NONE,
27 SM_UPDATE_COMMAND
30 struct submodule_update_strategy {
31 enum submodule_update_type type;
32 const char *command;
34 #define SUBMODULE_UPDATE_STRATEGY_INIT {SM_UPDATE_UNSPECIFIED, NULL}
36 extern int is_gitmodules_unmerged(const struct index_state *istate);
37 extern int is_staging_gitmodules_ok(const struct index_state *istate);
38 extern int update_path_in_gitmodules(const char *oldpath, const char *newpath);
39 extern int remove_path_from_gitmodules(const char *path);
40 extern void stage_updated_gitmodules(void);
41 extern void set_diffopt_flags_from_submodule_config(struct diff_options *,
42 const char *path);
43 extern int git_default_submodule_config(const char *var, const char *value, void *cb);
45 struct option;
46 int option_parse_recurse_submodules_worktree_updater(const struct option *opt,
47 const char *arg, int unset);
48 extern int is_submodule_active(struct repository *repo, const char *path);
50 * Determine if a submodule has been populated at a given 'path' by checking if
51 * the <path>/.git resolves to a valid git repository.
52 * If return_error_code is NULL, die on error.
53 * Otherwise the return error code is the same as of resolve_gitdir_gently.
55 extern int is_submodule_populated_gently(const char *path, int *return_error_code);
56 extern void die_in_unpopulated_submodule(const struct index_state *istate,
57 const char *prefix);
58 extern void die_path_inside_submodule(const struct index_state *istate,
59 const struct pathspec *ps);
60 extern enum submodule_update_type parse_submodule_update_type(const char *value);
61 extern int parse_submodule_update_strategy(const char *value,
62 struct submodule_update_strategy *dst);
63 extern const char *submodule_strategy_to_string(const struct submodule_update_strategy *s);
64 extern void handle_ignore_submodules_arg(struct diff_options *, const char *);
65 extern void show_submodule_summary(struct diff_options *o, const char *path,
66 struct object_id *one, struct object_id *two,
67 unsigned dirty_submodule);
68 extern void show_submodule_inline_diff(struct diff_options *o, const char *path,
69 struct object_id *one, struct object_id *two,
70 unsigned dirty_submodule);
71 /* Check if we want to update any submodule.*/
72 extern int should_update_submodules(void);
74 * Returns the submodule struct if the given ce entry is a submodule
75 * and it should be updated. Returns NULL otherwise.
77 extern const struct submodule *submodule_from_ce(const struct cache_entry *ce);
78 extern void check_for_new_submodule_commits(struct object_id *oid);
79 extern int fetch_populated_submodules(const struct argv_array *options,
80 const char *prefix, int command_line_option,
81 int default_option,
82 int quiet, int max_parallel_jobs);
83 extern unsigned is_submodule_modified(const char *path, int ignore_untracked);
84 extern int submodule_uses_gitfile(const char *path);
86 #define SUBMODULE_REMOVAL_DIE_ON_ERROR (1<<0)
87 #define SUBMODULE_REMOVAL_IGNORE_UNTRACKED (1<<1)
88 #define SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED (1<<2)
89 extern int bad_to_remove_submodule(const char *path, unsigned flags);
90 extern int merge_submodule(struct object_id *result, const char *path,
91 const struct object_id *base,
92 const struct object_id *a,
93 const struct object_id *b, int search);
95 /* Checks if there are submodule changes in a..b. */
96 extern int submodule_touches_in_range(struct object_id *a,
97 struct object_id *b);
98 extern int find_unpushed_submodules(struct oid_array *commits,
99 const char *remotes_name,
100 struct string_list *needs_pushing);
101 extern int push_unpushed_submodules(struct oid_array *commits,
102 const struct remote *remote,
103 const char **refspec, int refspec_nr,
104 const struct string_list *push_options,
105 int dry_run);
106 extern void connect_work_tree_and_git_dir(const char *work_tree, const char *git_dir);
108 * Given a submodule path (as in the index), return the repository
109 * path of that submodule in 'buf'. Return -1 on error or when the
110 * submodule is not initialized.
112 int submodule_to_gitdir(struct strbuf *buf, const char *submodule);
114 #define SUBMODULE_MOVE_HEAD_DRY_RUN (1<<0)
115 #define SUBMODULE_MOVE_HEAD_FORCE (1<<1)
116 extern int submodule_move_head(const char *path,
117 const char *old,
118 const char *new,
119 unsigned flags);
122 * Prepare the "env_array" parameter of a "struct child_process" for executing
123 * a submodule by clearing any repo-specific environment variables, but
124 * retaining any config in the environment.
126 extern void prepare_submodule_repo_env(struct argv_array *out);
128 #define ABSORB_GITDIR_RECURSE_SUBMODULES (1<<0)
129 extern void absorb_git_dir_into_superproject(const char *prefix,
130 const char *path,
131 unsigned flags);
134 * Return the absolute path of the working tree of the superproject, which this
135 * project is a submodule of. If this repository is not a submodule of
136 * another repository, return NULL.
138 extern const char *get_superproject_working_tree(void);
140 #endif