Skip to content

Commit

Permalink
Rewrite synopsis to clarify the two primary uses of git-checkout.
Browse files Browse the repository at this point in the history
Fix a few typo/grammar problems.

Signed-off-by: Jon Loeliger <jdl@jdl.com>
Signed-off-by: Junio C Hamano <junkio@cox.net>
  • Loading branch information
Jon Loeliger authored and Junio C Hamano committed Mar 18, 2006
1 parent beb8e13 commit 71bb103
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions Documentation/git-checkout.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,18 @@ git-checkout - Checkout and switch to a branch

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
-----------

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
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
branches. It updates the named paths in the working tree from
Expand All @@ -29,17 +32,17 @@ given paths before updating the working tree.
OPTIONS
-------
-f::
Force an re-read of everything.
Force a re-read of everything.

-b::
Create a new branch and start it at <branch>.

-m::
If you have local modifications to a file that is
different between the current branch and the branch you
are switching to, the command refuses to switch
branches, to preserve your modifications in context.
With this option, a three-way merge between the current
If you have local modifications to one or more files that
are different between the current branch and the branch to
which you are switching, the command refuses to switch
branches in order to preserve your modifications in context.
However, with this option, a three-way merge between the current
branch, your working tree contents, and the new branch
is done, and you will be on the new branch.
+
Expand Down Expand Up @@ -82,7 +85,7 @@ $ git checkout -- hello.c
------------

. 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
Expand Down

0 comments on commit 71bb103

Please sign in to comment.