All of lore.kernel.org
 help / color / mirror / Atom feed
From: Anders Waldenborg <anders@0x63.nu>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>, Jeff King <peff@peff.net>,
	Anders Waldenborg <anders@0x63.nu>
Subject: [PATCH v5 2/7] pretty: Allow %(trailers) options with explicit value
Date: Mon, 28 Jan 2019 22:33:32 +0100	[thread overview]
Message-ID: <20190128213337.24752-3-anders@0x63.nu> (raw)
In-Reply-To: <20190128213337.24752-1-anders@0x63.nu>

In addition to old %(trailers:only) it is now allowed to write
%(trailers:only=yes)

By itself this only gives (the not quite so useful) possibility to have
users change their mind in the middle of a formatting
string (%(trailers:only=true,only=false)). However, it gives users the
opportunity to override defaults from future options.

Signed-off-by: Anders Waldenborg <anders@0x63.nu>
---
 Documentation/pretty-formats.txt | 14 ++++++---
 pretty.c                         | 52 +++++++++++++++++++++++++++-----
 t/t4205-log-pretty-formats.sh    | 18 +++++++++++
 3 files changed, 73 insertions(+), 11 deletions(-)

diff --git a/Documentation/pretty-formats.txt b/Documentation/pretty-formats.txt
index 86d804fe97..d33b072eb2 100644
--- a/Documentation/pretty-formats.txt
+++ b/Documentation/pretty-formats.txt
@@ -225,10 +225,16 @@ endif::git-rev-list[]
                           linkgit:git-interpret-trailers[1]. The
                           `trailers` string may be followed by a colon
                           and zero or more comma-separated options:
-** 'only': omit non-trailer lines from the trailer block.
-** 'unfold': make it behave as if interpret-trailer's `--unfold`
-   option was given. E.g., `%(trailers:only,unfold)` unfolds and
-   shows all trailer lines.
+** 'only[=val]': select whether non-trailer lines from the trailer
+   block should be included. The `only` keyword may optionally be
+   followed by an equal sign and one of `true`, `on`, `yes` to omit or
+   `false`, `off`, `no` to show the non-trailer lines. If option is
+   given without value it is enabled. If given multiple times the last
+   value is used.
+** 'unfold[=val]': make it behave as if interpret-trailer's `--unfold`
+   option was given. In same way as to for `only` it can be followed
+   by an equal sign and explicit value. E.g.,
+   `%(trailers:only,unfold=true)` unfolds and shows all trailer lines.
 
 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 b83a3ecd23..b8d71a57c9 100644
--- a/pretty.c
+++ b/pretty.c
@@ -1056,13 +1056,25 @@ static size_t parse_padding_placeholder(struct strbuf *sb,
 	return 0;
 }
 
