The config machinery is not able to read worktree configs from a
submodule in a process where the_repository represents the superproject.
Furthermore, when extensions.worktreeConfig is set on the superproject,
querying for a worktree config in a submodule will, instead, return
the value set at the superproject.
The problem resides in do_git_config_sequence(). Although the function
receives a git_dir string, it uses the_repository->git_dir when making
the path to the worktree config file. And when checking if
extensions.worktreeConfig is set, it uses the global
repository_format_worktree_config variable, which refers to
the_repository only. So let's fix this by using the git_dir given to the
function and reading the extension value from the right place. Also add
a test to avoid any regressions.
Signed-off-by: Matheus Tavares <matheus.bernardino@xxxxxx>
---
config.c | 21 ++++++++++---
t/helper/test-config.c | 62 ++++++++++++++++++++++++++++++++------
t/t2404-worktree-config.sh | 16 ++++++++++
3 files changed, 85 insertions(+), 14 deletions(-)
diff --git a/config.c b/config.c
index 2bdff4457b..e1e7fab6dc 100644
--- a/config.c
+++ b/config.c
@@ -1747,11 +1747,22 @@ static int do_git_config_sequence(const struct config_options *opts,
ret += git_config_from_file(fn, repo_config, data);
current_parsing_scope = CONFIG_SCOPE_WORKTREE;
- if (!opts->ignore_worktree && repository_format_worktree_config) {
- char *path = git_pathdup("config.worktree");
- if (!access_or_die(path, R_OK, 0))
- ret += git_config_from_file(fn, path, data);
- free(path);
+ if (!opts->ignore_worktree && repo_config && opts->git_dir) {
+ struct repository_format repo_fmt = REPOSITORY_FORMAT_INIT;
+ struct strbuf buf = STRBUF_INIT;
+
+ read_repository_format(&repo_fmt, repo_config);
+
+ if (!verify_repository_format(&repo_fmt, &buf) &&
+ repo_fmt.worktree_config) {
+ char *path = mkpathdup("%s/config.worktree", opts->git_dir);
+ if (!access_or_die(path, R_OK, 0))
+ ret += git_config_from_file(fn, path, data);
+ free(path);
+ }
+
+ strbuf_release(&buf);
+ clear_repository_format(&repo_fmt);
}
current_parsing_scope = CONFIG_SCOPE_COMMAND;
diff --git a/t/helper/test-config.c b/t/helper/test-config.c
index 8fe43e9775..2924c09c21 100644
--- a/t/helper/test-config.c
+++ b/t/helper/test-config.c
@@ -2,12 +2,20 @@
#include "cache.h"
#include "config.h"
#include "string-list.h"
+#include "submodule-config.h"
+#include "parse-options.h"
/*
* This program exposes the C API of the configuration mechanism
* as a set of simple commands in order to facilitate testing.
*
- * Reads stdin and prints result of command to stdout:
+ * Usage: test-tool config [--submodule=<path>] <cmd> [<args>]
+ *
+ * If --submodule=<path> is given, <cmd> will operate on the submodule at the
+ * given <path>. This option is not valid for the commands: read_early_config,
+ * configset_get_value and configset_get_value_multi.
+ *
+ * Possible cmds are:
*
* get_value -> prints the value with highest priority for the entered key
*
@@ -72,14 +80,34 @@ static int early_config_cb(const char *var, const char *value, void *vdata)
#define TC_VALUE_NOT_FOUND 1
#define TC_CONFIG_FILE_ERROR 2
+static const char *test_config_usage[] = {
+ "test-tool config [--submodule=<path>] <cmd> [<args>]",
+ NULL
+};
+
int cmd__config(int argc, const char **argv)
{
int i, val, ret = 0;
const char *v;
const struct string_list *strptr;
struct config_set cs;
+ struct repository subrepo, *repo = the_repository;
+ const char *subrepo_path = NULL;
+
+ struct option options[] = {
+ OPT_STRING(0, "submodule", &subrepo_path, "path",
+ "run <cmd> on the submodule at <path>"),
+ OPT_END()
+ };
+
+ argc = parse_options(argc, argv, NULL, options, test_config_usage,
+ PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_STOP_AT_NON_OPTION);
+ if (argc < 2)
+ die("Please, provide a command name on the command-line");
if (argc == 3 && !strcmp(argv[1], "read_early_config")) {
+ if (subrepo_path)
+ die("cannot use --submodule with read_early_config");
read_early_config(early_config_cb, (void *)argv[2]);
return ret;
}
@@ -88,11 +116,18 @@ int cmd__config(int argc, const char **argv)
git_configset_init(&cs);
- if (argc < 2)
- die("Please, provide a command name on the command-line");
+ if (subrepo_path) {
+ const struct submodule *sub;
+
+ sub = submodule_from_path(the_repository, &null_oid, subrepo_path);
+ if (!sub || repo_submodule_init(&subrepo, the_repository, sub))
+ die("invalid argument to --submodule: '%s'", subrepo_path);
+
+ repo = &subrepo;
+ }
if (argc == 3 && !strcmp(argv[1], "get_value")) {
- if (!git_config_get_value(argv[2], &v)) {
+ if (!repo_config_get_value(repo, argv[2], &v)) {
if (!v)
printf("(NULL)\n");
else
@@ -102,7 +137,7 @@ int cmd__config(int argc, const char **argv)
ret = TC_VALUE_NOT_FOUND;
}
} else if (argc == 3 && !strcmp(argv[1], "get_value_multi")) {
- strptr = git_config_get_value_multi(argv[2]);
+ strptr = repo_config_get_value_multi(repo, argv[2]);
if (strptr) {
for (i = 0; i < strptr->nr; i++) {
v = strptr->items[i].string;
@@ -116,27 +151,31 @@ int cmd__config(int argc, const char **argv)
ret = TC_VALUE_NOT_FOUND;
}
} else if (argc == 3 && !strcmp(argv[1], "get_int")) {
- if (!git_config_get_int(argv[2], &val)) {
+ if (!repo_config_get_int(repo, argv[2], &val)) {
printf("%d\n", val);
} else {
printf("Value not found for \"%s\"\n", argv[2]);
ret = TC_VALUE_NOT_FOUND;
}
} else if (argc == 3 && !strcmp(argv[1], "get_bool")) {
- if (!git_config_get_bool(argv[2], &val)) {
+ if (!repo_config_get_bool(repo, argv[2], &val)) {
printf("%d\n", val);
} else {
+
printf("Value not found for \"%s\"\n", argv[2]);
ret = TC_VALUE_NOT_FOUND;
}
} else if (argc == 3 && !strcmp(argv[1], "get_string")) {
- if (!git_config_get_string_tmp(argv[2], &v)) {
+ if (!repo_config_get_string_tmp(repo, argv[2], &v)) {
printf("%s\n", v);
} else {
printf("Value not found for \"%s\"\n", argv[2]);
ret = TC_VALUE_NOT_FOUND;
}
} else if (argc >= 3 && !strcmp(argv[1], "configset_get_value")) {
+ if (subrepo_path)
+ die("cannot use --submodule with configset_get_value");
+
for (i = 3; i < argc; i++) {
int err;
if ((err = git_configset_add_file(&cs, argv[i]))) {
@@ -155,6 +194,9 @@ int cmd__config(int argc, const char **argv)
ret = TC_VALUE_NOT_FOUND;
}
} else if (argc >= 3 && !strcmp(argv[1], "configset_get_value_multi")) {
+ if (subrepo_path)
+ die("cannot use --submodule with configset_get_value_multi");
+
for (i = 3; i < argc; i++) {
int err;
if ((err = git_configset_add_file(&cs, argv[i]))) {
@@ -177,12 +219,14 @@ int cmd__config(int argc, const char **argv)
ret = TC_VALUE_NOT_FOUND;
}
} else if (!strcmp(argv[1], "iterate")) {
- git_config(iterate_cb, NULL);
+ repo_config(repo, iterate_cb, NULL);
} else {
die("%s: Please check the syntax and the function name", argv[0]);
}
out:
git_configset_clear(&cs);
+ if (repo != the_repository)
+ repo_clear(repo);
return ret;
}
diff --git a/t/t2404-worktree-config.sh b/t/t2404-worktree-config.sh
index 9536d10919..1e32c93735 100755
--- a/t/t2404-worktree-config.sh
+++ b/t/t2404-worktree-config.sh
@@ -78,4 +78,20 @@ test_expect_success 'config.worktree no longer read without extension' '
test_cmp_config -C wt2 shared this.is
'
+test_expect_success 'correctly read config.worktree from submodules' '
+ test_unconfig extensions.worktreeConfig &&
+ git init sub &&
+ (
+ cd sub &&
+ test_commit A &&
+ git config extensions.worktreeConfig true &&
+ git config --worktree wtconfig.sub test-value
+ ) &&
+ git submodule add ./sub &&
+ git commit -m "add sub" &&
+ echo test-value >expect &&
+ test-tool config --submodule=sub get_value wtconfig.sub >actual &&
+ test_cmp expect actual
+'
+
test_done
--
2.28.0
