Re: [PATCH/RFC] sequencer.c: record revert/cherry-pick commit with trailer lines

From: Duy Nguyen <pclouds@gmail.com>
Date: Nov 5, 2018, 16:17 UTC
Message-ID: <CACsJy8AzriX4YYSSZN-U06HHKgL9XmkJ1WhWbLo4LwZvECa8hw@mail.gmail.com>
In-Reply-To: <xmqqtvkwl4u8.fsf@gitster-ct.c.googlers.com>

On Mon, Nov 5, 2018 at 1:56 AM Junio C Hamano <gitster@pobox.com> wrote:

Show 13 quoted lines

>
> Nguyễn Thái Ngọc Duy  <pclouds@gmail.com> writes:
>
> > A reverted commit will have a new trailer
> >
> >     Revert: <commit-id>
>
> Please don't, unless you are keeping the current "the effect of
> commit X relative to its parent Y was reverted" writtein in prose,
> which is meant to be followed up with a manually written "because
> ..." and adding this as an extra footer that is meant solely for
> machine consumption.  Of course reversion of a merge needs to say
> relative to which parent of the merge it is undoing.

I think the intent of writing "This reverts .... " to encourage writing "because ..." is good, but in practice many people just simply not do it. And by not describing anything at all (footers don't count) some commit hook can force people to actually write something.

But for the transition period I think we need to keep both anyway, whether this "This reverts ..." should stay could be revisited another day (or not, even).

Show 9 quoted lines

> > Similarly a cherry-picked commit with -x will have
> >
> >     Cherry-Pick: <commit-id>
>
> Unlike the "revert" change above, this probably is a good change, as
> a"(cherry-pickt-from: X)" does not try to convey anything more or
> anything less than such a standard looking trailer and it is in
> different shape only by historical accident.  But people's scripts
> may need to have a long transition period for this change to happen.

Yep. I'll code something up to print both by default with config knobs to disable either. Unless you have some better plan of course.

-- 
Duy