From: John Keeping <john@keeping.me.uk>
To: Brandon Casey <drafnel@gmail.com>
Cc: git@vger.kernel.org, gitster@pobox.com, pclouds@gmail.com,
jrnieder@gmail.com, Brandon Casey <bcasey@nvidia.com>
Subject: Re: [PATCH v4.1 09/12] sequencer.c: teach append_signoff to avoid adding a duplicate newline
Date: Sun, 17 Feb 2013 22:49:20 +0000 [thread overview]
Message-ID: <20130217224919.GA5011@serenity.lan> (raw)
In-Reply-To: <CA+sFfMecyfD7x_8Jk-hUDceL_nS5kuKq5nF0vRBqLROWFgdypA@mail.gmail.com>
On Fri, Feb 15, 2013 at 10:58:38AM -0800, Brandon Casey wrote:
> On Thu, Feb 14, 2013 at 9:58 AM, John Keeping <john@keeping.me.uk> wrote:
> > As Jonathan Nieder wondered before [1], this changes the behaviour when
> > the commit message is empty. Before this commit, there is an empty line
> > followed by the S-O-B line; now the S-O-B is on the first line of the
> > commit.
> >
> > The previous behaviour seems better to me since the empty line is
> > hinting that the user should fill something in. It looks particularly
> > strange if your editor has syntax highlighting for commit messages such
> > that the first line is in a different colour.
>
> Are you talking about the output produced by format-patch? Or are you
> talking about what happens when you do 'commit --amend -s' for a
> commit with an empty commit message. (The email that you referenced
> was about the behavior of format-patch).
I'm talking about plain 'commit -s' which seems to use the same code
path.
> I'm thinking you must be talking about the 'commit --amend -s'
> behavior since you mentioned your editor. Is there another case that
> is affected by this? Normally, any extra blank lines that precede or
> follow a commit message are removed before the commit object is
> created. So, I guess it wouldn't hurt to insert a newline (or maybe
> it should be two?) before the signoff in this case. Would this
> provide an improvement or change for any other commands than 'commit
> --amend -s'?
>
> If we want to do this, then I'd probably do it like this:
>
> - if (len && msgbuf->buf[len - 1] != '\n')
> + if (!len || msgbuf->buf[len - 1] != '\n')
> append_newlines = "\n\n";
> - else if (len > 1 && msgbuf->buf[len - 2] != '\n')
> + else if (len == 1 || msgbuf->buf[len - 2] != '\n')
> append_newlines = "\n";
>
> This would ensure there were two newlines preceding the sob. The
> editor would place its cursor on the top line where the user should
> begin typing in a commit message. If an editor was not opened up
> (e.g. if 'git cherry-pick -s --allow-empty-message ...' was used) then
> the normal mechanism that removes extra blank lines would trigger to
> remove the extra blank lines.
>
> I think that's reasonable.
Two blank lines seems like an improvement to me, FWIW.
John
next prev parent reply other threads:[~2013-02-17 22:50 UTC|newest]
Thread overview: 41+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-02-12 10:17 [PATCH v4 00/12] unify appending of sob Brandon Casey
2013-02-12 10:17 ` [PATCH v4 01/12] sequencer.c: rework search for start of footer to improve clarity Brandon Casey
2013-02-12 10:17 ` [PATCH v4 02/12] commit, cherry-pick -s: remove broken support for multiline rfc2822 fields Brandon Casey
2013-02-12 10:17 ` [PATCH v4 03/12] t/test-lib-functions.sh: allow to specify the tag name to test_commit Brandon Casey
2017-05-13 17:41 ` Ævar Arnfjörð Bjarmason
2013-02-12 10:17 ` [PATCH v4 04/12] t/t3511: add some tests of 'cherry-pick -s' functionality Brandon Casey
2013-02-12 10:17 ` [PATCH v4 05/12] sequencer.c: recognize "(cherry picked from ..." as part of s-o-b footer Brandon Casey
2013-02-12 19:13 ` Junio C Hamano
2013-02-12 19:32 ` Brandon Casey
2013-02-12 19:36 ` Junio C Hamano
2013-02-12 19:49 ` Brandon Casey
2013-02-12 19:58 ` Junio C Hamano
2013-02-12 19:45 ` Jonathan Nieder
2013-02-12 10:17 ` [PATCH v4 06/12] sequencer.c: require a conforming footer to be preceded by a blank line Brandon Casey
2013-02-12 10:17 ` [PATCH v4 07/12] sequencer.c: always separate "(cherry picked from" from commit body Brandon Casey
2013-02-12 10:17 ` [PATCH v4 08/12] sequencer.c: teach append_signoff how to detect duplicate s-o-b Brandon Casey
2013-02-12 10:17 ` [PATCH v4 09/12] sequencer.c: teach append_signoff to avoid adding a duplicate newline Brandon Casey
2013-02-12 10:33 ` [PATCH v4.1 " Brandon Casey
2013-02-14 17:58 ` John Keeping
2013-02-15 18:58 ` Brandon Casey
2013-02-17 22:49 ` John Keeping [this message]
2013-02-21 18:51 ` Junio C Hamano
2013-02-21 20:26 ` Brandon Casey
2013-02-21 20:29 ` Brandon Casey
2013-02-21 21:27 ` Junio C Hamano
2013-02-22 9:25 ` [PATCH] git-commit: populate the edit buffer with 2 blank lines before s-o-b Brandon Casey
2013-02-22 18:35 ` Junio C Hamano
2013-02-22 22:03 ` Brandon Casey
2013-02-22 22:05 ` [PATCH v2] " Brandon Casey
2013-02-22 22:35 ` Jeff King
2013-02-22 22:38 ` Junio C Hamano
2013-02-12 10:17 ` [PATCH v4 10/12] t4014: more tests about appending s-o-b lines Brandon Casey
2013-02-12 10:17 ` [PATCH v4 11/12] format-patch: update append_signoff prototype Brandon Casey
2013-02-12 19:29 ` Junio C Hamano
2013-02-12 22:51 ` Brandon Casey
2013-02-12 10:17 ` [PATCH v4 12/12] Unify appending signoff in format-patch, commit and sequencer Brandon Casey
2013-02-12 10:17 ` [PATCH/FYI v4 13/12] fixup! t/t3511: add some tests of 'cherry-pick -s' functionality Brandon Casey
2013-02-12 19:56 ` Jonathan Nieder
2013-02-12 20:20 ` Junio C Hamano
2013-02-12 20:16 ` [PATCH v4 00/12] unify appending of sob Jonathan Nieder
2013-02-12 20:45 ` Junio C Hamano
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=20130217224919.GA5011@serenity.lan \
--to=john@keeping.me.uk \
--cc=bcasey@nvidia.com \
--cc=drafnel@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=jrnieder@gmail.com \
--cc=pclouds@gmail.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).