[PATCH v2 0/2] repo: add new flag --keys to git-repo-info
- From
Lucas Seiki Oshiro <lucasseikioshiro@gmail.com>
- Date
- Dec 9, 2025, 19:36 UTC
- Message-ID
- <20251209194616.61620-1-lucasseikioshiro@gmail.com>
- In-Reply-To
- <20251207190532.67107-1-lucasseikioshiro@gmail.com>
Hi!
This patch series adds a new flag --keys to git-repo-info. This new flag only prints the available keys, without printing the corresponding values.
The main change in this version is the compatibility with the flags -z and --format, allowing the keys to be printed following the null-terminated format.
This patch is based on top of master bdc5341ff6 (The sixth batch, 2025-12-05) with lo/repo-struct-z merged.
Lucas Seiki Oshiro (2): repo: add a default output format to enum output_format repo: add new flag --keys to git-repo-info
Documentation/git-repo.adoc | 11 ++++++++++ builtin/repo.c | 41 ++++++++++++++++++++++++++++++++++++- t/t1900-repo.sh | 33 +++++++++++++++++++---------- 3 files changed, 73 insertions(+), 12 deletions(-)
Range-diff against v1:
-: ---------- > 1: 9eb2549806 repo: add a default output format to enum output_format
1: 1b9b7dceb7 ! 2: c5b7ba8824 repo: add new flag --keys to git-repo-info
@@ Metadata
## Commit message ##
repo: add new flag --keys to git-repo-info
- Currently, if the user wants to find what are the available keys,
- they need to either check the documentation or to ask to all the
- key-value pairs by using --all.
+ 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.
@@ Documentation/git-repo.adoc: SYNOPSIS
--------
[synopsis]
git repo info [--format=(keyvalue|nul) | -z] [--all | <key>...]
-+git repo info --keys
++git repo info --keys [--format=(default|nul) | -z]
git repo structure [--format=(table|keyvalue|nul) | -z]
DESCRIPTION
@@ Documentation/git-repo.adoc: supported:
+
`-z` is an alias for `--format=nul`.
-+`info --keys`::
-+List all the available keys, one per line.
++`info --keys [--format=(default|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`:::
++ output the keys one per line.
++
++`nul`:::
++ similar to `default`, but using a NUL character after each value.
+
`structure [--format=(table|keyvalue|nul) | -z]`::
Retrieve statistics about the current repository structure. The
@@ builtin/repo.c
static const char *const repo_usage[] = {
"git repo info [--format=(keyvalue|nul) | -z] [--all | <key>...]",
-+ "git repo info --keys",
++ "git repo info --keys [--format=(default|nul) | -z]",
"git repo structure [--format=(table|keyvalue|nul) | -z]",
NULL
};
@@ builtin/repo.c: static int print_all_fields(struct repository *repo,
return 0;
}
-+static int print_keys(void)
++static int print_keys(enum output_format format)
+{
++ char sep;
++
++ switch (format) {
++ case FORMAT_DEFAULT:
++ 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];
-+ puts(field->key);
++ printf("%s%c", field->key, sep);
+ }
+
+ return 0;
@@ builtin/repo.c: static int print_all_fields(struct repository *repo,
{
@@ builtin/repo.c: static int cmd_repo_info(int argc, const char **argv, const char *prefix,
{
- enum output_format format = FORMAT_KEYVALUE;
+ enum output_format format = FORMAT_DEFAULT;
int all_keys = 0;
+ int show_keys = 0;
struct option options[] = {
@@ builtin/repo.c: static int cmd_repo_info(int argc, const char **argv, const char
};
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();
++ return print_keys(format);
+
- if (format != FORMAT_KEYVALUE && format != FORMAT_NUL_TERMINATED)
- die(_("unsupported output format"));
+ if (format == FORMAT_DEFAULT)
+ format = FORMAT_KEYVALUE;
## t/t1900-repo.sh ##
@@ t/t1900-repo.sh: test_expect_success 'git repo info uses the last requested form
git repo info --all >actual &&
test_cmp expect actual
'
+@@ t/t1900-repo.sh: test_expect_success 'git repo info --all <key> aborts' '
+ 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_done-- 2.50.1 (Apple Git-155)