From 5729482429725c4688c678701ca5197eaf367a07 Mon Sep 17 00:00:00 2001 From: Vincent van Ravesteijn Date: Fri, 15 Apr 2011 10:34:03 +0200 Subject: Documentation: update to git-merge-base --octopus Unlike plain merge-base, merge-base --octopus only requires at least one commit argument; update the synopsis to reflect that. Add a sentence to the discussion that when --octopus is used, we do expect '2' (the common ansestor across all) as the result. Signed-off-by: Vincent van Ravesteijn Reviewed-by: Jonathan Nieder Signed-off-by: Junio C Hamano --- Documentation/git-merge-base.txt | 6 +++++- builtin/merge-base.c | 3 ++- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/Documentation/git-merge-base.txt b/Documentation/git-merge-base.txt index eedef1bb1..a9f677b8f 100644 --- a/Documentation/git-merge-base.txt +++ b/Documentation/git-merge-base.txt @@ -9,7 +9,8 @@ git-merge-base - Find as good common ancestors as possible for a merge SYNOPSIS -------- [verse] -'git merge-base' [-a|--all] [--octopus] ... +'git merge-base' [-a|--all] ... +'git merge-base' [-a|--all] --octopus ... 'git merge-base' --independent ... DESCRIPTION @@ -89,6 +90,9 @@ and the result of `git merge-base A M` is '1'. Commit '2' is also a common ancestor between 'A' and 'M', but '1' is a better common ancestor, because '2' is an ancestor of '1'. Hence, '2' is not a merge base. +The result of `git merge-base --octopus A B C` is '2', because '2' is +the best common ancestor of all commits. + When the history involves criss-cross merges, there can be more than one 'best' common ancestor for two commits. For example, with this topology: diff --git a/builtin/merge-base.c b/builtin/merge-base.c index 96dd16073..4f30f1b0c 100644 --- a/builtin/merge-base.c +++ b/builtin/merge-base.c @@ -23,7 +23,8 @@ static int show_merge_base(struct commit **rev, int rev_nr, int show_all) } static const char * const merge_base_usage[] = { - "git merge-base [-a|--all] [--octopus] ...", + "git merge-base [-a|--all] ...", + "git merge-base [-a|--all] --octopus ...", "git merge-base --independent ...", NULL }; -- cgit v1.2.1 From ded7e0491b78e3e8384bcd9f63918c52785c4cd6 Mon Sep 17 00:00:00 2001 From: Jonathan Nieder Date: Fri, 15 Apr 2011 10:38:55 +0200 Subject: Restructure documentation for git-merge-base. Restructure the text of git-merge-base to better explain more clearly the different modes of operation. Signed-off-by: Vincent van Ravesteijn Signed-off-by: Junio C Hamano --- Documentation/git-merge-base.txt | 28 ++++++++++++++++------------ 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/Documentation/git-merge-base.txt b/Documentation/git-merge-base.txt index a9f677b8f..3fe510f85 100644 --- a/Documentation/git-merge-base.txt +++ b/Documentation/git-merge-base.txt @@ -23,23 +23,21 @@ that does not have any better common ancestor is a 'best common ancestor', i.e. a 'merge base'. Note that there can be more than one merge base for a pair of commits. -Unless `--octopus` is given, among the two commits to compute the merge -base from, one is specified by the first commit argument on the command -line; the other commit is a (possibly hypothetical) commit that is a merge -across all the remaining commits on the command line. As the most common -special case, specifying only two commits on the command line means -computing the merge base between the given two commits. +OPERATION MODE +-------------- + +As the most common special case, specifying only two commits on the +command line means computing the merge base between the given two commits. + +More generally, among the two commits to compute the merge base from, +one is specified by the first commit argument on the command line; +the other commit is a (possibly hypothetical) commit that is a merge +across all the remaining commits on the command line. As a consequence, the 'merge base' is not necessarily contained in each of the commit arguments if more than two commits are specified. This is different from linkgit:git-show-branch[1] when used with the `--merge-base` option. -OPTIONS -------- --a:: ---all:: - Output all merge bases for the commits, instead of just one. - --octopus:: Compute the best common ancestors of all supplied commits, in preparation for an n-way merge. This mimics the behavior @@ -52,6 +50,12 @@ OPTIONS from any other. This mimics the behavior of 'git show-branch --independent'. +OPTIONS +------- +-a:: +--all:: + Output all merge bases for the commits, instead of just one. + DISCUSSION ---------- -- cgit v1.2.1