From: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
To: git@vger.kernel.org
Cc: "Junio C Hamano" <gitster@pobox.com>,
"Anders Waldenborg" <anders@0x63.nu>,
christian.couder@gmail.com, peff@peff.net,
jonathantanmy@google.com, "Hariom Verma" <hariom18599@gmail.com>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Subject: [PATCH v3 0/5] pretty format %(trailers): improve machine readability
Date: Wed, 9 Dec 2020 16:52:03 +0100 [thread overview]
Message-ID: <20201209155208.17782-1-avarab@gmail.com> (raw)
In-Reply-To: <20201206002449.31452-1-avarab@gmail.com>
A minor iteration on v2 with a commit message wording change &
s/=BOOL/=<BOOL>/g in the docs, as suggested by Christian
Couder. Range-diff below:
Ævar Arnfjörð Bjarmason (5):
pretty format %(trailers) test: split a long line
pretty format %(trailers) doc: avoid repetition
pretty-format %(trailers): fix broken standalone "valueonly"
pretty format %(trailers): add a "keyonly"
pretty format %(trailers): add a "key_value_separator"
Documentation/pretty-formats.txt | 34 ++++++-----
pretty.c | 10 ++++
t/t4205-log-pretty-formats.sh | 99 +++++++++++++++++++++++++++++++-
trailer.c | 15 ++++-
trailer.h | 2 +
5 files changed, 141 insertions(+), 19 deletions(-)
Range-diff:
1: 4b134a62aec = 1: 584c7580b5b pretty format %(trailers) test: split a long line
2: 0d3fe6daf6c ! 2: 0255a64949b pretty format %(trailers) doc: avoid repetition
@@ Commit message
It took me a couple of readings to realize that these options were
referring back to the "only" option's treatment of boolean
- values. Let's try to make this more explicit, and upper-case "BOOL"
- for consistency with the existing "<SEP>" and "<K>".
+ values.
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
@@ Documentation/pretty-formats.txt: endif::git-rev-list[]
- `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.
-+** 'only[=BOOL]': select whether non-trailer lines from the trailer
++** 'only[=<BOOL>]': select whether non-trailer lines from the trailer
+ block should be included.
** 'separator=<SEP>': specify a separator inserted between trailer
lines. When this option is not given each trailer line is
@@ Documentation/pretty-formats.txt: endif::git-rev-list[]
-** '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.,
-+** 'unfold[=BOOL]': make it behave as if interpret-trailer's `--unfold`
++** '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[=val]': skip over the key part of the trailer line and only
- show the value part. Also this optionally allows explicit value.
-+** 'valueonly[=BOOL]': skip over the key part of the trailer line and only
++** 'valueonly[=<BOOL>]': skip over the key part of the trailer line and only
+ show the value part.
NOTE: Some placeholders may depend on other options given to the
3: ea44eeff510 = 3: c2c5513942f pretty-format %(trailers): fix broken standalone "valueonly"
4: 4fd193fd90c ! 4: 574ef0be25f pretty format %(trailers): add a "keyonly"
@@ Commit message
## Documentation/pretty-formats.txt ##
@@ Documentation/pretty-formats.txt: option is given with no value, it's enabled.
- ** 'unfold[=BOOL]': make it behave as if interpret-trailer's `--unfold`
+ ** '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
+-** '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.
++** '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
5: 6cc6fc79388 ! 5: dbc73b951f6 pretty format %(trailers): add a "key_value_separator"
@@ Commit message
## Documentation/pretty-formats.txt ##
@@ Documentation/pretty-formats.txt: option is given with no value, it's enabled.
`%(trailers:only,unfold=true)` unfolds and shows all trailer lines.
- ** 'keyonly[=BOOL]': only show the key part of the trailer.
- ** 'valueonly[=BOOL]': only show the value part of the trailer.
+ ** 'keyonly[=<BOOL>]': only show the key part of the trailer.
+ ** 'valueonly[=<BOOL>]': only show the value part of the trailer.
+** 'key_value_separator=<SEP>': specify a separator inserted between
+ trailer lines. When this option is not given each trailer key-value
+ pair is separated by ": ". Otherwise it shares the same semantics
--
2.29.2.222.g5d2a92d10f8
next prev parent reply other threads:[~2020-12-09 15:53 UTC|newest]
Thread overview: 67+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-25 21:26 [PATCH 00/21] trailer fixes Anders Waldenborg
2020-10-25 21:26 ` [PATCH 01/21] trailer: change token_{from,matches}_item into taking conf_info Anders Waldenborg
2020-10-26 11:56 ` Christian Couder
2020-10-25 21:26 ` [PATCH 02/21] trailer: don't use 'struct arg_item' for storing config Anders Waldenborg
2020-10-25 21:26 ` [PATCH 03/21] doc: mention canonicalization in git i-t manual Anders Waldenborg
2020-10-26 12:14 ` Christian Couder
2020-10-25 21:26 ` [PATCH 04/21] pretty: allow using aliases in %(trailer:key=xyz) Anders Waldenborg
2020-10-26 12:38 ` Christian Couder
2020-10-25 21:26 ` [PATCH 05/21] trailer: rename 'free_all' to 'free_all_trailer_items' Anders Waldenborg
2020-10-26 12:42 ` Christian Couder
2020-11-10 19:52 ` Jeff King
2020-10-25 21:26 ` [PATCH 06/21] t4205: add test for trailer in log with nonstandard separator Anders Waldenborg
2020-10-26 12:43 ` Christian Couder
2020-11-09 22:12 ` Anders Waldenborg
2020-11-10 7:55 ` Christian Couder
2020-11-10 19:54 ` Jeff King
2020-10-25 21:26 ` [PATCH 07/21] trailer: simplify 'arg_item' lifetime Anders Waldenborg
2020-10-25 21:26 ` [PATCH 08/21] trailer: keep track of conf in trailer_item Anders Waldenborg
2020-11-10 19:58 ` Jeff King
2020-10-25 21:26 ` [PATCH 09/21] trailer: refactor print_tok_val into taking item Anders Waldenborg
2020-10-25 21:26 ` [PATCH 10/21] trailer: move trailer token canonicalization print time Anders Waldenborg
2020-10-25 21:26 ` [PATCH 11/21] trailer: remember separator used in input Anders Waldenborg
2020-10-25 21:26 ` [PATCH 12/21] trailer: handle configured nondefault separators explicitly Anders Waldenborg
2020-11-10 20:06 ` Jeff King
2020-10-25 21:26 ` [PATCH 13/21] trailer: add option to make canonicalization optional Anders Waldenborg
2020-11-10 20:10 ` Jeff King
2020-10-25 21:26 ` [PATCH 14/21] trailer: move skipping of blank lines to own loop when finding trailer Anders Waldenborg
2020-10-25 21:26 ` [PATCH 15/21] trailer: factor out classify_trailer_line Anders Waldenborg
2020-10-25 21:26 ` [PATCH 16/21] t7513: add failing test for configured trailing line classification Anders Waldenborg
2020-10-25 21:26 ` [PATCH 17/21] trailer: don't treat line with prefix of known trailer as known Anders Waldenborg
2020-11-10 20:16 ` Jeff King
2020-10-25 21:26 ` [PATCH 18/21] trailer: factor out config lookup to separate function Anders Waldenborg
2020-10-25 21:26 ` [PATCH 19/21] trailer: move config lookup out of parse_trailer Anders Waldenborg
2020-10-25 21:26 ` [PATCH 20/21] trailer: add failing tests for matching trailers against input Anders Waldenborg
2020-10-25 21:26 ` [PATCH 21/21] trailer: only do prefix matching for configured trailers on commandline Anders Waldenborg
2020-11-10 7:44 ` [PATCH 00/21] trailer fixes Christian Couder
2020-12-05 1:39 ` [PATCH 0/5] pretty format %(trailers): improve machine readability Ævar Arnfjörð Bjarmason
2020-12-05 18:18 ` Anders Waldenborg
2020-12-07 8:53 ` Ævar Arnfjörð Bjarmason
2020-12-06 0:24 ` [PATCH v2 " Ævar Arnfjörð Bjarmason
2020-12-09 15:52 ` Ævar Arnfjörð Bjarmason [this message]
2020-12-10 10:48 ` [PATCH v3 " Christian Couder
2020-12-10 19:00 ` Junio C Hamano
2020-12-09 15:52 ` [PATCH v3 1/5] pretty format %(trailers) test: split a long line Ævar Arnfjörð Bjarmason
2020-12-09 15:52 ` [PATCH v3 2/5] pretty format %(trailers) doc: avoid repetition Ævar Arnfjörð Bjarmason
2020-12-10 19:01 ` Junio C Hamano
2020-12-09 15:52 ` [PATCH v3 3/5] pretty-format %(trailers): fix broken standalone "valueonly" Ævar Arnfjörð Bjarmason
2020-12-09 15:52 ` [PATCH v3 4/5] pretty format %(trailers): add a "keyonly" Ævar Arnfjörð Bjarmason
2020-12-09 15:52 ` [PATCH v3 5/5] pretty format %(trailers): add a "key_value_separator" Ævar Arnfjörð Bjarmason
2020-12-06 0:24 ` [PATCH v2 1/5] pretty format %(trailers) test: split a long line Ævar Arnfjörð Bjarmason
2020-12-06 0:24 ` [PATCH v2 2/5] pretty format %(trailers) doc: avoid repetition Ævar Arnfjörð Bjarmason
2020-12-07 9:09 ` Christian Couder
2020-12-06 0:24 ` [PATCH v2 3/5] pretty-format %(trailers): fix broken standalone "valueonly" Ævar Arnfjörð Bjarmason
2020-12-06 0:24 ` [PATCH v2 4/5] pretty format %(trailers): add a "keyonly" Ævar Arnfjörð Bjarmason
2020-12-07 9:17 ` Christian Couder
2020-12-06 0:24 ` [PATCH v2 5/5] pretty format %(trailers): add a "key_value_separator" Ævar Arnfjörð Bjarmason
2020-12-05 1:39 ` [PATCH 1/5] pretty format %(trailers) test: split a long line Ævar Arnfjörð Bjarmason
2020-12-05 1:39 ` [PATCH 2/5] pretty format %(trailers): avoid needless repetition Ævar Arnfjörð Bjarmason
2020-12-05 5:43 ` Christian Couder
2020-12-05 1:39 ` [PATCH 3/5] pretty format %(trailers): add a "keyonly" Ævar Arnfjörð Bjarmason
2020-12-05 6:11 ` Christian Couder
2020-12-05 12:26 ` Ævar Arnfjörð Bjarmason
2020-12-05 1:39 ` [PATCH 4/5] pretty-format %(trailers): fix broken standalone "valueonly" Ævar Arnfjörð Bjarmason
2020-12-05 6:46 ` Christian Couder
2020-12-05 1:39 ` [PATCH 5/5] pretty format %(trailers): add a "key_value_separator" Ævar Arnfjörð Bjarmason
2020-12-05 7:13 ` Christian Couder
2020-12-05 8:49 ` Ævar Arnfjörð Bjarmason
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=20201209155208.17782-1-avarab@gmail.com \
--to=avarab@gmail.com \
--cc=anders@0x63.nu \
--cc=christian.couder@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=hariom18599@gmail.com \
--cc=jonathantanmy@google.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.