959b5455d0
In a superproject some commands need to interact with submodules. They need to query values from the .gitmodules file either from the worktree of from certain revisions. At the moment this is quite hard since a caller would need to read the .gitmodules file from the history and then parse the values. We want to provide an API for this so we have one place to get values from .gitmodules from any revision (including the worktree). The API is realized as a cache which allows us to lazily read .gitmodules configurations by commit into a runtime cache which can then be used to easily lookup values from it. Currently only the values for path or name are stored but it can be extended for any value needed. It is expected that .gitmodules files do not change often between commits. Thats why we lookup the .gitmodules sha1 from a commit and then either lookup an already parsed configuration or parse and cache an unknown one for each sha1. The cache is lazily build on demand for each requested commit. This cache can be used for all purposes which need knowledge about submodule configurations. Example use cases are: * Recursive submodule checkout needs to lookup a submodule name from its path when a submodule first appears. This needs be done before this configuration exists in the worktree. * The implementation of submodule support for 'git archive' needs to lookup the submodule name to generate the archive when given a revision that is not checked out. * 'git fetch' when given the --recurse-submodules=on-demand option (or configuration) needs to lookup submodule names by path from the database rather than reading from the worktree. For new submodule it needs to lookup the name from its path to allow cloning new submodules into the .git folder so they can be checked out without any network interaction when the user does a checkout of that revision. Signed-off-by: Heiko Voigt <hvoigt@hvoigt.net> Signed-off-by: Stefan Beller <sbeller@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
47 lines
1.9 KiB
C
47 lines
1.9 KiB
C
#ifndef SUBMODULE_H
|
|
#define SUBMODULE_H
|
|
|
|
struct diff_options;
|
|
struct argv_array;
|
|
|
|
enum {
|
|
RECURSE_SUBMODULES_NONE = -2,
|
|
RECURSE_SUBMODULES_ON_DEMAND = -1,
|
|
RECURSE_SUBMODULES_OFF = 0,
|
|
RECURSE_SUBMODULES_DEFAULT = 1,
|
|
RECURSE_SUBMODULES_ON = 2
|
|
};
|
|
|
|
int is_staging_gitmodules_ok(void);
|
|
int update_path_in_gitmodules(const char *oldpath, const char *newpath);
|
|
int remove_path_from_gitmodules(const char *path);
|
|
void stage_updated_gitmodules(void);
|
|
void set_diffopt_flags_from_submodule_config(struct diff_options *diffopt,
|
|
const char *path);
|
|
int submodule_config(const char *var, const char *value, void *cb);
|
|
void gitmodules_config(void);
|
|
int parse_submodule_config_option(const char *var, const char *value);
|
|
void handle_ignore_submodules_arg(struct diff_options *diffopt, const char *);
|
|
int parse_fetch_recurse_submodules_arg(const char *opt, const char *arg);
|
|
void show_submodule_summary(FILE *f, const char *path,
|
|
const char *line_prefix,
|
|
unsigned char one[20], unsigned char two[20],
|
|
unsigned dirty_submodule, const char *meta,
|
|
const char *del, const char *add, const char *reset);
|
|
void set_config_fetch_recurse_submodules(int value);
|
|
void check_for_new_submodule_commits(unsigned char new_sha1[20]);
|
|
int fetch_populated_submodules(const struct argv_array *options,
|
|
const char *prefix, int command_line_option,
|
|
int quiet);
|
|
unsigned is_submodule_modified(const char *path, int ignore_untracked);
|
|
int submodule_uses_gitfile(const char *path);
|
|
int ok_to_remove_submodule(const char *path);
|
|
int merge_submodule(unsigned char result[20], const char *path, const unsigned char base[20],
|
|
const unsigned char a[20], const unsigned char b[20], int search);
|
|
int find_unpushed_submodules(unsigned char new_sha1[20], const char *remotes_name,
|
|
struct string_list *needs_pushing);
|
|
int push_unpushed_submodules(unsigned char new_sha1[20], const char *remotes_name);
|
|
void connect_work_tree_and_git_dir(const char *work_tree, const char *git_dir);
|
|
|
|
#endif
|