The point of "--only-trailers" is to give a caller an output
that's easy for them to parse. Getting rid of the
non-trailer material helps, but we still may see more
complicated syntax like whitespace continuation. Let's add
an option to normalize the output into one "key: value" line
per trailer.
As a bonus, this could be used even without --only-trailers
to clean up unusual formatting in the incoming data.
Signed-off-by: Jeff King <peff@xxxxxxxx>
---
Documentation/git-interpret-trailers.txt | 5 +++++
builtin/interpret-trailers.c | 1 +
t/t7513-interpret-trailers.sh | 21 ++++++++++++++++++++
trailer.c | 34 +++++++++++++++++++++++++++++++-
trailer.h | 1 +
5 files changed, 61 insertions(+), 1 deletion(-)
diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt
index b2a8fad248..6d867e8ab3 100644
--- a/Documentation/git-interpret-trailers.txt
+++ b/Documentation/git-interpret-trailers.txt
@@ -88,6 +88,11 @@ OPTIONS
from the command-line or by following configured `trailer.*`
rules.
+--normalize::
+ Normalize trailer output so that trailers appear exactly one per
+ line, with any existing whitespace continuation folded into a
+ single line.
+
CONFIGURATION VARIABLES
-----------------------
diff --git a/builtin/interpret-trailers.c b/builtin/interpret-trailers.c
index a49f94ba34..ed2d893b4f 100644
--- a/builtin/interpret-trailers.c
+++ b/builtin/interpret-trailers.c
@@ -26,6 +26,7 @@ int cmd_interpret_trailers(int argc, const char **argv, const char *prefix)
OPT_BOOL(0, "trim-empty", &opts.trim_empty, N_("trim empty trailers")),
OPT_BOOL(0, "only-trailers", &opts.only_trailers, N_("output only the trailers")),
OPT_BOOL(0, "only-existing", &opts.only_existing, N_("output only existing trailers")),
+ OPT_BOOL(0, "normalize", &opts.normalize, N_("normalize trailer formatting")),
OPT_STRING_LIST(0, "trailer", &trailers, N_("trailer"),
N_("trailer(s) to add")),
OPT_END()
diff --git a/t/t7513-interpret-trailers.sh b/t/t7513-interpret-trailers.sh
index 525fd53e5b..6ad1feb1c5 100755
--- a/t/t7513-interpret-trailers.sh
+++ b/t/t7513-interpret-trailers.sh
@@ -1327,4 +1327,25 @@ test_expect_success 'only existing' '
test_cmp expected actual
'
+test_expect_success 'normalize' '
+ cat >expected <<-\EOF &&
+ foo: continued across several lines
+ EOF
+ # pass through tr to make leading and trailing whitespace more obvious
+ tr _ " " <<-\EOF |
+ my subject
+
+ my body
+
+ foo:_
+ __continued
+ ___across
+ ____several
+ _____lines
+ ___
+ EOF
+ git interpret-trailers --only-trailers --only-existing --normalize >actual &&
+ test_cmp expected actual
+'
+
test_done
diff --git a/trailer.c b/trailer.c
index 88f6efe523..575aa6dcbf 100644
--- a/trailer.c
+++ b/trailer.c
@@ -887,7 +887,35 @@ static int ends_with_blank_line(const char *buf, size_t len)
return is_blank_line(buf + ll);
}
+static void normalize_value(struct strbuf *val)
+{
+ struct strbuf out = STRBUF_INIT;
+ size_t i;
+
+ strbuf_grow(&out, val->len);
+ i = 0;
+ while (i < val->len) {
+ char c = val->buf[i++];
+ if (c == '\n') {
+ /* Collapse continuation down to a single space. */
+ while (i < val->len && isspace(val->buf[i]))
+ i++;
+ strbuf_addch(&out, ' ');
+ } else {
+ strbuf_addch(&out, c);
+ }
+ }
+
+ /* Empty lines may have left us with whitespace cruft at the edges */
+ strbuf_trim(&out);
+
+ /* output goes back to val as if we modified it in-place */
+ strbuf_swap(&out, val);
+ strbuf_release(&out);
+}
+
static int process_input_file(FILE *outfile,
+ int normalize,
const char *str,
struct list_head *head)
{
@@ -914,12 +942,16 @@ static int process_input_file(FILE *outfile,
if (separator_pos >= 1) {
parse_trailer(&tok, &val, NULL, trailer,
separator_pos);
+ if (normalize)
+ normalize_value(&val);
add_trailer_item(head,
strbuf_detach(&tok, NULL),
strbuf_detach(&val, NULL));
} else {
strbuf_addstr(&val, trailer);
strbuf_strip_suffix(&val, "\n");
+ if (normalize)
+ normalize_value(&val);
add_trailer_item(head,
NULL,
strbuf_detach(&val, NULL));
@@ -989,7 +1021,7 @@ void process_trailers(const char *file, struct process_trailer_options *opts,
/* Print the lines before the trailers */
trailer_end = process_input_file(opts->only_trailers ? NULL : outfile,
- sb.buf, &head);
+ opts->normalize, sb.buf, &head);
if (!opts->only_existing) {
process_command_line_args(&arg_head, trailers);
diff --git a/trailer.h b/trailer.h
index 6356b890ba..a5a9c08b5f 100644
--- a/trailer.h
+++ b/trailer.h
@@ -27,6 +27,7 @@ struct process_trailer_options {
int trim_empty;
int only_trailers;
int only_existing;
+ int normalize;
};
#define PROCESS_TRAILER_OPTIONS_INIT {0}
--
2.14.0.609.gd2d1f7ddf