-static int match_placeholder_arg(const char *to_parse, const char *candidate,
-				 const char **end)
+static int match_placeholder_arg_value(const char *to_parse, const char *candidate,
+				       const char **end, const char **valuestart, size_t *valuelen)
 {
 	const char *p;
 
 	if (!(skip_prefix(to_parse, candidate, &p)))
 		return 0;
+	if (valuestart) {
+		if (*p == '=') {
+			*valuestart = p + 1;
+			*valuelen = strcspn(*valuestart, ",)");
+			p = *valuestart + *valuelen;
+		} else {
+			if (*p != ',' && *p != ')')
+				return 0;
+			*valuestart = NULL;
+			*valuelen = 0;
+		}
+	}
 	if (*p == ',') {
 		*end = p + 1;
 		return 1;
@@ -1074,6 +1086,35 @@ static int match_placeholder_arg(const char *to_parse, const char *candidate,
 	return 0;
 }
 
+static int match_placeholder_bool_arg(const char *to_parse, const char *candidate,
+				      const char **end, int *val)
+{
+	char buf[8];
+	const char *strval;
+	size_t len;
+	int v;
+
+	if (!match_placeholder_arg_value(to_parse, candidate, end, &strval, &len))
+		return 0;
+
+	if (!strval) {
+		*val = 1;
+		return 1;
+	}
+
+	strlcpy(buf, strval, sizeof(buf));
+	if (len < sizeof(buf))
+		buf[len] = 0;
+
+	v = git_parse_maybe_bool(buf);
+	if (v == -1)
+		return 0;
+
+	*val = v;
+
+	return 1;
+}
+
 static size_t format_commit_one(struct strbuf *sb, /* in UTF-8 */
 				const char *placeholder,
 				void *context)
@@ -1318,11 +1359,8 @@ static size_t format_commit_one(struct strbuf *sb, /* in UTF-8 */
 		if (*arg == ':') {
 			arg++;
 			for (;;) {
-				if (match_placeholder_arg(arg, "only", &arg))
-					opts.only_trailers = 1;
-				else if (match_placeholder_arg(arg, "unfold", &arg))
-					opts.unfold = 1;
-				else
+				if (!match_placeholder_bool_arg(arg, "only", &arg, &opts.only_trailers) &&
+				    !match_placeholder_bool_arg(arg, "unfold", &arg, &opts.unfold))
 					break;
 			}
 		}
diff --git a/t/t4205-log-pretty-formats.sh b/t/t4205-log-pretty-formats.sh
index 978a8a66ff..63730a4ec0 100755
--- a/t/t4205-log-pretty-formats.sh
+++ b/t/t4205-log-pretty-formats.sh
@@ -578,6 +578,24 @@ test_expect_success '%(trailers:only) shows only "key: value" trailers' '
 	test_cmp expect actual
 '
 
+test_expect_success '%(trailers:only=yes) shows only "key: value" trailers' '
+	git log --no-walk --pretty=format:"%(trailers:only=yes)" >actual &&
+	grep -v patch.description <trailers >expect &&
+	test_cmp expect actual
+'
+
+test_expect_success '%(trailers:only=no) shows all trailers' '
+	git log --no-walk --pretty=format:"%(trailers:only=no)" >actual &&
+	cat trailers >expect &&
+	test_cmp expect actual
+'
+
+test_expect_success '%(trailers:only=no,only=true) shows only "key: value" trailers' '
+	git log --no-walk --pretty=format:"%(trailers:only=yes)" >actual &&
+	grep -v patch.description <trailers >expect &&
+	test_cmp expect actual
+'
+
 test_expect_success '%(trailers:unfold) unfolds trailers' '
 	git log --no-walk --pretty="%(trailers:unfold)" >actual &&
 	{
-- 
2.17.1


  parent reply	other threads:[~2019-01-28 21:51 UTC|newest]

Thread overview: 69+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-10-28 12:50 [PATCH] pretty: Add %(trailer:X) to display single trailer Anders Waldenborg
2018-10-29  4:49 ` Junio C Hamano
2018-10-29 14:14 ` Jeff King
2018-10-29 17:05   ` Anders Waldenborg
2018-10-31 20:27     ` Jeff King
2018-10-31 23:01       ` Anders Waldenborg
2018-11-01 18:42         ` Jeff King
2018-11-04 15:22 ` [PATCH v2 0/5] %(trailers) improvements in pretty format Anders Waldenborg
2018-11-04 15:22   ` [PATCH v2 1/5] pretty: single return path in %(trailers) handling Anders Waldenborg
2018-11-04 15:22   ` [PATCH v2 2/5] pretty: allow showing specific trailers Anders Waldenborg
2018-11-04 18:14     ` Eric Sunshine
2018-11-05  3:48       ` Junio C Hamano
2018-11-05  3:52         ` Eric Sunshine
2018-11-05  8:26       ` Anders Waldenborg
2018-11-05  9:00         ` Eric Sunshine
2018-11-05  5:14     ` Junio C Hamano
2018-11-04 15:22   ` [PATCH v2 3/5] pretty: add support for "nokey" option in %(trailers) Anders Waldenborg
2018-11-04 15:22   ` [PATCH v2 4/5] pretty: extract fundamental placeholders to separate function Anders Waldenborg
2018-11-05  2:06     ` Junio C Hamano
2018-11-05  8:32       ` Anders Waldenborg
2018-11-06  1:46         ` Junio C Hamano
2018-11-04 15:22   ` [PATCH v2 5/5] pretty: add support for separator option in %(trailers) Anders Waldenborg
2018-11-05  2:10     ` Junio C Hamano
2018-11-05 18:24       ` Anders Waldenborg
2018-11-06  1:48         ` Junio C Hamano
2018-11-05  5:18     ` Junio C Hamano
2018-11-04 17:40   ` [PATCH v2 0/5] %(trailers) improvements in pretty format Eric Sunshine
2018-11-05  7:09     ` Anders Waldenborg
2018-11-18 11:44   ` [PATCH v3 " Anders Waldenborg
2018-11-18 11:44     ` [PATCH v3 1/5] pretty: single return path in %(trailers) handling Anders Waldenborg
2018-11-18 11:44     ` [PATCH v3 2/5] pretty: allow showing specific trailers Anders Waldenborg
2018-11-20  5:45       ` Junio C Hamano
2018-11-20  5:59       ` Junio C Hamano
2018-11-25 23:02         ` Anders Waldenborg
2018-11-26  3:13           ` Junio C Hamano
2018-11-26  6:56             ` Anders Waldenborg
2018-11-26  7:52               ` Junio C Hamano
2018-11-18 11:44     ` [PATCH v3 3/5] pretty: add support for "valueonly" option in %(trailers) Anders Waldenborg
2018-11-20  8:14       ` Eric Sunshine
2018-11-18 11:44     ` [PATCH v3 4/5] strbuf: separate callback for strbuf_expand:ing literals Anders Waldenborg
2018-11-18 11:44     ` [PATCH v3 5/5] pretty: add support for separator option in %(trailers) Anders Waldenborg
2018-11-20  8:25       ` Eric Sunshine
2018-12-08 16:36 ` [PATCH v4 0/7] %(trailers) improvements in pretty format Anders Waldenborg
2018-12-08 16:36   ` [PATCH v4 1/7] doc: group pretty-format.txt placeholders descriptions Anders Waldenborg
2018-12-08 16:36   ` [PATCH v4 2/7] pretty: allow %(trailers) options with explicit value Anders Waldenborg
2018-12-10  8:45     ` Junio C Hamano
2018-12-18 21:30       ` Anders Waldenborg
2019-01-29 16:55         ` Jeff King
2019-01-29 21:23           ` Anders Waldenborg
     [not found]             ` <CAL21Bmmx=EO+R2t+KviNekDhU3fc0wjCcmUmbzLa14bb0PAmHA@mail.gmail.com>
2019-01-31 18:46               ` Anders Waldenborg
2019-02-02  9:14                 ` Оля Тележная
2018-12-08 16:36   ` [PATCH v4 3/7] pretty: single return path in %(trailers) handling Anders Waldenborg
2018-12-08 16:36   ` [PATCH v4 4/7] pretty: allow showing specific trailers Anders Waldenborg
2018-12-10  8:56     ` Junio C Hamano
2018-12-08 16:36   ` [PATCH v4 5/7] pretty: add support for "valueonly" option in %(trailers) Anders Waldenborg
2018-12-08 16:36   ` [PATCH v4 6/7] strbuf: separate callback for strbuf_expand:ing literals Anders Waldenborg
2018-12-08 16:36   ` [PATCH v4 7/7] pretty: add support for separator option in %(trailers) Anders Waldenborg
2019-01-28 21:33 ` [PATCH v5 0/7] %(trailers) improvements in pretty format Anders Waldenborg
2019-01-28 21:33   ` [PATCH v5 1/7] doc: group pretty-format.txt placeholders descriptions Anders Waldenborg
2019-01-28 21:33   ` Anders Waldenborg [this message]
2019-01-28 22:38     ` [PATCH v5 2/7] pretty: Allow %(trailers) options with explicit value Junio C Hamano
2019-01-29  6:45       ` Anders Waldenborg
2019-01-29 16:57         ` Jeff King
2019-01-29  6:49       ` [PATCH v5 2/7 update] pretty: allow " Anders Waldenborg
2019-01-28 21:33   ` [PATCH v5 3/7] pretty: single return path in %(trailers) handling Anders Waldenborg
2019-01-28 21:33   ` [PATCH v5 4/7] pretty: allow showing specific trailers Anders Waldenborg
2019-01-28 21:33   ` [PATCH v5 5/7] pretty: add support for "valueonly" option in %(trailers) Anders Waldenborg
2019-01-28 21:33   ` [PATCH v5 6/7] strbuf: separate callback for strbuf_expand:ing literals Anders Waldenborg
2019-01-28 21:33   ` [PATCH v5 7/7] pretty: add support for separator option in %(trailers) Anders Waldenborg

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20190128213337.24752-3-anders@0x63.nu \
    --to=anders@0x63.nu \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=peff@peff.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.