Re: [PATCH] rebase -i: allow a comment after a "break" command

From: Junio C Hamano <gitster@pobox.com>
Date: Jan 12, 2023, 15:52 UTC
Message-ID: <xmqq358fu4vr.fsf@gitster.g>
In-Reply-To: <pull.1460.git.1673519809510.gitgitgadget@gmail.com>

"Phillip Wood via GitGitGadget" <gitgitgadget@gmail.com> writes:

Show 10 quoted lines

> From: Phillip Wood <phillip.wood@dunelm.org.uk>
>
> When adding a "break" command to a rebase todo list it can be helpful to
> add a comment as a reminder as to what the user was planning to do when
> the rebase stopped. Anything following the command is interpreted as an
> argument to the command and results in an error. Change this so that a
> "break command may be followed by "# <comment>" in the same way as
> a "merge" command. Requiring the comment to begin with "# " allows the
> break command to start taking an argument in the future if that turns
> out to be useful.

Why do we special case "break" and not give the same "comment is emitted when the control reaches the insn in the todo list" for others like "exec" or even "pick"?

Another comment with devil's advocate hat on is if we are better off not adding "# this comment is emitted" at all, and instead do

    pick ...
    pick ...
    exec echo this comment is emitted
    break
    pick ...