Skip to content

Commit 1c573a3

Browse files
newrengitster
authored andcommitted
Documentation/git-merge-tree.adoc: clarify the --merge-base option
The --merge-base option for merge-tree has a few slightly awkward constructions or omissions: * Split the initial long sentence describing the option into two, making the instructions and the limitations clearer for readers. * Add context to the final sentence that might be obvious to some readers but isn't immediately obvious to all. * The discussion about lack of support for multiple merge bases simply leave folks wondering why that matters and could help or hurt. Separate it out and add a brief explanation. Signed-off-by: Elijah Newren <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent c44beea commit 1c573a3

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

Documentation/git-merge-tree.adoc

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,11 +78,17 @@ OPTIONS
7878
7979
--merge-base=<tree-ish>::
8080
Instead of finding the merge-bases for <branch1> and <branch2>,
81-
specify a merge-base for the merge, and specifying multiple bases is
82-
currently not supported. This option is incompatible with `--stdin`.
81+
specify a merge-base for the merge. This option is incompatible with
82+
`--stdin`.
8383
+
84-
As the merge-base is provided directly, <branch1> and <branch2> do not need
85-
to specify commits; trees are enough.
84+
Specifying multiple bases is currently not supported, which means that when
85+
merging two branches with more than one merge-base, using this option may
86+
cause merge results to differ from what `git merge` would compute. This
87+
can include potentially losing some changes made on one side of the history
88+
in the resulting merge.
89+
+
90+
With this option, since the merge-base is provided directly, <branch1> and
91+
<branch2> do not need to specify commits; trees are enough.
8692
8793
-X<option>::
8894
--strategy-option=<option>::

0 commit comments

Comments
 (0)