submodule-config.h 2.49 KB
Newer Older
1 2 3
#ifndef SUBMODULE_CONFIG_CACHE_H
#define SUBMODULE_CONFIG_CACHE_H

4
#include "cache.h"
5
#include "config.h"
6
#include "hashmap.h"
7
#include "submodule.h"
8 9 10 11 12 13 14 15 16 17 18 19
#include "strbuf.h"

/*
 * Submodule entry containing the information about a certain submodule
 * in a certain revision.
 */
struct submodule {
	const char *path;
	const char *name;
	const char *url;
	int fetch_recurse;
	const char *ignore;
20
	const char *branch;
21
	struct submodule_update_strategy update_strategy;
22 23
	/* the object id of the responsible .gitmodules file */
	struct object_id gitmodules_oid;
24
	int recommend_shallow;
25 26
};

27
#define SUBMODULE_INIT { NULL, NULL, NULL, RECURSE_SUBMODULES_NONE, \
28
	NULL, NULL, SUBMODULE_UPDATE_STRATEGY_INIT, { { 0 } }, -1 };
29

30 31 32 33 34
struct submodule_cache;
struct repository;

extern void submodule_cache_free(struct submodule_cache *cache);

35
extern int parse_submodule_fetchjobs(const char *var, const char *value);
36
extern int parse_fetch_recurse_submodules_arg(const char *opt, const char *arg);
37 38 39
struct option;
extern int option_fetch_parse_recurse_submodules(const struct option *opt,
						 const char *arg, int unset);
40 41
extern int parse_update_recurse_submodules_arg(const char *opt, const char *arg);
extern int parse_push_recurse_submodules_arg(const char *opt, const char *arg);
42 43
extern void repo_read_gitmodules(struct repository *repo);
extern void gitmodules_config_oid(const struct object_id *commit_oid);
44 45 46 47 48 49
const struct submodule *submodule_from_name(struct repository *r,
					    const struct object_id *commit_or_tree,
					    const char *name);
const struct submodule *submodule_from_path(struct repository *r,
					    const struct object_id *commit_or_tree,
					    const char *path);
50
void submodule_free(struct repository *r);
51
int print_config_from_gitmodules(struct repository *repo, const char *key);
52
int config_set_in_gitmodules_file_gently(const char *key, const char *value);
53

54 55 56 57 58 59 60
/*
 * Returns 0 if the name is syntactically acceptable as a submodule "name"
 * (e.g., that may be found in the subsection of a .gitmodules file) and -1
 * otherwise.
 */
int check_submodule_name(const char *name);

61
/*
62 63 64
 * Note: these helper functions exist solely to maintain backward
 * compatibility with 'fetch' and 'update_clone' storing configuration in
 * '.gitmodules'.
65
 *
66 67
 * New helpers to retrieve arbitrary configuration from the '.gitmodules' file
 * should NOT be added.
68
 */
69
extern void fetch_config_from_gitmodules(int *max_children, int *recurse_submodules);
70
extern void update_clone_config_from_gitmodules(int *max_jobs);
71

72
#endif /* SUBMODULE_CONFIG_H */