mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rewrite synopsis to clarify the two primary uses of git-checkout.

Browse Source 
Fix a few typo/grammar problems.

Signed-off-by: Jon Loeliger <jdl@jdl.com>
Signed-off-by: Junio C Hamano <junkio@cox.net>
This commit is contained in:
Jon Loeliger
2006-03-17 18:26:01 -06:00
committed by Junio C Hamano
parent beb8e13437
commit 71bb10336f
1 changed files with 13 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
Documentation/git-checkout.txt
View File

@ -7,15 +7,18 @@ git-checkout - Checkout and switch to a branch
SYNOPSIS SYNOPSIS
-------- --------
'git-checkout' [-f] [-b <new_branch>] [-m] [<branch>] [<paths>...] [verse]
'git-checkout' [-f] [-b <new_branch>] [-m] [<branch>]
'git-checkout' [-m] [<branch>] <paths>...
DESCRIPTION DESCRIPTION
----------- -----------
When <paths> are not given, this command switches branches, by When <paths> are not given, this command switches branches by
updating the index and working tree to reflect the specified updating the index and working tree to reflect the specified
branch, <branch>, and updating HEAD to be <branch> or, if branch, <branch>, and updating HEAD to be <branch> or, if
specified, <new_branch>. specified, <new_branch>. Using -b will cause <new_branch> to
be created.
When <paths> are given, this command does *not* switch When <paths> are given, this command does *not* switch
branches. It updates the named paths in the working tree from branches. It updates the named paths in the working tree from
@ -29,17 +32,17 @@ given paths before updating the working tree.
OPTIONS OPTIONS
------- -------
-f:: -f::
Force an re-read of everything. Force a re-read of everything.
-b:: -b::
Create a new branch and start it at <branch>. Create a new branch and start it at <branch>.
-m:: -m::
If you have local modifications to a file that is If you have local modifications to one or more files that
different between the current branch and the branch you are different between the current branch and the branch to
are switching to, the command refuses to switch which you are switching, the command refuses to switch
branches, to preserve your modifications in context. branches in order to preserve your modifications in context.
With this option, a three-way merge between the current However, with this option, a three-way merge between the current
branch, your working tree contents, and the new branch branch, your working tree contents, and the new branch
is done, and you will be on the new branch. is done, and you will be on the new branch.
+ +
@ -82,7 +85,7 @@ $ git checkout -- hello.c
------------ ------------
. After working in a wrong branch, switching to the correct . After working in a wrong branch, switching to the correct
branch you would want to is done with: branch would be done using:
+ +
------------ ------------
$ git checkout mytopic $ git checkout mytopic