repo: rename the output format "keyvalue" to "lines"

Both subcommands in git-repo(1) accept the "keyvalue" format. This
format is newline-delimited, where the key is separated from the
value with an equals sign.

The name of this option is suboptimal though, as it is both too
limiting while at the same time not really indicating what it
actually does:

  - There is no mention of the format being newline-delimited, which
    is the key differentiator to the "nul" format.

  - Both "nul" and "keyvalue" have a key and a value, so the latter
    is not exactly giving any hint what makes it so special.

  - "keyvalue" requires there to be, well, a key and a value, but we
    want to add additional output that is only going to be newline
    delimited.

Taken together, "keyvalue" is kind of a bad name for this output
format.

Luckily, the git-repo(1) command is still rather new and marked as
experimental, so things aren't cast into stone yet. Rename the
format to "lines" instead to better indicate that the major
difference is that we'll get newline-delimited output. This new name
will also be a better fit for a subsequent extension in git-repo(1).

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>

diff --git a/Documentation/git-repo.adoc b/Documentation/git-repo.adoc
index 7d70270dfa57163faa22e339ea134a8cf2216984..693e1bbced3a5a70d2a5b82ebab2b301c69eb5f9 100644 (file)
--- 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 0ea045abc13f8c42ddf49031e181246774819021..23c5ee88b0bfbd657688981c39be74ae895fd248 100644 (file)
--- 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_NEWLINE_TERMINATED,
        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_NEWLINE_TERMINATED:
                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_NEWLINE_TERMINATED;
        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_NEWLINE_TERMINATED;
        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_NEWLINE_TERMINATED && 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_NEWLINE_TERMINATED:
                structure_keyvalue_print(&stats, '=', '\n');
                break;
        case FORMAT_NUL_TERMINATED:

diff --git a/t/t1900-repo.sh b/t/t1900-repo.sh
index 51d55f11a5ed664bc5927b12677f56ad76f32070..4155211e5d73e2e536b1026d9e458ee1ffd82cba 100755 (executable)
--- 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 17ff164b0596c9778cf7e1af2c3abe9373236e53..a6f2591d9a61ff15c14e693ca1af72c549f9c99d 100755 (executable)
--- 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 &&