[PATCH 1/2] config: allow config_with_options() to handle any repo
- From
Matheus Tavares <matheus.bernardino@usp.br>
- Date
- Aug 26, 2019, 23:57 UTC
- Message-ID
- <4920d3c474375abb39ed163c5ed6138a5e5dccc6.1566863604.git.matheus.bernardino@usp.br>
- In-Reply-To
- <cover.1566863604.git.matheus.bernardino@usp.br>
Currently, config_with_options() relies on the global the_repository when it has to configure from a blob. A possible way to bypass this limitation, when working with arbitrary repos, is to add their object directories into the in-memory alternates list. That's what submodule-config.c::config_from_gitmodules() does, for example. But this approach can negatively affect performance and memory. So introduce repo_config_with_options() which takes a struct repository as an additional parameter and pass it down in the call stack. Also, leave the original config_with_options() as a macro behind NO_THE_REPOSITORY_COMPATIBILITY_MACROS.
Finally, adjust documentation and add a rule to coccinelle to reflect the change.
Note: the following patch will take care of actually using the added function in place of config_with_options() at config_from_gitmodules().
Signed-off-by: Matheus Tavares <matheus.bernardino@usp.br> --- Documentation/technical/api-config.txt | 5 +++- config.c | 26 +++++++++---------- config.h | 16 ++++++++---- .../coccinelle/the_repository.pending.cocci | 11 ++++++++ submodule-config.c | 2 +- 5 files changed, 39 insertions(+), 21 deletions(-)
diff --git a/Documentation/technical/api-config.txt b/Documentation/technical/api-config.txt index 7d20716c32..ad99353df8 100644 --- a/Documentation/technical/api-config.txt +++ b/Documentation/technical/api-config.txt @@ -47,7 +47,7 @@ will first feed the user-wide one to the callback, and then the repo-specific one; by overwriting, the higher-priority repo-specific value is left at the end). -The `config_with_options` function lets the caller examine config +The `repo_config_with_options` function lets the caller examine config while adjusting some of the default behavior of `git_config`. It should almost never be used by "regular" Git code that is looking up configuration variables. It is intended for advanced callers like @@ -65,6 +65,9 @@ Specify options to adjust the behavior of parsing config files. See `struct config_options` in `config.h` for details. As an example: regular `git_config` sets `opts.respect_includes` to `1` by default. +The `config_with_options` macro is provided as an alias for +`repo_config_with_options`, using 'the_repository' by default. + Reading Specific Files ---------------------- diff --git a/config.c b/config.c index 3900e4947b..dc116f2582 100644 --- a/config.c +++ b/config.c @@ -1624,17 +1624,16 @@ int git_config_from_mem(config_fn_t fn, return do_config_from(&top, fn, data, opts); } -int git_config_from_blob_oid(config_fn_t fn, - const char *name, - const struct object_id *oid, - void *data) +int git_config_from_blob_oid(struct repository *r, config_fn_t fn, + const char *name, const struct object_id *oid, + void *data) { enum object_type type; char *buf; unsigned long size; int ret; - buf = read_object_file(oid, &type, &size); + buf = repo_read_object_file(r, oid, &type, &size); if (!buf) return error(_("unable to load config blob object '%s'"), name); if (type != OBJ_BLOB) { @@ -1649,15 +1648,14 @@ int git_config_from_blob_oid(config_fn_t fn, return ret; } -static int git_config_from_blob_ref(config_fn_t fn, - const char *name, - void *data) +static int git_config_from_blob_ref(struct repository *r, config_fn_t fn, + const char *name, void *data) { struct object_id oid; - if (get_oid(name, &oid) < 0) + if (repo_get_oid(r, name, &oid) < 0) return error(_("unable to resolve config blob '%s'"), name); - return git_config_from_blob_oid(fn, name, &oid, data); + return git_config_from_blob_oid(r, fn, name, &oid, data); } const char *git_etc_gitconfig(void) @@ -1751,9 +1749,9 @@ static int do_git_config_sequence(const struct config_options *opts, return ret; } -int config_with_options(config_fn_t fn, void *data, - struct git_config_source *config_source, - const struct config_options *opts) +int repo_config_with_options(struct repository *r, config_fn_t fn, void *data, + struct git_config_source *config_source, + const struct config_options *opts) { struct config_include_data inc = CONFIG_INCLUDE_INIT; @@ -1774,7 +1772,7 @@ int config_with_options(config_fn_t fn, void *data, else if (config_source && config_source->file) return git_config_from_file(fn, config_source->file, data); else if (config_source && config_source->blob) - return git_config_from_blob_ref(fn, config_source->blob, data); + return git_config_from_blob_ref(r, fn, config_source->blob, data); return do_git_config_sequence(opts, fn, data); } diff --git a/config.h b/config.h index f0ed464004..33ce46ecc3 100644 --- a/config.h +++ b/config.h @@ -82,16 +82,22 @@ int git_config_from_mem(config_fn_t fn, const char *name, const char *buf, size_t len, void *data, const struct config_options *opts); -int git_config_from_blob_oid(config_fn_t fn, const char *name, - const struct object_id *oid, void *data); +int git_config_from_blob_oid(struct repository *r, config_fn_t fn, + const char *name, const struct object_id *oid, + void *data); void git_config_push_parameter(const char *text); int git_config_from_parameters(config_fn_t fn, void *data); void read_early_config(config_fn_t cb, void *data); void read_very_early_config(config_fn_t cb, void *data); void git_config(config_fn_t fn, void *); -int config_with_options(config_fn_t fn, void *, - struct git_config_source *config_source, - const struct config_options *opts); +int repo_config_with_options(struct repository *r, config_fn_t fn, void *data, + struct git_config_source *config_source, + const struct config_options *opts); +#ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS +#define config_with_options(fn, data, config_source, opts) \ + repo_config_with_options(the_repository, fn, data, config_source, opts) +#endif + int git_parse_ssize_t(const char *, ssize_t *); int git_parse_ulong(const char *, unsigned long *); int git_parse_maybe_bool(const char *); diff --git a/contrib/coccinelle/the_repository.pending.cocci b/contrib/coccinelle/the_repository.pending.cocci index 2ee702ecf7..53ecc975bf 100644 --- a/contrib/coccinelle/the_repository.pending.cocci +++ b/contrib/coccinelle/the_repository.pending.cocci @@ -142,3 +142,14 @@ expression H; - format_commit_message( + repo_format_commit_message(the_repository, E, F, G, H); + +@@ +expression E; +expression F; +expression G; +expression H; +@@ +- config_with_options( ++ repo_config_with_options(the_repository, + E, F, G, H); + diff --git a/submodule-config.c b/submodule-config.c index 4264ee216f..1d28b17071 100644 --- a/submodule-config.c +++ b/submodule-config.c @@ -681,7 +681,7 @@ void gitmodules_config_oid(const struct object_id *commit_oid) submodule_cache_check_init(the_repository); if (gitmodule_oid_from_commit(commit_oid, &oid, &rev)) { - git_config_from_blob_oid(gitmodules_cb, rev.buf, + git_config_from_blob_oid(the_repository, gitmodules_cb, rev.buf, &oid, the_repository); } strbuf_release(&rev);
-- 2.22.0