git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 4/5] pretty-format %(trailers): fix broken standalone "valueonly"

From
Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Date
Dec 5, 2020, 01:39 UTC
Message-ID
<20201205013918.18981-5-avarab@gmail.com>
In-Reply-To
<20201025212652.3003036-1-anders@0x63.nu>

Fix %(trailers:valueonly) being a noop due to on overly eager optimization. When new trailer options were added they needed to be listed at the start of the format_trailer_info() function. E.g. as was done in 250bea0c165 (pretty: allow showing specific trailers, 2019-01-28).

When d9b936db522 (pretty: add support for "valueonly" option in %(trailers), 2019-01-28) was added this was omitted by mistake. Thus %(trailers:valueonly) was a noop, instead of showing only trailer value. This wasn't caught because the tests for it always combined it with other options.

Let's fix the bug, and switch away from this pattern requiring us to remember to add new flags to the start of the function. Instead as soon as we see the ":" in "%(trailers:" we skip the fast path. That over-matches for "%(trailers:)", but I think that's OK.

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
---
 pretty.c                      |  2 ++
 t/t4205-log-pretty-formats.sh | 11 +++++++++++
 trailer.c                     |  3 +--
 trailer.h                     |  1 +
 4 files changed, 15 insertions(+), 2 deletions(-)
