Skip to content

Commit

Permalink
pretty: add support for "valueonly" option in %(trailers)
Browse files Browse the repository at this point in the history
With the new "key=" option to %(trailers) it often makes little sense to
show the key, as it by definition already is knows which trailer is
printed there. This new "valueonly" option makes it omit the key when
printing trailers.

E.g.:
 $ git show -s --pretty='%s%n%(trailers:key=Signed-off-by,valueonly)' aaaa881
will show:
 > upload-pack: fix broken if/else chain in config callback
 > Jeff King <peff@peff.net>
 > Junio C Hamano <gitster@pobox.com>

Signed-off-by: Anders Waldenborg <anders@0x63.nu>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
wanders authored and gitster committed Jan 29, 2019
1 parent 250bea0 commit d9b936d
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 3 deletions.
2 changes: 2 additions & 0 deletions Documentation/pretty-formats.txt
Expand Up @@ -243,6 +243,8 @@ endif::git-rev-list[]
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.
** 'valueonly[=val]': skip over the key part of the trailer line and only
show the value part. Also this optionally allows explicit value.

NOTE: Some placeholders may depend on other options given to the
revision traversal engine. For example, the `%g*` reflog options will
Expand Down
3 changes: 2 additions & 1 deletion pretty.c
Expand Up @@ -1391,7 +1391,8 @@ static size_t format_commit_one(struct strbuf *sb, /* in UTF-8 */
opts.filter_data = &filter_list;
opts.only_trailers = 1;
} 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, "unfold", &arg, &opts.unfold) &&
!match_placeholder_bool_arg(arg, "valueonly", &arg, &opts.value_only))
break;
}
}
Expand Down
6 changes: 6 additions & 0 deletions t/t4205-log-pretty-formats.sh
Expand Up @@ -673,6 +673,12 @@ test_expect_success '%(trailers:key) without value is error' '
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 'trailer parsing not fooled by --- line' '
git commit --allow-empty -F - <<-\EOF &&
this is the subject
Expand Down
6 changes: 4 additions & 2 deletions trailer.c
Expand Up @@ -1150,8 +1150,10 @@ static void format_trailer_info(struct strbuf *out,
if (!opts->filter || opts->filter(&tok, opts->filter_data)) {
if (opts->unfold)
unfold_value(&val);

strbuf_addf(out, "%s: %s\n", tok.buf, val.buf);
if (!opts->value_only)
strbuf_addf(out, "%s: ", tok.buf);
strbuf_addbuf(out, &val);
strbuf_addch(out, '\n');
}
strbuf_release(&tok);
strbuf_release(&val);
Expand Down
1 change: 1 addition & 0 deletions trailer.h
Expand Up @@ -72,6 +72,7 @@ struct process_trailer_options {
int only_input;
int unfold;
int no_divider;
int value_only;
int (*filter)(const struct strbuf *, void *);
void *filter_data;
};
Expand Down

0 comments on commit d9b936d

Please sign in to comment.