diff options
| author | Junio C Hamano <gitster@pobox.com> | 2012-09-07 18:09:36 (GMT) |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2012-09-07 18:09:36 (GMT) |
| commit | 9192ece94b94ccbc061216517251400db691de86 (patch) | |
| tree | d2a6a31b20a8c6665335ecc206fadbe6f569e75e | |
| parent | 757bf26c8512c21e841f75d16be624eb7fb4272c (diff) | |
| parent | 45aaf0310f2b85d9c3264d1703c82cd5085aaf24 (diff) | |
| download | git-9192ece94b94ccbc061216517251400db691de86.zip git-9192ece94b94ccbc061216517251400db691de86.tar.gz git-9192ece94b94ccbc061216517251400db691de86.tar.bz2 | |
Merge branch 'jc/maint-doc-checkout-b-always-takes-branch-name'
The synopsis said "checkout [-B branch]" to make it clear the branch
name is a parameter to the option, but the heading for the option
description was "-B::", not "-B branch::", making the documentation
misleading. There may be room in documentation pages of other
commands for similar improvements.
* jc/maint-doc-checkout-b-always-takes-branch-name:
doc: "git checkout -b/-B/--orphan" always takes a branch name
| -rw-r--r-- | Documentation/git-checkout.txt | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt index 63a2516..11cc7f0 100644 --- a/Documentation/git-checkout.txt +++ b/Documentation/git-checkout.txt @@ -84,11 +84,11 @@ entries; instead, unmerged entries are ignored. When checking out paths from the index, check out stage #2 ('ours') or #3 ('theirs') for unmerged paths. --b:: +-b <new_branch>:: Create a new branch named <new_branch> and start it at <start_point>; see linkgit:git-branch[1] for details. --B:: +-B <new_branch>:: Creates the branch <new_branch> and start it at <start_point>; if it already exists, then reset it to <start_point>. This is equivalent to running "git branch" with "-f"; see @@ -124,7 +124,7 @@ explicitly give a name with '-b' in such a case. <commit> is not a branch name. See the "DETACHED HEAD" section below for details. ---orphan:: +--orphan <new_branch>:: Create a new 'orphan' branch, named <new_branch>, started from <start_point> and switch to it. The first commit made on this new branch will have no parents and it will be the root of a new |