l10n: bg.po: Updated Bulgarian translation (5195t)
[git.git] / submodule.h
blob6bd2c99fd99d409abd89771d511b3a7db5f47252
1 #ifndef SUBMODULE_H
2 #define SUBMODULE_H
4 struct strvec;
5 struct cache_entry;
6 struct diff_options;
7 struct index_state;
8 struct object_id;
9 struct oid_array;
10 struct pathspec;
11 struct remote;
12 struct repository;
13 struct string_list;
14 struct strbuf;
16 enum {
17 RECURSE_SUBMODULES_ONLY = -5,
18 RECURSE_SUBMODULES_CHECK = -4,
19 RECURSE_SUBMODULES_ERROR = -3,
20 RECURSE_SUBMODULES_NONE = -2,
21 RECURSE_SUBMODULES_ON_DEMAND = -1,
22 RECURSE_SUBMODULES_OFF = 0,
23 RECURSE_SUBMODULES_DEFAULT = 1,
24 RECURSE_SUBMODULES_ON = 2
27 enum 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
36 struct submodule_update_strategy {
37 enum submodule_update_type type;
38 const char *command;
40 #define SUBMODULE_UPDATE_STRATEGY_INIT { \
41 .type = SM_UPDATE_UNSPECIFIED, \
44 int is_gitmodules_unmerged(struct index_state *istate);
45 int is_writing_gitmodules_ok(void);
46 int is_staging_gitmodules_ok(struct index_state *istate);
47 int update_path_in_gitmodules(const char *oldpath, const char *newpath);
48 int remove_path_from_gitmodules(const char *path);
49 void stage_updated_gitmodules(struct index_state *istate);
50 void set_diffopt_flags_from_submodule_config(struct diff_options *,
51 const char *path);
52 int git_default_submodule_config(const char *var, const char *value, void *cb);
54 struct option;
55 int option_parse_recurse_submodules_worktree_updater(const struct option *opt,
56 const char *arg, int unset);
57 int is_submodule_active(struct repository *repo, const char *path);
59 * Determine if a submodule has been populated at a given 'path' by checking if
60 * the <path>/.git resolves to a valid git repository.
61 * If return_error_code is NULL, die on error.
62 * Otherwise the return error code is the same as of resolve_gitdir_gently.
64 int is_submodule_populated_gently(const char *path, int *return_error_code);
65 void die_in_unpopulated_submodule(struct index_state *istate,
66 const char *prefix);
67 void die_path_inside_submodule(struct index_state *istate,
68 const struct pathspec *ps);
69 enum submodule_update_type parse_submodule_update_type(const char *value);
70 int parse_submodule_update_strategy(const char *value,
71 struct submodule_update_strategy *dst);
72 const char *submodule_strategy_to_string(const struct submodule_update_strategy *s);
73 void handle_ignore_submodules_arg(struct diff_options *, const char *);
74 void show_submodule_diff_summary(struct diff_options *o, const char *path,
75 struct object_id *one, struct object_id *two,
76 unsigned dirty_submodule);
77 void show_submodule_inline_diff(struct diff_options *o, const char *path,
78 struct object_id *one, struct object_id *two,
79 unsigned dirty_submodule);
80 /* Check if we want to update any submodule.*/
81 int should_update_submodules(void);
83 * Returns the submodule struct if the given ce entry is a submodule
84 * and it should be updated. Returns NULL otherwise.
86 const struct submodule *submodule_from_ce(const struct cache_entry *ce);
87 void check_for_new_submodule_commits(struct object_id *oid);
88 int fetch_populated_submodules(struct repository *r,
89 const struct strvec *options,
90 const char *prefix,
91 int command_line_option,
92 int default_option,
93 int quiet, int max_parallel_jobs);
94 unsigned is_submodule_modified(const char *path, int ignore_untracked);
95 int submodule_uses_gitfile(const char *path);
97 #define SUBMODULE_REMOVAL_DIE_ON_ERROR (1<<0)
98 #define SUBMODULE_REMOVAL_IGNORE_UNTRACKED (1<<1)
99 #define SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED (1<<2)
100 int bad_to_remove_submodule(const char *path, unsigned flags);
103 * Call add_submodule_odb() to add the submodule at the given path to a list.
104 * When register_all_submodule_odb_as_alternates() is called, the object stores
105 * of all submodules in that list will be added as alternates in
106 * the_repository.
108 int add_submodule_odb(const char *path);
109 void add_submodule_odb_by_path(const char *path);
110 int register_all_submodule_odb_as_alternates(void);
113 * Checks if there are submodule changes in a..b. If a is the null OID,
114 * checks b and all its ancestors instead.
116 int submodule_touches_in_range(struct repository *r,
117 struct object_id *a,
118 struct object_id *b);
119 int find_unpushed_submodules(struct repository *r,
120 struct oid_array *commits,
121 const char *remotes_name,
122 struct string_list *needs_pushing);
123 struct refspec;
124 int push_unpushed_submodules(struct repository *r,
125 struct oid_array *commits,
126 const struct remote *remote,
127 const struct refspec *rs,
128 const struct string_list *push_options,
129 int dry_run);
131 * Given a submodule path (as in the index), return the repository
132 * path of that submodule in 'buf'. Return -1 on error or when the
133 * submodule is not initialized.
135 int submodule_to_gitdir(struct strbuf *buf, const char *submodule);
138 * Given a submodule name, create a path to where the submodule's gitdir lives
139 * inside of the provided repository's 'modules' directory.
141 void submodule_name_to_gitdir(struct strbuf *buf, struct repository *r,
142 const char *submodule_name);
145 * Make sure that no submodule's git dir is nested in a sibling submodule's.
147 int validate_submodule_git_dir(char *git_dir, const char *submodule_name);
149 #define SUBMODULE_MOVE_HEAD_DRY_RUN (1<<0)
150 #define SUBMODULE_MOVE_HEAD_FORCE (1<<1)
151 int submodule_move_head(const char *path,
152 const char *old,
153 const char *new_head,
154 unsigned flags);
156 void submodule_unset_core_worktree(const struct submodule *sub);
159 * Prepare the "env_array" parameter of a "struct child_process" for executing
160 * a submodule by clearing any repo-specific environment variables, but
161 * retaining any config in the environment.
163 void prepare_submodule_repo_env(struct strvec *out);
165 #define ABSORB_GITDIR_RECURSE_SUBMODULES (1<<0)
166 void absorb_git_dir_into_superproject(const char *path,
167 unsigned flags);
170 * Return the absolute path of the working tree of the superproject, which this
171 * project is a submodule of. If this repository is not a submodule of
172 * another repository, return 0.
174 int get_superproject_working_tree(struct strbuf *buf);
176 #endif