Merge branch 'lo/repo-info-step-2'

"repo info" learns a short-hand option "-z" that is the same as
"--format=nul", and learns to report the objects format used in the
repository.

* lo/repo-info-step-2:
  repo: add the field objects.format
  repo: add the flag -z as an alias for --format=nul
main
Junio C Hamano 2025-09-15 08:52:05 -07:00
commit 13d1e86888
3 changed files with 58 additions and 14 deletions

View File

@ -8,7 +8,7 @@ git-repo - Retrieve information about the repository
SYNOPSIS
--------
[synopsis]
git repo info [--format=(keyvalue|nul)] [<key>...]
git repo info [--format=(keyvalue|nul)] [-z] [<key>...]

DESCRIPTION
-----------
@ -18,7 +18,7 @@ THIS COMMAND IS EXPERIMENTAL. THE BEHAVIOR MAY CHANGE.

COMMANDS
--------
`info [--format=(keyvalue|nul)] [<key>...]`::
`info [--format=(keyvalue|nul)] [-z] [<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).
@ -40,6 +40,8 @@ supported:
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.
+
`-z` is an alias for `--format=nul`.

INFO KEYS
---------
@ -53,6 +55,9 @@ values that they return:
`layout.shallow`::
`true` if this is a shallow repository, otherwise `false`.

`object.format`::
The object format (hash algorithm) used in the repository.

`references.format`::
The reference storage format. The valid values are:
+

View File

@ -9,7 +9,7 @@
#include "shallow.h"

static const char *const repo_usage[] = {
"git repo info [--format=(keyvalue|nul)] [<key>...]",
"git repo info [--format=(keyvalue|nul)] [-z] [<key>...]",
NULL
};

@ -38,6 +38,12 @@ static int get_layout_shallow(struct repository *repo, struct strbuf *buf)
return 0;
}

static int get_object_format(struct repository *repo, struct strbuf *buf)
{
strbuf_addstr(buf, repo->hash_algo->name);
return 0;
}

static int get_references_format(struct repository *repo, struct strbuf *buf)
{
strbuf_addstr(buf,
@ -49,6 +55,7 @@ static int get_references_format(struct repository *repo, struct strbuf *buf)
static const struct field repo_info_fields[] = {
{ "layout.bare", get_layout_bare },
{ "layout.shallow", get_layout_shallow },
{ "object.format", get_object_format },
{ "references.format", get_references_format },
};

@ -112,26 +119,40 @@ static int print_fields(int argc, const char **argv,
return ret;
}

static int parse_format_cb(const struct option *opt,
const char *arg, int unset UNUSED)
{
enum output_format *format = opt->value;

if (opt->short_name == 'z')
*format = FORMAT_NUL_TERMINATED;
else if (!strcmp(arg, "nul"))
*format = FORMAT_NUL_TERMINATED;
else if (!strcmp(arg, "keyvalue"))
*format = FORMAT_KEYVALUE;
else
die(_("invalid format '%s'"), arg);

return 0;
}

static int repo_info(int argc, const char **argv, const char *prefix,
struct repository *repo)
{
const char *format_str = "keyvalue";
enum output_format format;
enum output_format format = FORMAT_KEYVALUE;
struct option options[] = {
OPT_STRING(0, "format", &format_str, N_("format"),
N_("output format")),
OPT_CALLBACK_F(0, "format", &format, N_("format"),
N_("output format"),
PARSE_OPT_NONEG, parse_format_cb),
OPT_CALLBACK_F('z', NULL, &format, NULL,
N_("synonym for --format=nul"),
PARSE_OPT_NONEG | PARSE_OPT_NOARG,
parse_format_cb),
OPT_END()
};

argc = parse_options(argc, argv, prefix, options, repo_usage, 0);

if (!strcmp(format_str, "keyvalue"))
format = FORMAT_KEYVALUE;
else if (!strcmp(format_str, "nul"))
format = FORMAT_NUL_TERMINATED;
else
die(_("invalid format '%s'"), format_str);

return print_fields(argc, argv, repo, format);
}


View File

@ -63,6 +63,12 @@ test_expect_success 'setup remote' '
test_repo_info 'shallow repository = true is retrieved correctly' \
'git clone --depth 1 "file://$PWD/remote"' 'shallow' 'layout.shallow' 'true'

test_repo_info 'object.format = sha1 is retrieved correctly' \
'git init --object-format=sha1' 'sha1' 'object.format' 'sha1'

test_repo_info 'object.format = sha256 is retrieved correctly' \
'git init --object-format=sha256' 'sha256' 'object.format' 'sha256'

test_expect_success 'values returned in order requested' '
cat >expect <<-\EOF &&
layout.bare=false
@ -92,4 +98,16 @@ test_expect_success 'git-repo-info aborts when requesting an invalid format' '
test_cmp expect actual
'

test_expect_success '-z uses nul-terminated format' '
printf "layout.bare\nfalse\0layout.shallow\nfalse\0" >expected &&
git repo info -z layout.bare layout.shallow >actual &&
test_cmp expected actual
'

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 &&
test_cmp expected actual
'

test_done