doc: MyFirstContribution: fix cmd placement instructions
[git/git.git] / submodule.h
CommitLineData
752c0c24
JS
1#ifndef SUBMODULE_H
2#define SUBMODULE_H
3
50d89ad6 4struct argv_array;
ef3ca954
EN
5struct cache_entry;
6struct diff_options;
7struct index_state;
8struct object_id;
910650d2 9struct oid_array;
ef3ca954 10struct pathspec;
06bf4ad1 11struct remote;
ef3ca954
EN
12struct repository;
13struct string_list;
14struct strbuf;
46a958b3 15
88a21979 16enum {
6c656c3f 17 RECURSE_SUBMODULES_ONLY = -5,
b33a15b0 18 RECURSE_SUBMODULES_CHECK = -4,
027771fc 19 RECURSE_SUBMODULES_ERROR = -3,
959b5455 20 RECURSE_SUBMODULES_NONE = -2,
88a21979
JL
21 RECURSE_SUBMODULES_ON_DEMAND = -1,
22 RECURSE_SUBMODULES_OFF = 0,
23 RECURSE_SUBMODULES_DEFAULT = 1,
24 RECURSE_SUBMODULES_ON = 2
25};
26
ea2fa5a3
SB
27enum submodule_update_type {
28 SM_UPDATE_UNSPECIFIED = 0,
29 SM_UPDATE_CHECKOUT,
30 SM_UPDATE_REBASE,
31 SM_UPDATE_MERGE,
32 SM_UPDATE_NONE,
33 SM_UPDATE_COMMAND
34};
35
36struct submodule_update_strategy {
37 enum submodule_update_type type;
38 const char *command;
39};
a028a193 40#define SUBMODULE_UPDATE_STRATEGY_INIT {SM_UPDATE_UNSPECIFIED, NULL}
ea2fa5a3 41
4dcd706f 42int is_gitmodules_unmerged(const struct index_state *istate);
b5c259f2 43int is_writing_gitmodules_ok(void);
4dcd706f
NTND
44int is_staging_gitmodules_ok(struct index_state *istate);
45int update_path_in_gitmodules(const char *oldpath, const char *newpath);
46int remove_path_from_gitmodules(const char *path);
47void stage_updated_gitmodules(struct index_state *istate);
48void set_diffopt_flags_from_submodule_config(struct diff_options *,
49 const char *path);
50int git_default_submodule_config(const char *var, const char *value, void *cb);
d7a3803f
SB
51
52struct option;
53int option_parse_recurse_submodules_worktree_updater(const struct option *opt,
54 const char *arg, int unset);
4dcd706f 55int is_submodule_active(struct repository *repo, const char *path);
15cdc647
SB
56/*
57 * Determine if a submodule has been populated at a given 'path' by checking if
58 * the <path>/.git resolves to a valid git repository.
59 * If return_error_code is NULL, die on error.
60 * Otherwise the return error code is the same as of resolve_gitdir_gently.
61 */
4dcd706f
NTND
62int is_submodule_populated_gently(const char *path, int *return_error_code);
63void die_in_unpopulated_submodule(const struct index_state *istate,
64 const char *prefix);
65void die_path_inside_submodule(const struct index_state *istate,
66 const struct pathspec *ps);
67enum submodule_update_type parse_submodule_update_type(const char *value);
68int parse_submodule_update_strategy(const char *value,
69 struct submodule_update_strategy *dst);
70const char *submodule_strategy_to_string(const struct submodule_update_strategy *s);
71void handle_ignore_submodules_arg(struct diff_options *, const char *);
72void show_submodule_summary(struct diff_options *o, const char *path,
73 struct object_id *one, struct object_id *two,
74 unsigned dirty_submodule);
75void show_submodule_inline_diff(struct diff_options *o, const char *path,
76 struct object_id *one, struct object_id *two,
77 unsigned dirty_submodule);
84f8925e 78/* Check if we want to update any submodule.*/
4dcd706f 79int should_update_submodules(void);
84f8925e
SB
80/*
81 * Returns the submodule struct if the given ce entry is a submodule
82 * and it should be updated. Returns NULL otherwise.
83 */
4dcd706f
NTND
84const struct submodule *submodule_from_ce(const struct cache_entry *ce);
85void check_for_new_submodule_commits(struct object_id *oid);
86int fetch_populated_submodules(struct repository *r,
87 const struct argv_array *options,
88 const char *prefix,
89 int command_line_option,
90 int default_option,
91 int quiet, int max_parallel_jobs);
92unsigned is_submodule_modified(const char *path, int ignore_untracked);
93int submodule_uses_gitfile(const char *path);
83b76966
SB
94
95#define SUBMODULE_REMOVAL_DIE_ON_ERROR (1<<0)
96#define SUBMODULE_REMOVAL_IGNORE_UNTRACKED (1<<1)
97#define SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED (1<<2)
4dcd706f 98int bad_to_remove_submodule(const char *path, unsigned flags);
18cfc088
SB
99
100int add_submodule_odb(const char *path);
a6d7eb2c 101
4d36f88b
JT
102/*
103 * Checks if there are submodule changes in a..b. If a is the null OID,
104 * checks b and all its ancestors instead.
105 */
6245b98b 106int submodule_touches_in_range(struct repository *r,
174d131f 107 struct object_id *a,
4dcd706f 108 struct object_id *b);
6245b98b 109int find_unpushed_submodules(struct repository *r,
174d131f 110 struct oid_array *commits,
4dcd706f
NTND
111 const char *remotes_name,
112 struct string_list *needs_pushing);
60fba4bf 113struct refspec;
6245b98b 114int push_unpushed_submodules(struct repository *r,
174d131f 115 struct oid_array *commits,
4dcd706f
NTND
116 const struct remote *remote,
117 const struct refspec *rs,
118 const struct string_list *push_options,
119 int dry_run);
bbbb7de7
NTND
120/*
121 * Given a submodule path (as in the index), return the repository
122 * path of that submodule in 'buf'. Return -1 on error or when the
123 * submodule is not initialized.
124 */
125int submodule_to_gitdir(struct strbuf *buf, const char *submodule);
752c0c24 126
6e3c1595
SB
127#define SUBMODULE_MOVE_HEAD_DRY_RUN (1<<0)
128#define SUBMODULE_MOVE_HEAD_FORCE (1<<1)
4dcd706f
NTND
129int submodule_move_head(const char *path,
130 const char *old,
131 const char *new_head,
132 unsigned flags);
6e3c1595 133
898c2e65
SB
134void submodule_unset_core_worktree(const struct submodule *sub);
135
4638728c
JK
136/*
137 * Prepare the "env_array" parameter of a "struct child_process" for executing
217bb56d 138 * a submodule by clearing any repo-specific environment variables, but
89044baa 139 * retaining any config in the environment.
4638728c 140 */
4dcd706f 141void prepare_submodule_repo_env(struct argv_array *out);
4638728c 142
f6f85861 143#define ABSORB_GITDIR_RECURSE_SUBMODULES (1<<0)
cf7a901a 144void absorb_git_dir_into_superproject(const char *path,
4dcd706f 145 unsigned flags);
bf0231c6
SB
146
147/*
148 * Return the absolute path of the working tree of the superproject, which this
149 * project is a submodule of. If this repository is not a submodule of
150 * another repository, return NULL.
151 */
4dcd706f 152const char *get_superproject_working_tree(void);
bf0231c6 153
752c0c24 154#endif