diff --git a/pretty.c b/pretty.c
index 590f37489f6..d989a6ae712 100644
--- a/pretty.c
+++ b/pretty.c
@@ -1426,6 +1426,8 @@ static size_t format_commit_one(struct strbuf *sb, /* in UTF-8 */
 		opts.no_divider = 1;
 
 		if (*arg == ':') {
+			/* over-matches on %(trailers:), but that's OK */
+			opts.have_options = 1;
 			arg++;
 			for (;;) {
 				const char *argval;
diff --git a/t/t4205-log-pretty-formats.sh b/t/t4205-log-pretty-formats.sh
index 5dd080c19b2..e1100082b34 100755
--- a/t/t4205-log-pretty-formats.sh
+++ b/t/t4205-log-pretty-formats.sh
@@ -737,6 +737,17 @@ test_expect_success '%(trailers:key=foo,valueonly) shows only value' '
 	test_cmp expect actual
 '
 
+test_expect_success '%(trailers:valueonly) shows only values' '
+	git log --no-walk --pretty="format:%(trailers:valueonly)" >actual &&
+	test_write_lines \
+		"A U Thor <author@example.com>" \
+		"A U Thor <author@example.com>" \
+		"[ v2 updated patch description ]" \
+		"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 &&
diff --git a/trailer.c b/trailer.c
index 40f31e4dfc2..da95e1f3c66 100644
--- a/trailer.c
+++ b/trailer.c
@@ -1206,8 +1206,7 @@ static void format_trailer_info(struct strbuf *out,
 	size_t origlen = out->len;
 	size_t i;
 
-	/* If we want the whole block untouched, we can take the fast path. */
-	if (!opts->only_trailers && !opts->unfold && !opts->filter && !opts->separator) {
+	if (!opts->have_options) {
 		strbuf_add(out, info->trailer_start,
 			   info->trailer_end - info->trailer_start);
 		return;
diff --git a/trailer.h b/trailer.h
index d4507b4ef2a..e348c970ce7 100644
--- a/trailer.h
+++ b/trailer.h
@@ -65,6 +65,7 @@ struct new_trailer_item {
 };
 
 struct process_trailer_options {
+	int have_options;
 	int in_place;
 	int trim_empty;
 	int only_trailers;
-- 
2.29.2.222.g5d2a92d10f8
Previous: Christian CouderNext: Christian Couder
Message 63 of 67 in “trailer fixes”
  1. 00/21 trailer fixesAnders Waldenborg, Oct 25, 2020
  2. 06/21 t4205: add test for trailer in log with nonstandard separatorAnders Waldenborg, Oct 25, 2020
  3. Christian CouderOct 26, 2020
  4. Anders WaldenborgNov 9, 2020
  5. Christian CouderNov 10, 2020
  6. Jeff KingNov 10, 2020
  7. 03/21 doc: mention canonicalization in git i-t manualAnders Waldenborg, Oct 25, 2020
  8. Christian CouderOct 26, 2020
  9. 19/21 trailer: move config lookup out of parse_trailerAnders Waldenborg, Oct 25, 2020
  10. 20/21 trailer: add failing tests for matching trailers against inputAnders Waldenborg, Oct 25, 2020
  11. 13/21 trailer: add option to make canonicalization optionalAnders Waldenborg, Oct 25, 2020
  12. Jeff KingNov 10, 2020
  13. 07/21 trailer: simplify 'arg_item' lifetimeAnders Waldenborg, Oct 25, 2020
  14. 14/21 trailer: move skipping of blank lines to own loop when finding trailerAnders Waldenborg, Oct 25, 2020
  15. 04/21 pretty: allow using aliases in %(trailer:key=xyz)Anders Waldenborg, Oct 25, 2020
  16. Christian CouderOct 26, 2020
  17. 09/21 trailer: refactor print_tok_val into taking itemAnders Waldenborg, Oct 25, 2020
  18. 10/21 trailer: move trailer token canonicalization print timeAnders Waldenborg, Oct 25, 2020
  19. 08/21 trailer: keep track of conf in trailer_itemAnders Waldenborg, Oct 25, 2020
  20. Jeff KingNov 10, 2020
  21. 17/21 trailer: don't treat line with prefix of known trailer as knownAnders Waldenborg, Oct 25, 2020
  22. Jeff KingNov 10, 2020
  23. 16/21 t7513: add failing test for configured trailing line classificationAnders Waldenborg, Oct 25, 2020
  24. 02/21 trailer: don't use 'struct arg_item' for storing configAnders Waldenborg, Oct 25, 2020
  25. 12/21 trailer: handle configured nondefault separators explicitlyAnders Waldenborg, Oct 25, 2020
  26. Jeff KingNov 10, 2020
  27. 11/21 trailer: remember separator used in inputAnders Waldenborg, Oct 25, 2020
  28. 18/21 trailer: factor out config lookup to separate functionAnders Waldenborg, Oct 25, 2020
  29. 05/21 trailer: rename 'free_all' to 'free_all_trailer_items'Anders Waldenborg, Oct 25, 2020
  30. Christian CouderOct 26, 2020
  31. Jeff KingNov 10, 2020
  32. 01/21 trailer: change token_{from,matches}_item into taking conf_infoAnders Waldenborg, Oct 25, 2020
  33. Christian CouderOct 26, 2020
  34. 15/21 trailer: factor out classify_trailer_lineAnders Waldenborg, Oct 25, 2020
  35. 21/21 trailer: only do prefix matching for configured trailers on commandlineAnders Waldenborg, Oct 25, 2020
  36. Christian CouderNov 10, 2020
  37. 1/5 pretty format %(trailers) test: split a long lineÆvar Arnfjörð Bjarmason, Dec 5, 2020
  38. 0/5 pretty format %(trailers): improve machine readabilityÆvar Arnfjörð Bjarmason, Dec 5, 2020
  39. Anders WaldenborgDec 5, 2020
  40. Ævar Arnfjörð BjarmasonDec 7, 2020
  41. 2/5 pretty format %(trailers) doc: avoid repetitionÆvar Arnfjörð Bjarmason, Dec 6, 2020
  42. Christian CouderDec 7, 2020
  43. 4/5 pretty format %(trailers): add a "keyonly"Ævar Arnfjörð Bjarmason, Dec 6, 2020
  44. Christian CouderDec 7, 2020
  45. 1/5 pretty format %(trailers) test: split a long lineÆvar Arnfjörð Bjarmason, Dec 6, 2020
  46. 3/5 pretty-format %(trailers): fix broken standalone "valueonly"Ævar Arnfjörð Bjarmason, Dec 6, 2020
  47. 0/5 pretty format %(trailers): improve machine readabilityÆvar Arnfjörð Bjarmason, Dec 6, 2020
  48. 1/5 pretty format %(trailers) test: split a long lineÆvar Arnfjörð Bjarmason, Dec 9, 2020
  49. 5/5 pretty format %(trailers): add a "key_value_separator"Ævar Arnfjörð Bjarmason, Dec 9, 2020
  50. 4/5 pretty format %(trailers): add a "keyonly"Ævar Arnfjörð Bjarmason, Dec 9, 2020
  51. 3/5 pretty-format %(trailers): fix broken standalone "valueonly"Ævar Arnfjörð Bjarmason, Dec 9, 2020
  52. 2/5 pretty format %(trailers) doc: avoid repetitionÆvar Arnfjörð Bjarmason, Dec 9, 2020
  53. Junio C HamanoDec 10, 2020
  54. 0/5 pretty format %(trailers): improve machine readabilityÆvar Arnfjörð Bjarmason, Dec 9, 2020
  55. Christian CouderDec 10, 2020
  56. Junio C HamanoDec 10, 2020
  57. 5/5 pretty format %(trailers): add a "key_value_separator"Ævar Arnfjörð Bjarmason, Dec 6, 2020
  58. 3/5 pretty format %(trailers): add a "keyonly"Ævar Arnfjörð Bjarmason, Dec 5, 2020
  59. Christian CouderDec 5, 2020
  60. Ævar Arnfjörð BjarmasonDec 5, 2020
  61. 2/5 pretty format %(trailers): avoid needless repetitionÆvar Arnfjörð Bjarmason, Dec 5, 2020
  62. Christian CouderDec 5, 2020
  63. 4/5 pretty-format %(trailers): fix broken standalone "valueonly"Ævar Arnfjörð Bjarmason, Dec 5, 2020
  64. Christian CouderDec 5, 2020
  65. 5/5 pretty format %(trailers): add a "key_value_separator"Ævar Arnfjörð Bjarmason, Dec 5, 2020
  66. Christian CouderDec 5, 2020
  67. Ævar Arnfjörð BjarmasonDec 5, 2020

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.