merge: clarify call chain

prepare_to_commit() cannot be reached in the non-squash case: It is called by merge_trivial() and finish_automerge() only, but the calls to the latter are somewhat hard to track: If option_commit is not set, the code in cmd_merge() uses a fake conflict return code (ret=1) to avoid writing the tree, which also avoids setting automerge_was_ok (just as in the proper ret==1 case), so that finish_automerge() is not called. To ensure that no code change breaks that assumption, safe-guard prepare_to_commit() by a BUG() statement. Suggested-by: Junio C Hamano <gitster@pobox.com> Signed-off-by: Michael J Gruber <git@grubix.eu> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Michael J Gruber committed Aug 23, 2017 at 14:10 UTC 62dc42b9370b123924ba3423d51976e78d13a924
1 file changed +2
builtin/merge.c
+2
@@ -761,6 +761,8 @@ static void prepare_to_commit(struct commit_list *remoteheads)
761 struct strbuf msg = STRBUF_INIT;
762 strbuf_addbuf(&msg, &merge_msg);
763 strbuf_addch(&msg, '\n');
764 + if (squash)
765 + BUG("the control must not reach here under --squash");
766 if (0 < option_edit)
767 strbuf_commented_addf(&msg, _(merge_editor_comment), comment_line_char);
768 write_file_buf(git_path_merge_msg(), msg.buf, msg.len);