Disallow dubiously-nested submodule git directories
[git] / submodule-config.h
1 #ifndef SUBMODULE_CONFIG_CACHE_H
2 #define SUBMODULE_CONFIG_CACHE_H
3
4 #include "hashmap.h"
5 #include "submodule.h"
6 #include "strbuf.h"
7
8 /*
9  * Submodule entry containing the information about a certain submodule
10  * in a certain revision.
11  */
12 struct submodule {
13         const char *path;
14         const char *name;
15         const char *url;
16         int fetch_recurse;
17         const char *ignore;
18         const char *branch;
19         struct submodule_update_strategy update_strategy;
20         /* the sha1 blob id of the responsible .gitmodules file */
21         unsigned char gitmodules_sha1[20];
22         int recommend_shallow;
23 };
24
25 struct submodule_cache;
26 struct repository;
27
28 extern void submodule_cache_free(struct submodule_cache *cache);
29
30 extern int parse_fetch_recurse_submodules_arg(const char *opt, const char *arg);
31 struct option;
32 extern int option_fetch_parse_recurse_submodules(const struct option *opt,
33                                                  const char *arg, int unset);
34 extern int parse_update_recurse_submodules_arg(const char *opt, const char *arg);
35 extern int parse_push_recurse_submodules_arg(const char *opt, const char *arg);
36 extern int parse_submodule_config_option(const char *var, const char *value);
37 extern int submodule_config_option(struct repository *repo,
38                                    const char *var, const char *value);
39 extern const struct submodule *submodule_from_name(
40                 const unsigned char *commit_or_tree, const char *name);
41 extern const struct submodule *submodule_from_path(
42                 const unsigned char *commit_or_tree, const char *path);
43 extern const struct submodule *submodule_from_cache(struct repository *repo,
44                                                     const unsigned char *treeish_name,
45                                                     const char *key);
46 extern int gitmodule_sha1_from_commit(const unsigned char *commit_sha1,
47                                       unsigned char *gitmodules_sha1,
48                                       struct strbuf *rev);
49 extern void submodule_free(void);
50
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  */
56 int check_submodule_name(const char *name);
57
58 #endif /* SUBMODULE_CONFIG_H */