From: Lucas Seiki Oshiro <lucasseikioshiro@gmail•com>
To: git@vger•kernel.org
Cc: ps@pks•im, gitster@pobox•com, jltobler@gmail•com,
avila.jn@gmail•com,
Lucas Seiki Oshiro <lucasseikioshiro@gmail•com>
Subject: [PATCH v5 1/2] repo: rename "keyvalue" to "lines"
Date: Fri, 23 Jan 2026 13:34:53 -0300 [thread overview]
Message-ID: <20260123164900.35092-2-lucasseikioshiro@gmail.com> (raw)
In-Reply-To: <20260123164900.35092-1-lucasseikioshiro@gmail.com>
The output format name "keyvalue" isn't so descriptive. Rename it to
"lines", since it describes better the syntax of the output format and
it isn't tied to key-value pairs.
Signed-off-by: Lucas Seiki Oshiro <lucasseikioshiro@gmail•com>
---
Documentation/git-repo.adoc | 21 +++++++++++----------
builtin/repo.c | 19 ++++++++++---------
t/t1900-repo.sh | 4 ++--
t/t1901-repo-structure.sh | 4 ++--
4 files changed, 25 insertions(+), 23 deletions(-)
diff --git a/Documentation/git-repo.adoc b/Documentation/git-repo.adoc
index 7d70270dfa..693e1bbced 100644
--- a/Documentation/git-repo.adoc
+++ b/Documentation/git-repo.adoc
@@ -8,8 +8,8 @@ git-repo - Retrieve information about the repository
SYNOPSIS
--------
[synopsis]
-git repo info [--format=(keyvalue|nul) | -z] [--all | <key>...]
-git repo structure [--format=(table|keyvalue|nul) | -z]
+git repo info [--format=(lines|nul) | -z] [--all | <key>...]
+git repo structure [--format=(table|lines|nul) | -z]
DESCRIPTION
-----------
@@ -19,7 +19,7 @@ THIS COMMAND IS EXPERIMENTAL. THE BEHAVIOR MAY CHANGE.
COMMANDS
--------
-`info [--format=(keyvalue|nul) | -z] [--all | <key>...]`::
+`info [--format=(lines|nul) | -z] [--all | <key>...]`::
Retrieve metadata-related information about the current repository. Only
the requested data will be returned based on their keys (see "INFO KEYS"
section below).
@@ -30,21 +30,22 @@ requested. The `--all` flag requests the values for all the available keys.
The output format can be chosen through the flag `--format`. Two formats are
supported:
+
-`keyvalue`:::
+
+`lines`:::
output key-value pairs one per line using the `=` character as
the delimiter between the key and the value. Values containing "unusual"
characters are quoted as explained for the configuration variable
`core.quotePath` (see linkgit:git-config[1]). This is the default.
`nul`:::
- similar to `keyvalue`, but using a newline character as the delimiter
+ similar to `lines`, but using a newline character as the delimiter
between the key and the value and using a NUL character after each value.
This format is better suited for being parsed by another applications than
- `keyvalue`. Unlike in the `keyvalue` format, the values are never quoted.
+ `lines`. Unlike in the `lines` format, the values are never quoted.
+
`-z` is an alias for `--format=nul`.
-`structure [--format=(table|keyvalue|nul) | -z]`::
+`structure [--format=(table|lines|nul) | -z]`::
Retrieve statistics about the current repository structure. The
following kinds of information are reported:
+
@@ -61,17 +62,17 @@ supported:
change and is not intended for machine parsing. This is the default
format.
-`keyvalue`:::
+`lines`:::
Each line of output contains a key-value pair for a repository stat.
The '=' character is used to delimit between the key and the value.
Values containing "unusual" characters are quoted as explained for the
configuration variable `core.quotePath` (see linkgit:git-config[1]).
`nul`:::
- Similar to `keyvalue`, but uses a NUL character to delimit between
+ Similar to `lines`, but uses a NUL character to delimit between
key-value pairs instead of a newline. Also uses a newline character as
the delimiter between the key and value instead of '='. Unlike the
- `keyvalue` format, values containing "unusual" characters are never
+ `lines` format, values containing "unusual" characters are never
quoted.
+
`-z` is an alias for `--format=nul`.
diff --git a/builtin/repo.c b/builtin/repo.c
index 0ea045abc1..4031612bc8 100644
--- a/builtin/repo.c
+++ b/builtin/repo.c
@@ -17,8 +17,8 @@
#include "utf8.h"
static const char *const repo_usage[] = {
- "git repo info [--format=(keyvalue|nul) | -z] [--all | <key>...]",
- "git repo structure [--format=(table|keyvalue|nul) | -z]",
+ "git repo info [--format=(lines|nul) | -z] [--all | <key>...]",
+ "git repo structure [--format=(table|lines|nul) | -z]",
NULL
};
@@ -26,7 +26,7 @@ typedef int get_value_fn(struct repository *repo, struct strbuf *buf);
enum output_format {
FORMAT_TABLE,
- FORMAT_KEYVALUE,
+ FORMAT_LINES,
FORMAT_NUL_TERMINATED,
};
@@ -91,7 +91,7 @@ static void print_field(enum output_format format, const char *key,
const char *value)
{
switch (format) {
- case FORMAT_KEYVALUE:
+ case FORMAT_LINES:
printf("%s=", key);
quote_c_style(value, NULL, stdout, 0);
putchar('\n');
@@ -157,8 +157,8 @@ static int parse_format_cb(const struct option *opt,
*format = FORMAT_NUL_TERMINATED;
else if (!strcmp(arg, "nul"))
*format = FORMAT_NUL_TERMINATED;
- else if (!strcmp(arg, "keyvalue"))
- *format = FORMAT_KEYVALUE;
+ else if (!strcmp(arg, "lines"))
+ *format = FORMAT_LINES;
else if (!strcmp(arg, "table"))
*format = FORMAT_TABLE;
else
@@ -170,7 +170,7 @@ static int parse_format_cb(const struct option *opt,
static int cmd_repo_info(int argc, const char **argv, const char *prefix,
struct repository *repo)
{
- enum output_format format = FORMAT_KEYVALUE;
+ enum output_format format = FORMAT_LINES;
int all_keys = 0;
struct option options[] = {
OPT_CALLBACK_F(0, "format", &format, N_("format"),
@@ -185,7 +185,8 @@ static int cmd_repo_info(int argc, const char **argv, const char *prefix,
};
argc = parse_options(argc, argv, prefix, options, repo_usage, 0);
- if (format != FORMAT_KEYVALUE && format != FORMAT_NUL_TERMINATED)
+
+ if (format != FORMAT_LINES && format != FORMAT_NUL_TERMINATED)
die(_("unsupported output format"));
if (all_keys && argc)
@@ -671,7 +672,7 @@ static int cmd_repo_structure(int argc, const char **argv, const char *prefix,
stats_table_setup_structure(&table, &stats);
stats_table_print_structure(&table);
break;
- case FORMAT_KEYVALUE:
+ case FORMAT_LINES:
structure_keyvalue_print(&stats, '=', '\n');
break;
case FORMAT_NUL_TERMINATED:
diff --git a/t/t1900-repo.sh b/t/t1900-repo.sh
index 51d55f11a5..4155211e5d 100755
--- a/t/t1900-repo.sh
+++ b/t/t1900-repo.sh
@@ -34,7 +34,7 @@ test_repo_info () {
eval "$init_command $repo_name"
'
- test_expect_success "keyvalue: $label" '
+ test_expect_success "lines: $label" '
echo "$key=$expected_value" > expect &&
git -C "$repo_name" repo info "$key" >actual &&
test_cmp expect actual
@@ -115,7 +115,7 @@ test_expect_success '-z uses nul-terminated format' '
test_expect_success 'git repo info uses the last requested format' '
echo "layout.bare=false" >expected &&
- git repo info --format=nul -z --format=keyvalue layout.bare >actual &&
+ git repo info --format=nul -z --format=lines layout.bare >actual &&
test_cmp expected actual
'
diff --git a/t/t1901-repo-structure.sh b/t/t1901-repo-structure.sh
index 17ff164b05..a6f2591d9a 100755
--- a/t/t1901-repo-structure.sh
+++ b/t/t1901-repo-structure.sh
@@ -113,7 +113,7 @@ test_expect_success SHA1 'repository with references and objects' '
)
'
-test_expect_success SHA1 'keyvalue and nul format' '
+test_expect_success SHA1 'lines and nul format' '
test_when_finished "rm -rf repo" &&
git init repo &&
(
@@ -140,7 +140,7 @@ test_expect_success SHA1 'keyvalue and nul format' '
objects.tags.disk_size=$(object_type_disk_usage tag)
EOF
- git repo structure --format=keyvalue >out 2>err &&
+ git repo structure --format=lines >out 2>err &&
test_cmp expect out &&
test_line_count = 0 err &&
--
2.50.1 (Apple Git-155)
next prev parent reply other threads:[~2026-01-23 16:49 UTC|newest]
Thread overview: 40+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-12-07 19:02 [PATCH] repo: add new flag --keys to git-repo-info Lucas Seiki Oshiro
2025-12-07 22:14 ` Junio C Hamano
2025-12-08 16:33 ` Lucas Seiki Oshiro
2025-12-08 7:13 ` Patrick Steinhardt
2025-12-09 19:36 ` [PATCH v2 0/2] " Lucas Seiki Oshiro
2025-12-09 19:36 ` [PATCH v2 1/2] repo: add a default output format to enum output_format Lucas Seiki Oshiro
2026-01-05 14:18 ` Patrick Steinhardt
2026-01-07 21:28 ` Lucas Seiki Oshiro
2026-01-08 6:13 ` Patrick Steinhardt
2025-12-09 19:36 ` [PATCH v2 2/2] repo: add new flag --keys to git-repo-info Lucas Seiki Oshiro
2026-01-05 14:18 ` Patrick Steinhardt
2026-01-05 13:57 ` [PATCH v2 0/2] " Lucas Seiki Oshiro
2026-01-05 14:19 ` Patrick Steinhardt
2026-01-09 20:31 ` [PATCH v3 0/2] repo: add --format=default and --keys Lucas Seiki Oshiro
2026-01-10 6:48 ` Junio C Hamano
2026-01-10 7:02 ` Junio C Hamano
2026-01-09 20:31 ` [PATCH v3 1/2] repo: add a default output format to enum output_format Lucas Seiki Oshiro
2026-01-09 20:31 ` [PATCH v3 2/2] repo: add new flag --keys to git-repo-info Lucas Seiki Oshiro
2026-01-10 12:04 ` Jean-Noël AVILA
2026-01-10 22:00 ` Lucas Seiki Oshiro
2026-01-12 8:40 ` Patrick Steinhardt
2026-01-19 20:20 ` [PATCH v4 0/2] repo: add --format=default and --keys Lucas Seiki Oshiro
2026-01-19 20:20 ` [PATCH v4 1/2] repo: add a default output format to enum output_format Lucas Seiki Oshiro
2026-01-19 20:20 ` [PATCH v4 2/2] repo: add new flag --keys to git-repo-info Lucas Seiki Oshiro
2026-01-20 6:05 ` Patrick Steinhardt
2026-01-20 23:11 ` Lucas Seiki Oshiro
2026-01-21 7:19 ` Patrick Steinhardt
2026-01-21 14:38 ` Lucas Seiki Oshiro
2026-01-20 0:52 ` [PATCH v4 0/2] repo: add --format=default and --keys Junio C Hamano
2026-01-23 16:34 ` [PATCH v5 0/2] repo: add --keys and rename "keyvalue" to "lines" Lucas Seiki Oshiro
2026-01-23 16:34 ` Lucas Seiki Oshiro [this message]
2026-01-27 6:58 ` [PATCH v5 1/2] repo: " Patrick Steinhardt
2026-01-23 16:34 ` [PATCH v5 2/2] repo: add new flag --keys to git-repo-info Lucas Seiki Oshiro
2026-01-27 6:58 ` Patrick Steinhardt
2026-01-27 22:27 ` Lucas Seiki Oshiro
2026-02-14 0:35 ` [PATCH v6 0/2] repo: add --keys and rename "keyvalue" to "lines" Lucas Seiki Oshiro
2026-02-14 0:35 ` [PATCH v6 1/2] repo: rename the output format " Lucas Seiki Oshiro
2026-02-14 0:35 ` [PATCH v6 2/2] repo: add new flag --keys to git-repo-info Lucas Seiki Oshiro
2026-02-14 18:14 ` [PATCH v6 0/2] repo: add --keys and rename "keyvalue" to "lines" Junio C Hamano
2026-02-16 6:59 ` Patrick Steinhardt
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20260123164900.35092-2-lucasseikioshiro@gmail.com \
--to=lucasseikioshiro@gmail$(echo .)com \
--cc=avila.jn@gmail$(echo .)com \
--cc=git@vger$(echo .)kernel.org \
--cc=gitster@pobox$(echo .)com \
--cc=jltobler@gmail$(echo .)com \
--cc=ps@pks$(echo .)im \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox