[PATCH v4 2/2] repo: add new flag --keys to git-repo-info
From: Lucas Seiki Oshiro <hidden>
Date: 2026-01-19 21:09:51
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
If the user wants to find what are the available keys, they need to either check the documentation or to ask for all the key-value pairs by using --all. Add a new flag --keys for listing only the available keys without listing the values. Signed-off-by: Lucas Seiki Oshiro <redacted> --- Documentation/git-repo.adoc | 14 +++++++++++++ builtin/repo.c | 38 +++++++++++++++++++++++++++++++++ t/t1900-repo.sh | 42 +++++++++++++++++++++++++++---------- 3 files changed, 83 insertions(+), 11 deletions(-)
diff --git a/Documentation/git-repo.adoc b/Documentation/git-repo.adoc
index fa0e6600af..2472345a7c 100644
--- a/Documentation/git-repo.adoc
+++ b/Documentation/git-repo.adoc@@ -9,6 +9,7 @@ SYNOPSIS -------- [synopsis] git repo info [--format=(default|keyvalue|nul) | -z] [--all | <key>...] +git repo info --keys [--format=(default|lines|nul) | -z] git repo structure [--format=(default|table|keyvalue|nul) | -z] DESCRIPTION
@@ -47,6 +48,19 @@ supported: + `-z` is an alias for `--format=nul`. +`info --keys [--format=(default|lines|nul) | -z]`:: + List all the available keys, one per line. The output format can be chosen + through the flag `--format`. The following formats are supported: ++ +`default`::: + synonym for `lines`. + +`lines`::: + output the keys one per line. + +`nul`::: + similar to `default`, but using a _NUL_ character after each value. + `structure [--format=(default|table|keyvalue|nul) | -z]`:: Retrieve statistics about the current repository structure. The following kinds of information are reported:
diff --git a/builtin/repo.c b/builtin/repo.c
index 306d3fa2df..2f698c5253 100644
--- a/builtin/repo.c
+++ b/builtin/repo.c@@ -18,6 +18,7 @@ static const char *const repo_usage[] = { "git repo info [--format=(default|keyvalue|nul) | -z] [--all | <key>...]", + "git repo info --keys [--format=(default|lines|nul) | -z]", "git repo structure [--format=(default|table|keyvalue|nul) | -z]", NULL };
@@ -29,6 +30,7 @@ enum output_format { FORMAT_TABLE, FORMAT_KEYVALUE, FORMAT_NUL_TERMINATED, + FORMAT_LINES }; struct field {
@@ -149,6 +151,32 @@ static int print_all_fields(struct repository *repo, return 0; } +static int print_keys(enum output_format format) +{ + char sep; + + if (format == FORMAT_DEFAULT) + format = FORMAT_LINES; + + switch (format) { + case FORMAT_LINES: + sep = '\n'; + break; + case FORMAT_NUL_TERMINATED: + sep = '\0'; + break; + default: + die(_("--keys can only be used with --format=default or --format=nul")); + } + + for (size_t i = 0; i < ARRAY_SIZE(repo_info_fields); i++) { + const struct field *field = &repo_info_fields[i]; + printf("%s%c", field->key, sep); + } + + return 0; +} + static int parse_format_cb(const struct option *opt, const char *arg, int unset UNUSED) {
@@ -162,6 +190,8 @@ static int parse_format_cb(const struct option *opt, *format = FORMAT_KEYVALUE; else if (!strcmp(arg, "table")) *format = FORMAT_TABLE; + else if (!strcmp(arg, "lines")) + *format = FORMAT_LINES; else if (!strcmp(arg, "default")) *format = FORMAT_DEFAULT; else
@@ -175,6 +205,7 @@ static int cmd_repo_info(int argc, const char **argv, const char *prefix, { enum output_format format = FORMAT_DEFAULT; int all_keys = 0; + int show_keys = 0; struct option options[] = { OPT_CALLBACK_F(0, "format", &format, N_("format"), N_("output format"),
@@ -184,11 +215,18 @@ static int cmd_repo_info(int argc, const char **argv, const char *prefix, PARSE_OPT_NONEG | PARSE_OPT_NOARG, parse_format_cb), OPT_BOOL(0, "all", &all_keys, N_("print all keys/values")), + OPT_BOOL(0, "keys", &show_keys, N_("show keys")), OPT_END() }; argc = parse_options(argc, argv, prefix, options, repo_usage, 0); + if (show_keys && (all_keys || argc)) + die(_("--keys cannot be used with a <key> or --all")); + + if (show_keys) + return print_keys(format); + if (format == FORMAT_DEFAULT) format = FORMAT_KEYVALUE;
diff --git a/t/t1900-repo.sh b/t/t1900-repo.sh
index e6670f0f58..832938e958 100755
--- a/t/t1900-repo.sh
+++ b/t/t1900-repo.sh@@ -4,15 +4,6 @@ test_description='test git repo-info' . ./test-lib.sh -# git-repo-info keys. It must contain the same keys listed in the const -# repo_info_fields, in lexicographical order. -REPO_INFO_KEYS=' - layout.bare - layout.shallow - object.format - references.format -' - # Test whether a key-value pair is correctly returned # # Usage: test_repo_info <label> <init command> <repo_name> <key> <expected value>
@@ -119,8 +110,8 @@ test_expect_success 'git repo info uses the last requested format' ' test_cmp expected actual ' -test_expect_success 'git repo info --all returns all key-value pairs' ' - git repo info $REPO_INFO_KEYS >expect && +test_expect_success 'git repo info --all and git repo info $(git repo info --keys) output the same data' ' + git repo info $(git repo info --keys) >expect && git repo info --all >actual && test_cmp expect actual '
@@ -143,4 +134,33 @@ test_expect_success '--format=default resets the format' ' test_cmp expect actual ' +test_expect_success 'git repo info --keys --format=nul uses nul-terminated output' ' + git repo info --keys --format=default >default && + lf_to_nul <default >expect && + git repo info --keys --format=nul >actual && + test_cmp expect actual +' + +test_expect_success 'git repo info --keys aborts when using --format other than default or nul' ' + echo "fatal: --keys can only be used with --format=default or --format=nul" >expect && + test_must_fail git repo info --keys --format=keyvalue 2>actual && + test_cmp expect actual +' + +test_expect_success 'git repo info --keys aborts when requesting keys' ' + echo "fatal: --keys cannot be used with a <key> or --all" >expect && + test_must_fail git repo info --keys --all 2>actual_all && + test_must_fail git repo info --keys some.key 2>actual_key && + test_cmp expect actual_all && + test_cmp expect actual_key +' + +test_expect_success 'git repo info --keys uses lines as its default output format' ' + git repo info --keys --format=lines >expect && + git repo info --keys --format=default >actual_explicit && + git repo info --keys >actual_implicit && + test_cmp expect actual_explicit && + test_cmp expect actual_implicit +' + test_done
--
2.50.1 (Apple Git-155)