Re: git cherry-pick -x: missing blank line before the "cherry picked from commit" line

From: Vincent Lefevre <vincent@vinc17.net>
Date: Dec 2, 2022, 17:01 UTC
Message-ID: <20221202170144.GC5599@cventin.lip.ens-lyon.fr>
In-Reply-To: <75e00d43-3184-dcf8-4621-cdf02c9f7320@dunelm.org.uk>

Hi Phillip,

On 2022-12-02 16:41:23 +0000, Phillip Wood wrote:

Show 22 quoted lines

> On 02/12/2022 14:11, Vincent Lefevre wrote:
> > With git 2.38.1 under Debian, when I use "git cherry-pick -x"
> > on a commit such that the last line of the log message starts
> > with "note:" (case insensitively), the blank line before the
> > "cherry picked from commit" line is missing.
> > 
> > For instance:
> > 
> >      New commit
> >      foo
> >      nOtE:
> >      (cherry picked from commit 3ba643e2eec4bdc1cd46b478ab36ee0707d241c2)
> 
> "git cherry-pick -x" takes care not to add a blank line if there are
> trailers such as Signed-off-by: at the end of the message (if it did then
> the trailers would no longer be recognized as trailers as they would not be
> the last paragraph). In this case the "nOtE:" line looks like a trailer and
> so no blank line is added.
> 
> I can see it is annoying in this case but I'm afraid I don't have any ideas
> of how we could avoid it without breaking the case where the message does
> contain trailers.

First, one issue is that this is not documented (I was not aware of the notion of trailers, well, at least concerning a special handling by Git).

Then perhaps there should be some configuration to define which tokens are allowed (or forbidden) for trailers. For instance, I would say that "Note" is too common in log messages to be regarded as a trailer token.

-- 
Vincent Lefèvre <vincent@vinc17.net> - Web: <https://www.vinc17.net/>
100% accessible validated (X)HTML - Blog: <https://www.vinc17.net/blog/>
Work: CR INRIA - computer arithmetic / AriC project (LIP, ENS-Lyon)