undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation: update to git-merge-base --octopus

Browse Source 
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 <vfr@lyx.org>
Reviewed-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Vincent van Ravesteijn 2011-04-15 10:34:03 +02:00 committed by Junio C Hamano
parent 810cae53e0
commit 5729482429
2 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Documentation/git-merge-base.txt
View File

@ -9,7 +9,8 @@ git-merge-base - Find as good common ancestors as possible for a merge
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'git merge-base' [-a|--all] [--octopus] <commit> <commit>... 'git merge-base' [-a|--all] <commit> <commit>...
'git merge-base' [-a|--all] --octopus <commit>...
'git merge-base' --independent <commit>... 'git merge-base' --independent <commit>...
DESCRIPTION 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, 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. 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 When the history involves criss-cross merges, there can be more than one
'best' common ancestor for two commits. For example, with this topology: 'best' common ancestor for two commits. For example, with this topology:

3
builtin/merge-base.c
View File

@ -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[] = { static const char * const merge_base_usage[] = {
"git merge-base [-a|--all] [--octopus] <commit> <commit>...", "git merge-base [-a|--all] <commit> <commit>...",
"git merge-base [-a|--all] --octopus <commit>...",
"git merge-base --independent <commit>...", "git merge-base --independent <commit>...",
NULL NULL
}; };