[PATCH v5 0/2] repo: add --keys and rename "keyvalue" to "lines"

Hi!

There are two main changes in this v5:

- the "keyvalue" output format of git-repo-info and git-repo-structure were
  both renamed by "lines"
- the "default" output format was dropped

This way:

- `git repo info` accepts --format=lines and --format=nul
- `git repo info --keys` accepts --format=lines and --format=nul
- `git repo structure` accepts --format=table, --format=lines and --format=nul

Lucas Seiki Oshiro (2):
  repo: rename "keyvalue" to "lines"
  repo: add new flag --keys to git-repo-info

 Documentation/git-repo.adoc | 32 +++++++++++++++--------
 builtin/repo.c              | 51 ++++++++++++++++++++++++++++++-------
 t/t1900-repo.sh             | 44 ++++++++++++++++++++++----------
 t/t1901-repo-structure.sh   |  4 +--
 4 files changed, 97 insertions(+), 34 deletions(-)

Range-diff against v4:
1:  7dabd62250 < -:  ---------- repo: add a default output format to enum output_format
-:  ---------- > 1:  f5448ce915 repo: rename "keyvalue" to "lines"
2:  fba621fc4f ! 2:  16bc72afe1 repo: add new flag --keys to git-repo-info
    @@ Documentation/git-repo.adoc
     @@ Documentation/git-repo.adoc: 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]
    + git repo info [--format=(lines|nul) | -z] [--all | <key>...]
    ++git repo info --keys [--format=(lines|nul) | -z]
    + git repo structure [--format=(table|lines|nul) | -z]

      DESCRIPTION
     @@ Documentation/git-repo.adoc: supported:
      +
      `-z` is an alias for `--format=nul`.

    -+`info --keys [--format=(default|lines|nul) | -z]`::
    ++`info --keys [--format=(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.
    ++	output the keys one per line. This is the default.
     +
     +`nul`:::
    -+	similar to `default`, but using a _NUL_ character after each value.
    ++	similar to `lines`, but using a _NUL_ character after each value.
     +
    - `structure [--format=(default|table|keyvalue|nul) | -z]`::
    + `structure [--format=(table|lines|nul) | -z]`::
      	Retrieve statistics about the current repository structure. The
      	following kinds of information are reported:

    @@ builtin/repo.c
     @@

      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]",
    + 	"git repo info [--format=(lines|nul) | -z] [--all | <key>...]",
    ++	"git repo info --keys [--format=(lines|nul) | -z]",
    + 	"git repo structure [--format=(table|lines|nul) | -z]",
      	NULL
      };
    -@@ builtin/repo.c: enum output_format {
    - 	FORMAT_TABLE,
    - 	FORMAT_KEYVALUE,
    - 	FORMAT_NUL_TERMINATED,
    -+	FORMAT_LINES
    - };
    -
    - struct field {
     @@ builtin/repo.c: static int print_all_fields(struct repository *repo,
      	return 0;
      }
    @@ builtin/repo.c: static int print_all_fields(struct repository *repo,
     +{
     +	char sep;
     +
    -+	if (format == FORMAT_DEFAULT)
    -+		format = FORMAT_LINES;
    -+
     +	switch (format) {
     +	case FORMAT_LINES:
     +		sep = '\n';
    @@ builtin/repo.c: static int print_all_fields(struct repository *repo,
     +		sep = '\0';
     +		break;
     +	default:
    -+		die(_("--keys can only be used with --format=default or --format=nul"));
    ++		die(_("--keys can only be used with --format=lines or --format=nul"));
     +	}
     +
     +	for (size_t i = 0; i < ARRAY_SIZE(repo_info_fields); i++) {
    @@ builtin/repo.c: static int print_all_fields(struct repository *repo,
      static int parse_format_cb(const struct option *opt,
      			   const char *arg, int unset UNUSED)
      {
    -@@ builtin/repo.c: 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
     @@ builtin/repo.c: static int cmd_repo_info(int argc, const char **argv, const char *prefix,
      {
    - 	enum output_format format = FORMAT_DEFAULT;
    + 	enum output_format format = FORMAT_LINES;
      	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
     +	if (show_keys)
     +		return print_keys(format);
     +
    - 	if (format == FORMAT_DEFAULT)
    - 		format = FORMAT_KEYVALUE;
    + 	if (format != FORMAT_LINES && format != FORMAT_NUL_TERMINATED)
    + 		die(_("unsupported output format"));

      ## 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 '--format=default resets the format' '
    +@@ 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=lines >lines &&
    ++	lf_to_nul <lines >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_expect_success 'git repo info --keys aborts when using --format other than lines or nul' '
    ++	echo "fatal: --keys can only be used with --format=lines or --format=nul" >expect &&
    ++	test_must_fail git repo info --keys --format=table 2>actual &&
     +	test_cmp expect actual
     +'
     +
    @@ t/t1900-repo.sh: test_expect_success '--format=default resets the format' '
     +
     +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
    ++	git repo info --keys >actual &&
    ++	test_cmp expect actual
     +'
     +
      test_done