From: Junio C Hamano <gitster@pobox.com>
To: Brian Malehorn <bmalehorn@gmail.com>
Cc: peff@peff.net, git@vger.kernel.org
Subject: Re: [PATCH] interpret-trailers: obey scissors lines
Date: Mon, 15 May 2017 12:55:42 +0900 [thread overview]
Message-ID: <xmqqk25iwz7l.fsf@gitster.mtv.corp.google.com> (raw)
In-Reply-To: <20170514083349.24979-2-bmalehorn@gmail.com> (Brian Malehorn's message of "Sun, 14 May 2017 01:33:49 -0700")
Brian Malehorn <bmalehorn@gmail.com> writes:
> If a commit message is being edited as "verbose", it will contain a
> scissors string ("-- >8 --") and a diff:
>
> my subject
>
> # ------------------------ >8 ------------------------
> # Do not touch the line above.
> # Everything below will be removed.
> diff --git a/foo.txt b/foo.txt
> index 5716ca5..7601807 100644
> --- a/foo.txt
> +++ b/foo.txt
> @@ -1 +1 @@
> -bar
> +baz
>
> interpret-trailers doesn't interpret the scissors and therefore places
> trailer information after the diff. A simple reproduction is:
>
> git config commit.verbose true
> GIT_EDITOR='git interpret-trailers --in-place --trailer Acked-by:me' \
> git commit --amend
>
> This commit resolves the issue by teaching "git interpret-trailers" to
> obey scissors the same way "git commit" does.
I'd prefer to see s/obey scissors lines/honor the cut line/, and the
last paragraph rephrased somewhat, perhaps like:
Subject: interpret-trailers: honor the cut line
If a commit message is edited with the "verbose" option, the
buffer will have a cut line and diff after the log message,
like so:
my subject
# ------------------------ >8 ------------------------
# Do not touch the line above.
# Everything below will be removed.
diff --git a/foo.txt b/foo.txt
index 5716ca5..7601807 100644
--- a/foo.txt
+++ b/foo.txt
@@ -1 +1 @@
-bar
+baz
"git interpret-trailers" is unaware of the cut line, and
assumes the trailer block would be at the end of the whole
thing. This can easily be seen with:
$ GIT_EDITOR='git interpret-trailers --in-place --trailer Acked-by:me' \
git commit --amend -v
Teach "git interpret-trailers" to notice the cut-line and
ignore the remainder of the input when looking for a place
to add new trailer block. This makes it consistent with how
"git commit -v -s" inserts a new Signed-off-by: line.
This can be done by the same logic as the existing helper
function, wt_status_truncate_message_at_cut_line(), uses,
but it wants the caller to pass a strbuf to it. Because the
helper function ignore_non_trailer() used by the command
takes a <pointer, length> pair, not a strbuf, steal the
logic from wt_status_truncate_message_at_cut_line() to
create a new wt_status_strip_scissors() helper function that
takes <poiter, length> pair, and make ignore_non_trailer()
call it to help "interpret-trailers". Since there is only
one caller of wt_status_truncate_message_at_cut_line() in
cmd_commit(), rewrite it to call wt_status_strip_scissors()
helper instead and remove the old helper that no longer has
any caller.
The last paragraph would have saved me from getting puzzled.
The mention of "'commit -v -s' works that way, too" was my attempt
to justify why it is OK to make this change unconditionally to
intepret-trailers, but I am still not 100% convinced with that
reasoning (or your original log message) that it is a safe thing to
do. It is not like its sole purpose is to serve as GIT_EDITOR for
the "git commit" command.
The patch text itself looks sensible.
We still need to see your patch with your sign-off, though.
Thanks.
next prev parent reply other threads:[~2017-05-15 3:55 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-05-12 5:03 [PATCH 0/3] interpret-trailers + commit -v bugfix Brian Malehorn
2017-05-12 5:03 ` [PATCH 1/3] mailinfo.c: is_scissors_line ends on newline Brian Malehorn
2017-05-12 8:31 ` Jeff King
2017-05-12 5:03 ` [PATCH 2/3] commit.c: add is_scissors_line Brian Malehorn
2017-05-12 8:40 ` Jeff King
2017-05-12 5:03 ` [PATCH 3/3] commit.c: skip scissors when computing trailers Brian Malehorn
2017-05-12 8:52 ` Jeff King
2017-05-12 9:00 ` [PATCH 0/3] interpret-trailers + commit -v bugfix Jeff King
2017-05-14 3:39 ` Brian Malehorn
2017-05-14 3:39 ` [PATCH] interpret-trailers: obey scissors lines Brian Malehorn
2017-05-14 3:56 ` Jeff King
2017-05-14 8:33 ` Brian Malehorn
2017-05-14 8:33 ` Brian Malehorn
2017-05-15 3:55 ` Junio C Hamano [this message]
2017-05-15 4:23 ` Junio C Hamano
2017-05-16 6:06 ` Brian Malehorn
2017-05-16 6:06 ` [PATCH] interpret-trailers: honor the cut line Brian Malehorn
2017-05-16 6:42 ` [PATCH] interpret-trailers: obey scissors lines Junio C Hamano
2017-05-15 3:08 ` Jeff King
2017-05-15 2:12 ` Junio C Hamano
2017-05-15 3:07 ` Jeff King
2017-05-15 3:32 ` Junio C Hamano
2017-05-15 3:33 ` Jeff King
2017-05-14 7:02 ` Æ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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqqk25iwz7l.fsf@gitster.mtv.corp.google.com \
--to=gitster@pobox.com \
--cc=bmalehorn@gmail.com \
--cc=git@vger.kernel.org \
--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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).