From: Jeff King <peff@peff.net>
To: Junio C Hamano <gitster@pobox.com>
Cc: Christian Couder <christian.couder@gmail.com>, git@vger.kernel.org
Subject: [PATCH 7/9] sequencer: ignore "---" divider when parsing trailers
Date: Wed, 22 Aug 2018 20:50:37 -0400 [thread overview]
Message-ID: <20180823005037.GG3126@sigill.intra.peff.net> (raw)
In-Reply-To: <20180823004300.GA1355@sigill.intra.peff.net>
When the sequencer code appends a signoff or cherry-pick
origin, it uses the default trailer-parsing options, which
treat "---" as the end of the commit message. As a result,
it may be fooled by a commit message that contains that
string and fail to find the existing trailer block. Even
more confusing, the actual append code does not know about
"---", and always appends to the end of the string. This can
lead to bizarre results. E.g., appending a signoff to a
commit message like this:
subject
body
---
these dashes confuse the parser!
Signed-off-by: A
results in output with a final block like:
Signed-off-by: A
Signed-off-by: A
The parser thinks the final line of the message is "body",
and ignores everything else, claiming there are no trailers.
So we output an extra newline separator (wrong) and add a
duplicate signoff (also wrong).
Since we know we are feeding a pure commit message, we can
simply tell the parser to ignore the "---" divider.
Signed-off-by: Jeff King <peff@peff.net>
---
sequencer.c | 2 ++
t/t7501-commit.sh | 16 ++++++++++++++++
2 files changed, 18 insertions(+)
diff --git a/sequencer.c b/sequencer.c
index 3e15faa94e..25bdbfcce1 100644
--- a/sequencer.c
+++ b/sequencer.c
@@ -232,6 +232,8 @@ static int has_conforming_footer(struct strbuf *sb, struct strbuf *sob,
size_t i;
int found_sob = 0, found_sob_last = 0;
+ opts.no_divider = 1;
+
trailer_info_get(&info, sb->buf, &opts);
if (info.trailer_start == info.trailer_end)
diff --git a/t/t7501-commit.sh b/t/t7501-commit.sh
index 51646d8019..1cabb8b8ed 100755
--- a/t/t7501-commit.sh
+++ b/t/t7501-commit.sh
@@ -517,6 +517,22 @@ Myfooter: x" &&
test_cmp expected actual
'
+test_expect_success 'signoff not confused by ---' '
+ cat >expected <<-EOF &&
+ subject
+
+ body
+ ---
+ these dashes confuse the parser!
+
+ Signed-off-by: $GIT_COMMITTER_NAME <$GIT_COMMITTER_EMAIL>
+ EOF
+ # should be a noop, since we already signed
+ git commit --allow-empty --signoff -F expected &&
+ git log -1 --pretty=format:%B >actual &&
+ test_cmp expected actual
+'
+
test_expect_success 'multiple -m' '
>negative &&
--
2.19.0.rc0.412.g7005db4e88
next prev parent reply other threads:[~2018-08-23 0:57 UTC|newest]
Thread overview: 53+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-08-21 18:41 [PATCH] test-tool.h: include git-compat-util.h Jeff King
2018-08-21 19:03 ` Junio C Hamano
2018-08-21 19:06 ` [PATCH 1/6] t/perf: factor boilerplate out of test_perf Jeff King
2018-08-21 19:06 ` [PATCH 2/6] t/perf: factor out percent calculations Jeff King
2018-08-21 19:06 ` [PATCH 3/6] t/perf: add infrastructure for measuring sizes Jeff King
2018-08-22 13:40 ` Derrick Stolee
2018-08-22 15:31 ` Jeff King
2018-08-21 19:06 ` [PATCH 4/6] t/perf: add perf tests for fetches from a bitmapped server Jeff King
2018-08-21 19:07 ` [PATCH 5/6] pack-bitmap: save "have" bitmap from walk Jeff King
2018-08-21 19:47 ` Derrick Stolee
2018-08-21 19:54 ` Jeff King
2018-08-31 15:23 ` Ævar Arnfjörð Bjarmason
2018-08-31 22:55 ` Jeff King
2018-09-01 7:41 ` [PATCH 0/4] un-breaking pack-objects with bitmaps Jeff King
2018-09-01 7:44 ` [PATCH 1/4] bitmap_has_sha1_in_uninteresting(): drop BUG check Jeff King
2018-09-01 7:48 ` [PATCH 2/4] t5310: test delta reuse with bitmaps Jeff King
2018-09-01 8:03 ` Jeff King
2018-09-01 20:29 ` Ævar Arnfjörð Bjarmason
2018-09-01 22:46 ` Ben Peart
2018-09-02 5:51 ` Jeff King
2018-09-04 19:05 ` Stefan Beller
2018-09-04 19:45 ` Junio C Hamano
2018-09-04 20:02 ` Jeff King
2018-09-01 7:49 ` [PATCH 3/4] traverse_bitmap_commit_list(): don't free result Jeff King
2018-09-01 7:50 ` [PATCH 4/4] pack-bitmap: drop "loaded" flag Jeff King
2018-09-04 19:30 ` [PATCH 0/4] un-breaking pack-objects with bitmaps Stefan Beller
2018-09-04 20:03 ` Jeff King
2018-09-08 6:43 ` Ævar Arnfjörð Bjarmason
2018-09-10 16:53 ` Junio C Hamano
2018-09-10 18:48 ` Jeff King
2018-09-10 19:23 ` Junio C Hamano
2018-08-21 19:07 ` [PATCH 6/6] pack-objects: reuse on-disk deltas for thin "have" objects Jeff King
2018-08-21 19:43 ` Junio C Hamano
2018-08-21 19:50 ` Junio C Hamano
2018-08-21 20:07 ` Jeff King
2018-08-21 20:14 ` Jeff King
2018-08-21 20:52 ` Junio C Hamano
2018-08-21 21:30 ` Jeff King
2018-08-21 20:57 ` Junio C Hamano
2018-08-21 21:32 ` Jeff King
2018-08-23 0:43 ` [PATCH 0/9] trailer-parsing false positives Jeff King
2018-08-23 0:44 ` [PATCH 1/9] trailer: use size_t for string offsets Jeff King
2018-08-23 0:45 ` [PATCH 2/9] trailer: use size_t for iterating trailer list Jeff King
2018-08-23 0:46 ` [PATCH 3/9] trailer: pass process_trailer_opts to trailer_info_get() Jeff King
2018-08-23 0:48 ` [PATCH 4/9] interpret-trailers: tighten check for "---" patch boundary Jeff King
2018-08-23 0:49 ` [PATCH 5/9] interpret-trailers: allow suppressing "---" divider Jeff King
2018-08-23 0:50 ` [PATCH 6/9] pretty, ref-filter: format %(trailers) with no_divider option Jeff King
2018-08-23 0:50 ` Jeff King [this message]
2018-08-23 0:50 ` [PATCH 8/9] append_signoff: use size_t for string offsets Jeff King
2018-08-23 0:51 ` [PATCH 9/9] sequencer: handle ignore_footer when parsing trailers Jeff King
2018-08-23 18:30 ` [PATCH 0/9] trailer-parsing false positives Junio C Hamano
2018-08-24 7:26 ` Jeff King
2018-08-21 20:00 ` [PATCH 6/6] pack-objects: reuse on-disk deltas for thin "have" objects Jeff King
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=20180823005037.GG3126@sigill.intra.peff.net \
--to=peff@peff.net \
--cc=christian.couder@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).