threads / patch / 45592

patchFix 'git am' in-body header continuations

Subject: [PATCH] Fix 'git am' in-body header continuations

## tl;dr

3 messages between Apr 3, 2017 and Apr 4, 2017. Diffs are folded; open one to read it.

replies: 2people: 3as markdown or json

Linus Torvalds· Apr 3, 2017, 00:49 UTC · lore
From: Linus Torvalds <torvalds@linux-foundation.org>
Date: Sat, 1 Apr 2017 12:14:39 -0700
Subject: [PATCH] Fix 'git am' in-body header continuations

An empty line should stop any pending in-body headers, and start the actual body parsing.

This also modifies the original test for the in-body headers to actually have a real commit body that starts with spaces, and changes the test to check that the long line matches _exactly_, and doesn't get extra data from the body.

Fixes:6b4b013f1884 ("mailinfo: handle in-body header continuations")
Cc: Jonathan Tan <jonathantanmy@google.com>
Cc: Jeff King <peff@peff.net>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
---
On Sun, 2 Apr 2017, Junio C Hamano wrote:
> 
> And that is exactly your patch does.  The change "feels" correct to
> me.

Ok, resent with the test-case for the original behavior changed to be stricter (so it fails without this fix), and with Signed-off lines etc.

I didn't really test the test-case very much, but it seemed to fail without this patch (because the "Body test" thing from the body becomes part of the long first line), and passes with it.

But somebody who is more used to the test-suite should double-check my stupid test edit.

 mailinfo.c    | 7 ++++++-
 t/t4150-am.sh | 6 ++++--
 2 files changed, 10 insertions(+), 3 deletions(-)
Show changes to 2 files +10 −3

mailinfo.c, t/t4150-am.sh

diff --git a/mailinfo.c b/mailinfo.c
index a489d9d0f..68037758f 100644
--- a/mailinfo.c
+++ b/mailinfo.c
@@ -757,8 +757,13 @@ static int handle_commit_msg(struct mailinfo *mi, struct strbuf *line)
 	assert(!mi->filter_stage);
 
 	if (mi->header_stage) {
-		if (!line->len || (line->len == 1 && line->buf[0] == '\n'))
+		if (!line->len || (line->len == 1 && line->buf[0] == '\n')) {
+			if (mi->inbody_header_accum.len) {
+				flush_inbody_header_accum(mi);
+				mi->header_stage = 0;
+			}
 			return 0;
+		}
 	}
 
 	if (mi->use_inbody_headers && mi->header_stage) {
diff --git a/t/t4150-am.sh b/t/t4150-am.sh
index 89a5bacac..44807e218 100755
--- a/t/t4150-am.sh
+++ b/t/t4150-am.sh
@@ -983,7 +983,9 @@ test_expect_success 'am works with multi-line in-body headers' '
 	rm -fr .git/rebase-apply &&
 	git checkout -f first &&
 	echo one >> file &&
-	git commit -am "$LONG" --author="$LONG <long@example.com>" &&
+	git commit -am "$LONG
+
+    Body test" --author="$LONG <long@example.com>" &&
 	git format-patch --stdout -1 >patch &&
 	# bump from, date, and subject down to in-body header
 	perl -lpe "
@@ -997,7 +999,7 @@ test_expect_success 'am works with multi-line in-body headers' '
 	git am msg &&
 	# Ensure that the author and full message are present
 	git cat-file commit HEAD | grep "^author.*long@example.com" &&
-	git cat-file commit HEAD | grep "^$LONG"
+	git cat-file commit HEAD | grep "^$LONG$"
 '
 
 test_done

-- 
2.12.2.578.g5c4e54f4e
Jonathan Tan· Apr 3, 2017, 18:00 UTC · re: Linus Torvalds · lore

Re: [PATCH] Fix 'git am' in-body header continuations

This looks good to me.
On 04/02/2017 05:49 PM, Linus Torvalds wrote:
Show 30 quoted lines
>
> From: Linus Torvalds <torvalds@linux-foundation.org>
> Date: Sat, 1 Apr 2017 12:14:39 -0700
> Subject: [PATCH] Fix 'git am' in-body header continuations
>
> An empty line should stop any pending in-body headers, and start the
> actual body parsing.
>
> This also modifies the original test for the in-body headers to actually
> have a real commit body that starts with spaces, and changes the test to
> check that the long line matches _exactly_, and doesn't get extra data
> from the body.
>
> Fixes:6b4b013f1884 ("mailinfo: handle in-body header continuations")
> Cc: Jonathan Tan <jonathantanmy@google.com>
> Cc: Jeff King <peff@peff.net>
> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
> ---
> diff --git a/t/t4150-am.sh b/t/t4150-am.sh
> index 89a5bacac..44807e218 100755
> --- a/t/t4150-am.sh
> +++ b/t/t4150-am.sh
> @@ -983,7 +983,9 @@ test_expect_success 'am works with multi-line in-body headers' '
>  	rm -fr .git/rebase-apply &&
>  	git checkout -f first &&
>  	echo one >> file &&
> -	git commit -am "$LONG" --author="$LONG <long@example.com>" &&
> +	git commit -am "$LONG
> +
> +    Body test" --author="$LONG <long@example.com>" &&

Instead of "Body test", I would write something more descriptive like "Not a continuation line because of blank line above", but I'm fine with either.

Show 13 quoted lines
>  	git format-patch --stdout -1 >patch &&
>  	# bump from, date, and subject down to in-body header
>  	perl -lpe "
> @@ -997,7 +999,7 @@ test_expect_success 'am works with multi-line in-body headers' '
>  	git am msg &&
>  	# Ensure that the author and full message are present
>  	git cat-file commit HEAD | grep "^author.*long@example.com" &&
> -	git cat-file commit HEAD | grep "^$LONG"
> +	git cat-file commit HEAD | grep "^$LONG$"
>  '
>
>  test_done
>
Jeff King· Apr 4, 2017, 06:48 UTC · re: Jonathan Tan · lore

Re: [PATCH] Fix 'git am' in-body header continuations

On Mon, Apr 03, 2017 at 11:00:09AM -0700, Jonathan Tan wrote:
Show 15 quoted lines
> > diff --git a/t/t4150-am.sh b/t/t4150-am.sh
> > index 89a5bacac..44807e218 100755
> > --- a/t/t4150-am.sh
> > +++ b/t/t4150-am.sh
> > @@ -983,7 +983,9 @@ test_expect_success 'am works with multi-line in-body headers' '
> >  	rm -fr .git/rebase-apply &&
> >  	git checkout -f first &&
> >  	echo one >> file &&
> > -	git commit -am "$LONG" --author="$LONG <long@example.com>" &&
> > +	git commit -am "$LONG
> > +
> > +    Body test" --author="$LONG <long@example.com>" &&
> 
> Instead of "Body test", I would write something more descriptive like "Not a
> continuation line because of blank line above", but I'm fine with either.

Yeah. I also wonder if we can make the indentation more obvious. I thought at first that the patch was whitespace mangled. :-/

Maybe:
  SP=" " &&
  cat >msg <<-EOF &&
  $LONG
  $SP This line is indented but not a header continuation.
  EOF
  git commit -F msg ...
or something.

It might also be easier to understand what's going on if this gets its own test. This is really just testing mailinfo. I wonder if it would make more sense in t5100, where we would not have to deal with all the commit/format-patch cruft.

-Peff

← back to recent threads