docs: fix formatting and grammar
[git.git] / submodule-config.h
blobd434ecdb45c074dd386405f20ed73ac1c8b646bd
1 #ifndef SUBMODULE_CONFIG_CACHE_H
2 #define SUBMODULE_CONFIG_CACHE_H
4 #include "hashmap.h"
5 #include "submodule.h"
6 #include "strbuf.h"
8 /*
9 * Submodule entry containing the information about a certain submodule
10 * in a certain revision.
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;
25 extern int parse_fetch_recurse_submodules_arg(const char *opt, const char *arg);
26 extern int parse_update_recurse_submodules_arg(const char *opt, const char *arg);
27 extern int parse_push_recurse_submodules_arg(const char *opt, const char *arg);
28 extern int parse_submodule_config_option(const char *var, const char *value);
29 extern const struct submodule *submodule_from_name(
30 const unsigned char *commit_or_tree, const char *name);
31 extern const struct submodule *submodule_from_path(
32 const unsigned char *commit_or_tree, const char *path);
33 extern int gitmodule_sha1_from_commit(const unsigned char *commit_sha1,
34 unsigned char *gitmodules_sha1,
35 struct strbuf *rev);
36 extern void submodule_free(void);
38 #endif /* SUBMODULE_CONFIG_H */