Browse Source

git-merge-base/git-show-branch: Cleanup documentation and usage

Make sure that usage strings and documentation coincide with each other
and with the actual code.

Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Michael J Gruber 16 years ago committed by Junio C Hamano
parent
commit
995bdc73fe
  1. 5
      Documentation/git-merge-base.txt
  2. 5
      Documentation/git-show-branch.txt
  3. 2
      builtin-merge-base.c
  4. 4
      builtin-show-branch.c

5
Documentation/git-merge-base.txt

@ -8,12 +8,12 @@ git-merge-base - Find as good common ancestors as possible for a merge


SYNOPSIS SYNOPSIS
-------- --------
'git merge-base' [--all] <commit> <commit>... 'git merge-base' [-a|--all] <commit> <commit>...


DESCRIPTION DESCRIPTION
----------- -----------


'git-merge-base' finds best common ancestor(s) between two commits to use 'git merge-base' finds best common ancestor(s) between two commits to use
in a three-way merge. One common ancestor is 'better' than another common in a three-way merge. One common ancestor is 'better' than another common
ancestor if the latter is an ancestor of the former. A common ancestor ancestor if the latter is an ancestor of the former. A common ancestor
that does not have any better common ancestor is a 'best common that does not have any better common ancestor is a 'best common
@ -29,6 +29,7 @@ the given two commits.


OPTIONS OPTIONS
------- -------
-a::
--all:: --all::
Output all merge bases for the commits, instead of just one. Output all merge bases for the commits, instead of just one.



5
Documentation/git-show-branch.txt

@ -8,11 +8,12 @@ git-show-branch - Show branches and their commits
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'git show-branch' [--all] [--remotes] [--topo-order | --date-order] 'git show-branch' [-a|--all] [-r|--remotes] [--topo-order | --date-order]
[--current] [--color | --no-color] [--current] [--color | --no-color] [--sparse]
[--more=<n> | --list | --independent | --merge-base] [--more=<n> | --list | --independent | --merge-base]
[--no-name | --sha1-name] [--topics] [--no-name | --sha1-name] [--topics]
[<rev> | <glob>]... [<rev> | <glob>]...

'git show-branch' (-g|--reflog)[=<n>[,<base>]] [--list] [<ref>] 'git show-branch' (-g|--reflog)[=<n>[,<base>]] [--list] [<ref>]


DESCRIPTION DESCRIPTION

2
builtin-merge-base.c

@ -23,7 +23,7 @@ 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 [--all] <commit-id> <commit-id>...", "git merge-base [-a|--all] <commit> <commit>...",
NULL NULL
}; };



4
builtin-show-branch.c

@ -6,8 +6,8 @@
#include "parse-options.h" #include "parse-options.h"


static const char* show_branch_usage[] = { static const char* show_branch_usage[] = {
"git show-branch [--sparse] [--current] [--all] [--remotes] [--topo-order] [--more=count | --list | --independent | --merge-base] [--topics] [--color] [<refs>...]", "git show-branch [-a|--all] [-r|--remotes] [--topo-order | --date-order] [--current] [--color | --no-color] [--sparse] [--more=<n> | --list | --independent | --merge-base] [--no-name | --sha1-name] [--topics] [<rev> | <glob>]...",
"--reflog[=n[,b]] [--list] [--color] <branch>", "git show-branch (-g|--reflog)[=<n>[,<base>]] [--list] [<ref>]",
NULL NULL
}; };



Loading…
Cancel
Save