merge: clarify call chain
commit62dc42b9370b123924ba3423d51976e78d13a924
authorMichael J Gruber <git@grubix.eu>
Wed, 23 Aug 2017 12:10:43 +0000 (23 14:10 +0200)
committerJunio C Hamano <gitster@pobox.com>
Wed, 23 Aug 2017 17:34:41 +0000 (23 10:34 -0700)
tree910e279d1f9eb15653e265e03575694efbd6eec9
parente2de82f27128441278da979ef101239c40188064
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>
builtin/merge.c