From: Jeff King <peff@peff.net>
To: Ross Kabus <rkabus@aerotech.com>
Cc: git@vger.kernel.org
Subject: Re: [Bug] commit-tree shouldn't append an extra newline to commit messages
Date: Tue, 5 Sep 2017 11:36:36 -0400 [thread overview]
Message-ID: <20170905153636.tsmlq3wv7ztpc67z@sigill.intra.peff.net> (raw)
In-Reply-To: <CAEVs+zbbWQuM-=5d04bkpTu38Mr4PyczskNhni5K1u_nzh-2Qw@mail.gmail.com>
On Tue, Sep 05, 2017 at 11:09:01AM -0400, Ross Kabus wrote:
> On Sat, Sep 2, 2017 at 4:33 AM, Jeff King <peff@peff.net> wrote:
>
> > But I am confused by your "inconsistent with git commit porcelain"
> > comment. The porcelain git-commit definitely _does_ add a newline if one
> > isn't present (and in fact runs the whole thing through git-stripspace
> > to clean up whitespace oddities).
>
> Ok I figured out my confusion. The repository I am working with did
> commits with "git commit --cleanup=verbatim" thus do not have a newline.
> This is why I thought there was an inconsistency.
OK, that makes more sense. Though I think even with verbatim, "-m" will
still complete a line (it happens in opt_parse_m):
$ git commit -q --allow-empty -m foo
$ git cat-file commit HEAD | xxd
...
00000090: 3034 3030 0a0a 666f 6f0a 0400..foo.
^^
newline
That makes sense, since the idea of "-m" is to take a one-liner, but you
would not typically provide the newline yourself via the shell.
It looks like "-F" does not do an explicit complete-line (so it would
depend on --cleanup to do it normally, but in verbatim mode would not).
That makes sense to me, as well (in a full file, usually you _would_
have the newline, or choose to omit it intentionally, and we should
respect that). So I'd argue that "git commit -F" is doing a reasonable
thing, and "commit-tree -F" should probably change to match it (because
it's inconsistent, and because if anything the plumbing commit-tree
should err more on the side of not touching its input than the porcelain
commit command).
> > So I don't think "inconsistent with git-commit" is a compelling
> > argument, unless I'm missing something.
>
> Agreed, but now I guess I would argue that it is inconsistent because
> it lacks a "verbatim" option like git-commit has. I would like to see
> an argument like this for commit-tree but a clean way to add this option
> didn't immediately jump out at me.
I think the default behavior of reading via stdin _is_ the verbatim
option. And you can choose whether or not to pipe it through
git-stripspace to do more cleanup (and in fact, when git-commit was
implemented as a shell script long ago, that's exactly how it was
implemented). But...
> > And definitely it does not when taking the message in via stdin.
>
> I'm not seeing this, I see commit-tree as adding a new line even via
> stdin (and the code seems to corroborate this), unless I missed something.
I'm not sure why you're seeing that. It seems verbatim to me:
$ tree=$(git write-tree)
$ commit=$(printf end | git commit-tree $tree)
$ git cat-file commit $commit | xxd
...
00000090: 3034 3030 0a0a 656e 64 0400..end
-Peff
next prev parent reply other threads:[~2017-09-05 15:36 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-09-01 18:58 [Bug] commit-tree shouldn't append an extra newline to commit messages Ross Kabus
2017-09-02 8:33 ` Jeff King
2017-09-05 15:09 ` Ross Kabus
2017-09-05 15:36 ` Jeff King [this message]
2017-09-05 16:57 ` Ross Kabus
2017-09-05 17:03 ` Jeff King
2017-09-05 20:57 ` Ross Kabus
2017-09-05 20:59 ` Ross Kabus
2017-09-07 5:57 ` Jeff King
2017-09-05 21:56 ` 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
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=20170905153636.tsmlq3wv7ztpc67z@sigill.intra.peff.net \
--to=peff@peff.net \
--cc=git@vger.kernel.org \
--cc=rkabus@aerotech.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.
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).