| Message ID | 20201205013918.18981-4-avarab@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | None | expand |
On Sat, Dec 5, 2020 at 2:39 AM Ævar Arnfjörð Bjarmason <avarab@gmail.com> wrote: > > Add support for a "keyonly". This allows for easier parsing out of the > key and value. Before if you didn't want to make assumptions about how > the key was formatted. You'd need to parse it out as e.g.: > > --pretty=format:'%H%x00%(trailers:separator=%x00%x00)' \ > '%x00%(trailers:separator=%x00%x00,valueonly)' > > And then proceed to deduce keys by looking at those two and > subtracting the value plus the hardcoded ": " separator from the > non-valueonly %(trailers) line. Now it's possible to simply do: > > --pretty=format:'%H%x00%(trailers:separator=%x00%x00,keyonly)' \ > '%x00%(trailers:separator=%x00%x00,valueonly)' > > Which at least reduces it to a state machine where you get N keys and > correlate them with N values. Even better would be to have a way to > change the ": " delimiter to something easily machine-readable (a key > might contain ": " too). A follow-up change will add support for that. Well explained. > diff --git a/trailer.c b/trailer.c > index b00b35ea0eb..40f31e4dfc2 100644 > --- a/trailer.c > +++ b/trailer.c > @@ -1233,8 +1233,11 @@ static void format_trailer_info(struct strbuf *out, > if (opts->separator && out->len != origlen) > strbuf_addbuf(out, opts->separator); > if (!opts->value_only) > - strbuf_addf(out, "%s: ", tok.buf); > - strbuf_addbuf(out, &val); > + strbuf_addstr(out, tok.buf); Maybe `strbuf_addbuf(out, &tok);` > + if (!opts->key_only && !opts->value_only) > + strbuf_addstr(out, ": "); > + if (!opts->key_only) > + strbuf_addbuf(out, &val); The above is probably correct, but it feels strange to write the key after the separator and the value, and that the key is in a variable called "val".
On Sat, Dec 05 2020, Christian Couder wrote: > On Sat, Dec 5, 2020 at 2:39 AM Ævar Arnfjörð Bjarmason <avarab@gmail.com> wrote: >> >> Add support for a "keyonly". This allows for easier parsing out of the >> key and value. Before if you didn't want to make assumptions about how >> the key was formatted. You'd need to parse it out as e.g.: >> >> --pretty=format:'%H%x00%(trailers:separator=%x00%x00)' \ >> '%x00%(trailers:separator=%x00%x00,valueonly)' >> >> And then proceed to deduce keys by looking at those two and >> subtracting the value plus the hardcoded ": " separator from the >> non-valueonly %(trailers) line. Now it's possible to simply do: >> >> --pretty=format:'%H%x00%(trailers:separator=%x00%x00,keyonly)' \ >> '%x00%(trailers:separator=%x00%x00,valueonly)' >> >> Which at least reduces it to a state machine where you get N keys and >> correlate them with N values. Even better would be to have a way to >> change the ": " delimiter to something easily machine-readable (a key >> might contain ": " too). A follow-up change will add support for that. > > Well explained. > >> diff --git a/trailer.c b/trailer.c >> index b00b35ea0eb..40f31e4dfc2 100644 >> --- a/trailer.c >> +++ b/trailer.c >> @@ -1233,8 +1233,11 @@ static void format_trailer_info(struct strbuf *out, >> if (opts->separator && out->len != origlen) >> strbuf_addbuf(out, opts->separator); >> if (!opts->value_only) >> - strbuf_addf(out, "%s: ", tok.buf); >> - strbuf_addbuf(out, &val); >> + strbuf_addstr(out, tok.buf); > > Maybe `strbuf_addbuf(out, &tok);` Much better, thanks. >> + if (!opts->key_only && !opts->value_only) >> + strbuf_addstr(out, ": "); >> + if (!opts->key_only) >> + strbuf_addbuf(out, &val); > > The above is probably correct, but it feels strange to write the key > after the separator and the value, and that the key is in a variable > called "val". We write them in the order "key -> sep -> value". with the logic of: if (!no_key) write_key(); if (!no_sep) write_sep(); if (!no_value) write_value(); So the &val here really is the value part.
diff --git a/Documentation/pretty-formats.txt b/Documentation/pretty-formats.txt index 8e066594624..d080f0d2476 100644 --- a/Documentation/pretty-formats.txt +++ b/Documentation/pretty-formats.txt @@ -284,8 +284,8 @@ multiple times the last occurance wins. ** 'unfold[=bool]': make it behave as if interpret-trailer's `--unfold` option was given. E.g., `%(trailers:only,unfold=true)` unfolds and shows all trailer lines. -** 'valueonly[=bool]': skip over the key part of the trailer line and only - show the value part. +** 'keyonly[=bool]': only show the key part of the trailer. +** 'valueonly[=bool]': only show the value part of the trailer. NOTE: Some placeholders may depend on other options given to the revision traversal engine. For example, the `%g*` reflog options will diff --git a/pretty.c b/pretty.c index 3c374abffe5..590f37489f6 100644 --- a/pretty.c +++ b/pretty.c @@ -1454,6 +1454,7 @@ static size_t format_commit_one(struct strbuf *sb, /* in UTF-8 */ opts.separator = &sepbuf; } else if (!match_placeholder_bool_arg(arg, "only", &arg, &opts.only_trailers) && !match_placeholder_bool_arg(arg, "unfold", &arg, &opts.unfold) && + !match_placeholder_bool_arg(arg, "keyonly", &arg, &opts.key_only) && !match_placeholder_bool_arg(arg, "valueonly", &arg, &opts.value_only)) break; } diff --git a/t/t4205-log-pretty-formats.sh b/t/t4205-log-pretty-formats.sh index bf9b30ff3d6..5dd080c19b2 100755 --- a/t/t4205-log-pretty-formats.sh +++ b/t/t4205-log-pretty-formats.sh @@ -715,12 +715,34 @@ test_expect_success '%(trailers:key) without value is error' ' test_cmp expect actual ' +test_expect_success '%(trailers:key=foo,keyonly) shows only keys' ' + git log --no-walk --pretty="format:%(trailers:keyonly)" >actual && + test_write_lines \ + "Signed-off-by" \ + "Acked-by" \ + "[ v2 updated patch description ]" \ + "Signed-off-by" >expect && + test_cmp expect actual +' + +test_expect_success '%(trailers:key=foo,keyonly) shows only key' ' + git log --no-walk --pretty="format:%(trailers:key=Acked-by,keyonly)" >actual && + echo "Acked-by" >expect && + test_cmp expect actual +' + test_expect_success '%(trailers:key=foo,valueonly) shows only value' ' git log --no-walk --pretty="format:%(trailers:key=Acked-by,valueonly)" >actual && echo "A U Thor <author@example.com>" >expect && test_cmp expect actual ' +test_expect_success '%(trailers:key=foo,keyonly,valueonly) shows nothing' ' + git log --no-walk --pretty="format:%(trailers:key=Acked-by,keyonly,valueonly)" >actual && + echo >expect && + test_cmp expect actual +' + test_expect_success 'pretty format %(trailers:separator) changes separator' ' git log --no-walk --pretty=format:"X%(trailers:separator=%x00,unfold)X" >actual && ( @@ -732,7 +754,7 @@ test_expect_success 'pretty format %(trailers:separator) changes separator' ' test_cmp expect actual ' -test_expect_success 'pretty format %(trailers) combining separator/key/valueonly' ' +test_expect_success 'pretty format %(trailers) combining separator/key/keyonly/valueonly' ' git commit --allow-empty -F - <<-\EOF && Important fix @@ -759,6 +781,13 @@ test_expect_success 'pretty format %(trailers) combining separator/key/valueonly "Does not close any tickets" \ "Another fix #567, #890" \ "Important fix #1234" >expect && + test_cmp expect actual && + + git log --pretty="%s% (trailers:separator=%x2c%x20,key=Closes,keyonly)" HEAD~3.. >actual && + test_write_lines \ + "Does not close any tickets" \ + "Another fix Closes, Closes" \ + "Important fix Closes" >expect && test_cmp expect actual ' diff --git a/trailer.c b/trailer.c index b00b35ea0eb..40f31e4dfc2 100644 --- a/trailer.c +++ b/trailer.c @@ -1233,8 +1233,11 @@ static void format_trailer_info(struct strbuf *out, if (opts->separator && out->len != origlen) strbuf_addbuf(out, opts->separator); if (!opts->value_only) - strbuf_addf(out, "%s: ", tok.buf); - strbuf_addbuf(out, &val); + strbuf_addstr(out, tok.buf); + if (!opts->key_only && !opts->value_only) + strbuf_addstr(out, ": "); + if (!opts->key_only) + strbuf_addbuf(out, &val); if (!opts->separator) strbuf_addch(out, '\n'); } diff --git a/trailer.h b/trailer.h index aad856da8c1..d4507b4ef2a 100644 --- a/trailer.h +++ b/trailer.h @@ -71,9 +71,11 @@ struct process_trailer_options { int only_input; int unfold; int no_divider; + int key_only; int value_only; int canonicalize; const struct strbuf *separator; + const struct strbuf *key_value_separator; int (*filter)(const struct strbuf *, const char *alias, void *); void *filter_data; };
Add support for a "keyonly". This allows for easier parsing out of the key and value. Before if you didn't want to make assumptions about how the key was formatted. You'd need to parse it out as e.g.: --pretty=format:'%H%x00%(trailers:separator=%x00%x00)' \ '%x00%(trailers:separator=%x00%x00,valueonly)' And then proceed to deduce keys by looking at those two and subtracting the value plus the hardcoded ": " separator from the non-valueonly %(trailers) line. Now it's possible to simply do: --pretty=format:'%H%x00%(trailers:separator=%x00%x00,keyonly)' \ '%x00%(trailers:separator=%x00%x00,valueonly)' Which at least reduces it to a state machine where you get N keys and correlate them with N values. Even better would be to have a way to change the ": " delimiter to something easily machine-readable (a key might contain ": " too). A follow-up change will add support for that. Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> --- Documentation/pretty-formats.txt | 4 ++-- pretty.c | 1 + t/t4205-log-pretty-formats.sh | 31 ++++++++++++++++++++++++++++++- trailer.c | 7 +++++-- trailer.h | 2 ++ 5 files changed, 40 insertions(+), 5 deletions(-)