From: Chris Rorvick <chris@rorvick.com>
To: git@vger.kernel.org
Cc: Chris Rorvick <chris@rorvick.com>,
Andrew Ardill <andrew.ardill@gmail.com>,
Tomas Carnecky <tomas.carnecky@gmail.com>,
Woody Wu <narkewoody@gmail.com>
Subject: [PATCH 1/2] Documentation/git-checkout.txt: clarify usage
Date: Mon, 17 Dec 2012 00:45:01 -0600 [thread overview]
Message-ID: <1355726702-27974-2-git-send-email-chris@rorvick.com> (raw)
In-Reply-To: <1355726702-27974-1-git-send-email-chris@rorvick.com>
The forms of checkout that do not take a path are lumped together in the
DESCRIPTION section, but the description for this group is dominated by
explanation of the -b|-B form. Split these apart for more clarity.
Signed-off-by: Chris Rorvick <chris@rorvick.com>
---
Documentation/git-checkout.txt | 26 +++++++++++++++++---------
1 file changed, 17 insertions(+), 9 deletions(-)
diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt
index 7958a47..a47555c 100644
--- a/Documentation/git-checkout.txt
+++ b/Documentation/git-checkout.txt
@@ -22,17 +22,18 @@ also update `HEAD` to set the specified branch as the current
branch.
'git checkout' [<branch>]::
+
+ Update the index, working tree, and HEAD to reflect the
+ specified branch.
+
'git checkout' -b|-B <new_branch> [<start point>]::
-'git checkout' [--detach] [<commit>]::
- This form switches branches by updating the index, working
- tree, and HEAD to reflect the specified branch or commit.
-+
-If `-b` is given, a new branch is created as if linkgit:git-branch[1]
-were called and then checked out; in this case you can
-use the `--track` or `--no-track` options, which will be passed to
-'git branch'. As a convenience, `--track` without `-b` implies branch
-creation; see the description of `--track` below.
+ Specifying `-b` causes a new branch to be created as if
+ linkgit:git-branch[1] were called and then checked out. In
+ this case you can use the `--track` or `--no-track` options,
+ which will be passed to 'git branch'. As a convenience,
+ `--track` without `-b` implies branch creation; see the
+ description of `--track` below.
+
If `-B` is given, <new_branch> is created if it doesn't exist; otherwise, it
is reset. This is the transactional equivalent of
@@ -45,6 +46,13 @@ $ git checkout <branch>
that is to say, the branch is not reset/created unless "git checkout" is
successful.
+'git checkout' [--detach] [<commit>]::
+
+ Update the index and working tree to reflect the specified
+ commit and set HEAD to point directly to <commit> (see
+ "DETACHED HEAD" section.) Passing `--detach` forces this
+ behavior even if <commit> is a branch.
+
'git checkout' [-p|--patch] [<tree-ish>] [--] <pathspec>...::
When <paths> or `--patch` are given, 'git checkout' does *not*
--
1.8.1.rc1.203.g1ddc124
next prev parent reply other threads:[~2012-12-17 6:46 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-12-17 6:45 [PATCH 0/2] Documentation: clarify usage of checkout Chris Rorvick
2012-12-17 6:45 ` Chris Rorvick [this message]
2012-12-17 7:21 ` [PATCH 1/2] Documentation/git-checkout.txt: clarify usage Junio C Hamano
2012-12-17 8:20 ` Johannes Sixt
2012-12-17 8:48 ` Junio C Hamano
2012-12-17 8:59 ` Johannes Sixt
2012-12-17 19:12 ` Junio C Hamano
2012-12-17 8:53 ` Andrew Ardill
2012-12-18 2:55 ` Chris Rorvick
2012-12-17 20:51 ` Philip Oakley
2012-12-17 21:13 ` Junio C Hamano
2012-12-17 21:50 ` Andrew Ardill
2012-12-17 21:59 ` Junio C Hamano
2012-12-18 1:29 ` Andrew Ardill
2012-12-18 1:53 ` Junio C Hamano
2012-12-18 2:12 ` Andrew Ardill
2012-12-18 3:33 ` Chris Rorvick
2012-12-18 16:43 ` Junio C Hamano
2012-12-17 22:40 ` Philip Oakley
2012-12-17 6:45 ` [PATCH 2/2] Documentation/git-checkout.txt: document 70c9ac2 behavior Chris Rorvick
2012-12-17 7:21 ` Junio C Hamano
2012-12-17 7:23 ` Andrew Ardill
2012-12-17 7:26 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1355726702-27974-2-git-send-email-chris@rorvick.com \
--to=chris@rorvick.com \
--cc=andrew.ardill@gmail.com \
--cc=git@vger.kernel.org \
--cc=narkewoody@gmail.com \
--cc=tomas.carnecky@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).