Skip to content

Commit 155caac

Browse files
lucasoshirogitster
authored andcommitted
repo: add --all to git-repo-info
Add a new flag `--all` to git-repo-info for requesting values for all the available keys. By using this flag, the user can retrieve all the values instead of searching what are the desired keys for what they wants. Helped-by: Karthik Nayak <karthik.188@gmail.com> Helped-by: Patrick Steinhardt <ps@pks.im> Signed-off-by: Lucas Seiki Oshiro <lucasseikioshiro@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
1 parent fd7d79d commit 155caac

File tree

3 files changed

+51
-5
lines changed

3 files changed

+51
-5
lines changed

Documentation/git-repo.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ git-repo - Retrieve information about the repository
88
SYNOPSIS
99
--------
1010
[synopsis]
11-
git repo info [--format=(keyvalue|nul)] [-z] [<key>...]
11+
git repo info [--format=(keyvalue|nul)] [-z] [--all | <key>...]
1212
git repo structure [--format=(table|keyvalue|nul)]
1313

1414
DESCRIPTION
@@ -19,13 +19,13 @@ THIS COMMAND IS EXPERIMENTAL. THE BEHAVIOR MAY CHANGE.
1919

2020
COMMANDS
2121
--------
22-
`info [--format=(keyvalue|nul)] [-z] [<key>...]`::
22+
`info [--format=(keyvalue|nul)] [-z] [--all | <key>...]`::
2323
Retrieve metadata-related information about the current repository. Only
2424
the requested data will be returned based on their keys (see "INFO KEYS"
2525
section below).
2626
+
2727
The values are returned in the same order in which their respective keys were
28-
requested.
28+
requested. The `--all` flag requests the values for all the available keys.
2929
+
3030
The output format can be chosen through the flag `--format`. Two formats are
3131
supported:

builtin/repo.c

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
#include "utf8.h"
1616

1717
static const char *const repo_usage[] = {
18-
"git repo info [--format=(keyvalue|nul)] [-z] [<key>...]",
18+
"git repo info [--format=(keyvalue|nul)] [-z] [--all | <key>...]",
1919
"git repo structure [--format=(table|keyvalue|nul)]",
2020
NULL
2121
};
@@ -129,6 +129,23 @@ static int print_fields(int argc, const char **argv,
129129
return ret;
130130
}
131131

132+
static int print_all_fields(struct repository *repo,
133+
enum output_format format)
134+
{
135+
struct strbuf valbuf = STRBUF_INIT;
136+
137+
for (size_t i = 0; i < ARRAY_SIZE(repo_info_fields); i++) {
138+
const struct field *field = &repo_info_fields[i];
139+
140+
strbuf_reset(&valbuf);
141+
field->get_value(repo, &valbuf);
142+
print_field(format, field->key, valbuf.buf);
143+
}
144+
145+
strbuf_release(&valbuf);
146+
return 0;
147+
}
148+
132149
static int parse_format_cb(const struct option *opt,
133150
const char *arg, int unset UNUSED)
134151
{
@@ -152,6 +169,7 @@ static int cmd_repo_info(int argc, const char **argv, const char *prefix,
152169
struct repository *repo)
153170
{
154171
enum output_format format = FORMAT_KEYVALUE;
172+
int all_keys = 0;
155173
struct option options[] = {
156174
OPT_CALLBACK_F(0, "format", &format, N_("format"),
157175
N_("output format"),
@@ -160,14 +178,21 @@ static int cmd_repo_info(int argc, const char **argv, const char *prefix,
160178
N_("synonym for --format=nul"),
161179
PARSE_OPT_NONEG | PARSE_OPT_NOARG,
162180
parse_format_cb),
181+
OPT_BOOL(0, "all", &all_keys, N_("print all keys/values")),
163182
OPT_END()
164183
};
165184

166185
argc = parse_options(argc, argv, prefix, options, repo_usage, 0);
167186
if (format != FORMAT_KEYVALUE && format != FORMAT_NUL_TERMINATED)
168187
die(_("unsupported output format"));
169188

170-
return print_fields(argc, argv, repo, format);
189+
if (all_keys && argc)
190+
die(_("--all and <key> cannot be used together"));
191+
192+
if (all_keys)
193+
return print_all_fields(repo, format);
194+
else
195+
return print_fields(argc, argv, repo, format);
171196
}
172197

173198
struct ref_stats {

t/t1900-repo.sh

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,15 @@ test_description='test git repo-info'
44

55
. ./test-lib.sh
66

7+
# git-repo-info keys. It must contain the same keys listed in the const
8+
# repo_info_fields, in lexicographical order.
9+
REPO_INFO_KEYS='
10+
layout.bare
11+
layout.shallow
12+
object.format
13+
references.format
14+
'
15+
716
# Test whether a key-value pair is correctly returned
817
#
918
# Usage: test_repo_info <label> <init command> <repo_name> <key> <expected value>
@@ -110,4 +119,16 @@ test_expect_success 'git repo info uses the last requested format' '
110119
test_cmp expected actual
111120
'
112121

122+
test_expect_success 'git repo info --all returns all key-value pairs' '
123+
git repo info $REPO_INFO_KEYS >expect &&
124+
git repo info --all >actual &&
125+
test_cmp expect actual
126+
'
127+
128+
test_expect_success 'git repo info --all <key> aborts' '
129+
echo "fatal: --all and <key> cannot be used together" >expect &&
130+
test_must_fail git repo info --all object.format 2>actual &&
131+
test_cmp expect actual
132+
'
133+
113134
test_done

0 commit comments

Comments
 (0)