diff options
| author |  Michael J Gruber <git@drmicha.warpmail.net> | 2009-08-05 09:59:20 +0200 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2009-08-05 10:29:37 -0700 |
| commit | f621a8454d19d17fe46e6951b7e3d22bebd92aba (patch) | |
| tree | aae7fd662daff4819773be4deee37e564c4a0bdf /Documentation | |
| parent | git-merge-base/git-show-branch: Cleanup documentation and usage (diff) | |
| download | tgif-f621a8454d19d17fe46e6951b7e3d22bebd92aba.tar.xz | |
git-merge-base/git-show-branch --merge-base: Documentation and test
Currently, the documentation suggests that 'git merge-base -a' and 'git
show-branch --merge-base' are equivalent (in fact it claims that the
former cannot handle more than two revs).
Alas, the handling of more than two revs is very different. Document
this by tests and correct the documentation to reflect this.
Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/git-merge-base.txt | 4 | ||||
| -rw-r--r-- | Documentation/git-show-branch.txt | 8 |
2 files changed, 9 insertions, 3 deletions
diff --git a/Documentation/git-merge-base.txt b/Documentation/git-merge-base.txt index 00e400353c..ce5b369985 100644 --- a/Documentation/git-merge-base.txt +++ b/Documentation/git-merge-base.txt @@ -27,6 +27,10 @@ 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. +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:: diff --git a/Documentation/git-show-branch.txt b/Documentation/git-show-branch.txt index 2c78c25713..734336119c 100644 --- a/Documentation/git-show-branch.txt +++ b/Documentation/git-show-branch.txt @@ -82,9 +82,11 @@ OPTIONS Synonym to `--more=-1` --merge-base:: - Instead of showing the commit list, just act like the - 'git-merge-base -a' command, except that it can accept - more than two heads. + Instead of showing the commit list, determine possible + merge bases for the specified commits. All merge bases + will be contained in all specified commits. This is + different from how linkgit:git-merge-base[1] handles + the case of three or more commits. --independent:: Among the <reference>s given, display only the ones that |