From: Junio C Hamano <gitster@pobox.com>
Date: Wed, 12 Sep 2012 20:59:58 +0000 (-0700)
Subject: Merge branch 'jc/maint-doc-checkout-b-always-takes-branch-name' into maint-1.7.11
X-Git-Tag: v1.7.11.7~8
X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/1b8bc86b5eb86609c31cae48eb7569b24acacc90?hp=-c

Merge branch 'jc/maint-doc-checkout-b-always-takes-branch-name' into maint-1.7.11

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.

* jc/maint-doc-checkout-b-always-takes-branch-name:
doc: "git checkout -b/-B/--orphan" always takes a branch name
---

1b8bc86b5eb86609c31cae48eb7569b24acacc90
diff --combined Documentation/git-checkout.txt
index 63a251612a,e3270cdbc5..11cc7f0588
--- a/Documentation/git-checkout.txt
+++ b/Documentation/git-checkout.txt
@@@ -84,11 -84,11 +84,11 @@@ entries; instead, unmerged entries are 
  	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 +124,7 @@@ explicitly give a name with '-b' in suc
  	<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
@@@ -184,7 -184,7 +184,7 @@@ the conflicted merge in the specified p
  +
  This means that you can use `git checkout -p` to selectively discard
  edits from your current working tree. See the ``Interactive Mode''
 -section of linkgit:git-add[1] to learn how to operate the `\--patch` mode.
 +section of linkgit:git-add[1] to learn how to operate the `--patch` mode.
  
  <branch>::
  	Branch to checkout; if it refers to a branch (i.e., a name that,
@@@ -193,11 -193,11 +193,11 @@@
  	commit, your HEAD becomes "detached" and you are no longer on
  	any branch (see below for details).
  +
 -As a special case, the `"@\{-N\}"` syntax for the N-th last branch
 +As a special case, the `"@{-N}"` syntax for the N-th last branch
  checks out the branch (instead of detaching).  You may also specify
 -`-` which is synonymous with `"@\{-1\}"`.
 +`-` which is synonymous with `"@{-1}"`.
  +
 -As a further special case, you may use `"A\...B"` as a shortcut for the
 +As a further special case, you may use `"A...B"` as a shortcut for the
  merge base of `A` and `B` if there is exactly one merge base. You can
  leave out at most one of `A` and `B`, in which case it defaults to `HEAD`.