Skip to content

Commit

Permalink
git-merge-base/git-show-branch: Cleanup documentation and usage
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Michael J Gruber authored and Junio C Hamano committed Aug 5, 2009
1 parent 30ca4ca commit 995bdc7
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 7 deletions.
5 changes: 3 additions & 2 deletions Documentation/git-merge-base.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ git-merge-base - Find as good common ancestors as possible for a merge

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

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
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
Expand All @@ -29,6 +29,7 @@ the given two commits.

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

Expand Down
5 changes: 3 additions & 2 deletions Documentation/git-show-branch.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,12 @@ git-show-branch - Show branches and their commits
SYNOPSIS
--------
[verse]
'git show-branch' [--all] [--remotes] [--topo-order | --date-order]
[--current] [--color | --no-color]
'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>]...

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

DESCRIPTION
Expand Down
2 changes: 1 addition & 1 deletion builtin-merge-base.c
Original file line number Diff line number Diff line change
Expand Up @@ -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[] = {
"git merge-base [--all] <commit-id> <commit-id>...",
"git merge-base [-a|--all] <commit> <commit>...",
NULL
};

Expand Down
4 changes: 2 additions & 2 deletions builtin-show-branch.c
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
#include "parse-options.h"

static const char* show_branch_usage[] = {
"git show-branch [--sparse] [--current] [--all] [--remotes] [--topo-order] [--more=count | --list | --independent | --merge-base] [--topics] [--color] [<refs>...]",
"--reflog[=n[,b]] [--list] [--color] <branch>",
"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>]...",
"git show-branch (-g|--reflog)[=<n>[,<base>]] [--list] [<ref>]",
NULL
};

Expand Down

0 comments on commit 995bdc7

Please sign in to comment.