submodule: add a print_config_from_gitmodules() helper
[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"
ad136370 5#include "config.h"
959b5455 6#include "hashmap.h"
ea2fa5a3 7#include "submodule.h"
959b5455
HV
8#include "strbuf.h"
9
10/*
11 * Submodule entry containing the information about a certain submodule
12 * in a certain revision.
13 */
14struct submodule {
15 const char *path;
16 const char *name;
17 const char *url;
18 int fetch_recurse;
19 const char *ignore;
b5944f34 20 const char *branch;
ea2fa5a3 21 struct submodule_update_strategy update_strategy;
34caab02 22 /* the object id of the responsible .gitmodules file */
23 struct object_id gitmodules_oid;
37f52e93 24 int recommend_shallow;
959b5455
HV
25};
26
c68f8375 27#define SUBMODULE_INIT { NULL, NULL, NULL, RECURSE_SUBMODULES_NONE, \
34caab02 28 NULL, NULL, SUBMODULE_UPDATE_STRATEGY_INIT, { { 0 } }, -1 };
c68f8375 29
bf12fcdf
BW
30struct submodule_cache;
31struct repository;
32
33extern void submodule_cache_free(struct submodule_cache *cache);
34
f20e7c1e 35extern int parse_submodule_fetchjobs(const char *var, const char *value);
d601fd09 36extern int parse_fetch_recurse_submodules_arg(const char *opt, const char *arg);
886dc154
SB
37struct option;
38extern int option_fetch_parse_recurse_submodules(const struct option *opt,
39 const char *arg, int unset);
d601fd09
SB
40extern int parse_update_recurse_submodules_arg(const char *opt, const char *arg);
41extern int parse_push_recurse_submodules_arg(const char *opt, const char *arg);
1b796ace
BW
42extern void repo_read_gitmodules(struct repository *repo);
43extern void gitmodules_config_oid(const struct object_id *commit_oid);
3b8fb393
SB
44const struct submodule *submodule_from_name(struct repository *r,
45 const struct object_id *commit_or_tree,
46 const char *name);
47const struct submodule *submodule_from_path(struct repository *r,
48 const struct object_id *commit_or_tree,
49 const char *path);
f793b895 50void submodule_free(struct repository *r);
bcbc780d 51int print_config_from_gitmodules(struct repository *repo, const char *key);
959b5455 52
0383bbb9
JK
53/*
54 * Returns 0 if the name is syntactically acceptable as a submodule "name"
55 * (e.g., that may be found in the subsection of a .gitmodules file) and -1
56 * otherwise.
57 */
58int check_submodule_name(const char *name);
59
ad136370 60/*
588929d5
AO
61 * Note: these helper functions exist solely to maintain backward
62 * compatibility with 'fetch' and 'update_clone' storing configuration in
63 * '.gitmodules'.
ad136370 64 *
588929d5
AO
65 * New helpers to retrieve arbitrary configuration from the '.gitmodules' file
66 * should NOT be added.
ad136370 67 */
71a6953d 68extern void fetch_config_from_gitmodules(int *max_children, int *recurse_submodules);
05744997 69extern void update_clone_config_from_gitmodules(int *max_jobs);
71a6953d 70
959b5455 71#endif /* SUBMODULE_CONFIG_H */