rebase -i: mark commits that begin empty in todo editor

While many users who intentionally create empty commits do not want them thrown away by a rebase, there are third-party tools that generate empty commits that a user might not want. In the past, users have used rebase to get rid of such commits (a side-effect of the fact that the --apply backend is not currently capable of keeping them). While such users could fire up an interactive rebase and just remove the lines corresponding to empty commits, that might be difficult if the third-party tool generates many of them. Simplify this task for users by marking such lines with a suffix of " # empty" in the todo list. Suggested-by: Sami Boukortt <sami@boukortt.com> Signed-off-by: Elijah Newren <newren@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Elijah Newren committed Apr 11, 2020 at 02:44 UTC 1b5735f75c7fd5a46a86adce35d1ed0c6e00ee0f

2 files changed +7 -1

Documentation/git-rebase.txt

+2 -1

@@ -620,7 +620,8 @@ commits that started empty, though these are rare in practice. It

620 also drops commits that become empty and has no option for controlling

621 this behavior.

622

623 -The merge backend keeps intentionally empty commits. Similar to the

623 +The merge backend keeps intentionally empty commits (though with -i

624 +they are marked as empty in the todo list editor). Similar to the

625 apply backend, by default the merge backend drops commits that become

626 empty unless -i/--interactive is specified (in which case it stops and

627 asks the user what to do). The merge backend also has an

sequencer.c

@@ -4656,6 +4656,9 @@ static int make_script_with_merges(struct pretty_print_context *pp,

4656 strbuf_addf(&buf, "%s %s %s", cmd_pick,

4657 oid_to_hex(&commit->object.oid),

4658 oneline.buf);

4659 + if (is_empty)

4660 + strbuf_addf(&buf, " %c empty",

4661 + comment_line_char);

4662

4663 FLEX_ALLOC_STR(entry, string, buf.buf);

4664 oidcpy(&entry->entry.oid, &commit->object.oid);

@@ -4861,6 +4864,8 @@ int sequencer_make_script(struct repository *r, struct strbuf *out, int argc,

4864 strbuf_addf(out, "%s %s ", insn,

4865 oid_to_hex(&commit->object.oid));

4866 pretty_print_commit(&pp, commit, out);

4867 + if (is_empty)

4868 + strbuf_addf(out, " %c empty", comment_line_char);

4869 strbuf_addch(out, '\n');

4870 }

4871 return 0;