First batch for 2.19 cycle
[git/git.git] / submodule-config.h
CommitLineData
959b5455
HV
1#ifndef SUBMODULE_CONFIG_CACHE_H
2#define SUBMODULE_CONFIG_CACHE_H
3
34caab02 4#include "cache.h"
959b5455 5#include "hashmap.h"
ea2fa5a3 6#include "submodule.h"
959b5455
HV
7#include "strbuf.h"
8
9/*
10 * Submodule entry containing the information about a certain submodule
11 * in a certain revision.
12 */
13struct submodule {
14 const char *path;
15 const char *name;
16 const char *url;
17 int fetch_recurse;
18 const char *ignore;
b5944f34 19 const char *branch;
ea2fa5a3 20 struct submodule_update_strategy update_strategy;
34caab02 21 /* the object id of the responsible .gitmodules file */
22 struct object_id gitmodules_oid;
37f52e93 23 int recommend_shallow;
959b5455
HV
24};
25
c68f8375 26#define SUBMODULE_INIT { NULL, NULL, NULL, RECURSE_SUBMODULES_NONE, \
34caab02 27 NULL, NULL, SUBMODULE_UPDATE_STRATEGY_INIT, { { 0 } }, -1 };
c68f8375 28
bf12fcdf
BW
29struct submodule_cache;
30struct repository;
31
32extern void submodule_cache_free(struct submodule_cache *cache);
33
f20e7c1e 34extern int parse_submodule_fetchjobs(const char *var, const char *value);
d601fd09 35extern int parse_fetch_recurse_submodules_arg(const char *opt, const char *arg);
886dc154
SB
36struct option;
37extern int option_fetch_parse_recurse_submodules(const struct option *opt,
38 const char *arg, int unset);
d601fd09
SB
39extern int parse_update_recurse_submodules_arg(const char *opt, const char *arg);
40extern int parse_push_recurse_submodules_arg(const char *opt, const char *arg);
1b796ace
BW
41extern void repo_read_gitmodules(struct repository *repo);
42extern void gitmodules_config_oid(const struct object_id *commit_oid);
3b8fb393
SB
43const struct submodule *submodule_from_name(struct repository *r,
44 const struct object_id *commit_or_tree,
45 const char *name);
46const struct submodule *submodule_from_path(struct repository *r,
47 const struct object_id *commit_or_tree,
48 const char *path);
f793b895 49void submodule_free(struct repository *r);
959b5455 50
0383bbb9
JK
51/*
52 * Returns 0 if the name is syntactically acceptable as a submodule "name"
53 * (e.g., that may be found in the subsection of a .gitmodules file) and -1
54 * otherwise.
55 */
56int check_submodule_name(const char *name);
57
959b5455 58#endif /* SUBMODULE_CONFIG_H */