threads / bug / 42914

Bug: "git log --format='format:%+s%+b'" doesn't insert newline before body

Subject: Bug: "git log --format='format:%+s%+b'" doesn't insert newline before body

## tl;dr

7 messages between Jul 24, 2016 and Jul 25, 2016.

replies: 6people: 4as markdown or json

Ilya Tumaykin· Jul 24, 2016, 13:46 UTC · lore
Hello.

Steps to reproduce: $ git init $ >123 $ git add 123 $ git commit -v -m 'This is subject' -m 'And this is body' $ git --no-pager log -1 --format='format:%+s%+b'

Actual results: ```

This is subject And this is body ```

Expected results: ```

This is subject

And this is body ```

$ git --version git version 2.9.2

Please fix.
-- 
Best regards.
Ilya Tumaykin.
Beat Bolli· Jul 25, 2016, 06:55 UTC · re: Ilya Tumaykin · lore

Re: Bug:

Ilya Tumaykin <itumaykin <at> gmail.com> writes:
> $ git --no-pager log -1 --format='format:%+s%+b'
> Please fix.
Simply use `git --no-pager log -1 --format='format:%+s%n%+b'`
The message body excludes the empty line preceding it.
Johannes Schindelin· Jul 25, 2016, 07:33 UTC · re: Ilya Tumaykin · lore

Re: Bug: "git log --format='format:%+s%+b'" doesn't insert newline before body

Hi Ilya,
On Sun, 24 Jul 2016, Ilya Tumaykin wrote:
Show 21 quoted lines
> Steps to reproduce:
> $ git init
> $ >123
> $ git add 123
> $ git commit -v -m 'This is subject' -m 'And this is body'
> $ git --no-pager log -1 --format='format:%+s%+b'
> 
> Actual results:
> ```
> 
> This is subject
> And this is body
> ```
> 
> Expected results:
> ```
> 
> This is subject
> 
> And this is body
> ```

The empty line between commit subject and body is neither part of the subject nor of the body. That means that the above-mentioned expectation was incorrect.

Unless you somehow allow empty commit messages (Git does not, unless you play games with low-level commands), the second '+' is unnecessarily conditional. Therefore "%s%n%+b" *might* do what you intended (I would not know, because that information was missing from the report).

Ciao, Johannes

Ilya Tumaykin· Jul 25, 2016, 07:51 UTC · re: Johannes Schindelin · lore

Re: Bug: "git log --format='format:%+s%+b'" doesn't insert newline before body

On Monday 25 July 2016 09:33:00 Johannes Schindelin wrote:
Show 28 quoted lines
> Hi Ilya,
> 
> On Sun, 24 Jul 2016, Ilya Tumaykin wrote:
> > Steps to reproduce:
> > $ git init
> > $ >123
> > $ git add 123
> > $ git commit -v -m 'This is subject' -m 'And this is body'
> > $ git --no-pager log -1 --format='format:%+s%+b'
> > 
> > Actual results:
> > ```
> > 
> > This is subject
> > And this is body
> > ```
> > 
> > Expected results:
> > ```
> > 
> > This is subject
> > 
> > And this is body
> > ```
> 
> The empty line between commit subject and body is neither part of the
> subject nor of the body. That means that the above-mentioned expectation
> was incorrect.

According to 'git-log' man page '%+b' should insert linefeed "immediately before the expansion if and only if the placeholder expands to a non-empty string." Here "%b" expands to a non-empty string, thus I expect a linefeed before it. Or am I misinterpreting man page somehow?

> Unless you somehow allow empty commit messages (Git does not, unless you
> play games with low-level commands), the second '+' is unnecessarily
> conditional. Therefore "%s%n%+b" *might* do what you intended (I would not
> know, because that information was missing from the report).

I want to display '%B', but add colours to '%s'. Thus I have to separately include '%s' and '%b', and not just '%B'. I was using '%+s%n%+b' with extra colour formatting as a workaround for some time now.

> Ciao,
> Johannes
-- 
Best regards.
Ilya Tumaykin.
Johannes Schindelin· Jul 25, 2016, 08:06 UTC · re: Ilya Tumaykin · lore

Re: Bug: "git log --format='format:%+s%+b'" doesn't insert newline before body

Hi Ilya,
On Mon, 25 Jul 2016, Ilya Tumaykin wrote:
Show 17 quoted lines
> On Monday 25 July 2016 09:33:00 Johannes Schindelin wrote:
> > 
> > On Sun, 24 Jul 2016, Ilya Tumaykin wrote:
> > [...]
> > > $ git --no-pager log -1 --format='format:%+s%+b'
> > > 
> > > Actual results:
> > > ```
> > > 
> > > This is subject
> > > And this is body
> > > ```
> 
> According to 'git-log' man page '%+b' should insert linefeed "immediately 
> before the expansion if and only if the placeholder expands to a non-empty 
> string." Here "%b" expands to a non-empty string, thus I expect a linefeed 
> before it. Or am I misinterpreting man page somehow?

The line break is there: after the subject. The misinterpretation is most likely the assumption that the new-line "character" is part of the commit subject; It is not.

Show 10 quoted lines
> > Unless you somehow allow empty commit messages (Git does not, unless
> > you play games with low-level commands), the second '+' is
> > unnecessarily conditional. Therefore "%s%n%+b" *might* do what you
> > intended (I would not know, because that information was missing from
> > the report).
> 
> I want to display '%B', but add colours to '%s'. Thus I have to
> separately include '%s' and '%b', and not just '%B'. I was using
> '%+s%n%+b' with extra colour formatting as a workaround for some time
> now.

Okay. Hopefully the explanation above clarifies that this is not a work-around, but the correct solution.

Ciao, Johannes

Ilya Tumaykin· Jul 25, 2016, 10:49 UTC · re: Johannes Schindelin · lore

Re: Bug: "git log --format='format:%+s%+b'" doesn't insert newline before body

On Monday 25 July 2016 10:06:28 Johannes Schindelin wrote:
Show 24 quoted lines
> Hi Ilya,
> 
> On Mon, 25 Jul 2016, Ilya Tumaykin wrote:
> > On Monday 25 July 2016 09:33:00 Johannes Schindelin wrote:
> > > On Sun, 24 Jul 2016, Ilya Tumaykin wrote:
> > > [...]
> > > 
> > > > $ git --no-pager log -1 --format='format:%+s%+b'
> > > > 
> > > > Actual results:
> > > > ```
> > > > 
> > > > This is subject
> > > > And this is body
> > > > ```
> > 
> > According to 'git-log' man page '%+b' should insert linefeed "immediately
> > before the expansion if and only if the placeholder expands to a non-empty
> > string." Here "%b" expands to a non-empty string, thus I expect a linefeed
> > before it. Or am I misinterpreting man page somehow?
> 
> The line break is there: after the subject. The misinterpretation is most
> likely the assumption that the new-line "character" is part of the commit
> subject; It is not.
I see. Thank you very much for the explanation. This does help me.
-- 
Best regards.
Ilya Tumaykin.
Jakub Narębski· Jul 25, 2016, 17:28 UTC · re: Johannes Schindelin · lore

Re: Bug: "git log --format='format:%+s%+b'" doesn't insert newline before body

W dniu 2016-07-25 o 09:33, Johannes Schindelin pisze:
> Therefore "%s%n%+b" *might* do what you intended (I would not
> know, because that information was missing from the report).
Shouldn't it be "%s%n%n%-b" or "%s%n%-b"?
-- 
Jakub Narębski

← back to recent threads