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

Typo and language fixes for git-checkout.txt

Browse Source 
Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Michael J Gruber
2009-03-10 16:06:30 +01:00
committed by Junio C Hamano
parent 15112c9599
commit c7cb12b86c
1 changed files with 16 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
Documentation/git-checkout.txt
View File

@ -8,7 +8,7 @@ git-checkout - Checkout a branch or paths to the working tree
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
'git checkout' [-q] [-f] [--track | --no-track] [-b <new_branch> [-l]] [-m] [<branch>] 'git checkout' [-q] [-f] [-t | --track | --no-track] [-b <new_branch> [-l]] [-m] [<branch>]
'git checkout' [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] [--] <paths>... 'git checkout' [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] [--] <paths>...
DESCRIPTION DESCRIPTION
@ -21,15 +21,15 @@ specified, <new_branch>. Using -b will cause <new_branch> to
be created; in this case you can use the --track or --no-track be created; in this case you can use the --track or --no-track
options, which will be passed to `git branch`. options, which will be passed to `git branch`.
As a convenience, --track will default to create a branch whose As a convenience, --track will default to creating a branch whose
name is constructed from the specified branch name by stripping name is constructed from the specified branch name by stripping
the first namespace level. the first namespace level.
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
the index file, or from a named <tree-ish> (most often a commit). In the index file, or from a named <tree-ish> (most often a commit). In
this case, the `-b` options is meaningless and giving this case, the `-b` and `--track` options are meaningless and giving
either of them results in an error. <tree-ish> argument can be either of them results in an error. The <tree-ish> argument can be
used to specify a specific tree-ish (i.e. commit, tag or tree) used to specify a specific tree-ish (i.e. commit, tag or tree)
to update the index for the given paths before updating the to update the index for the given paths before updating the
working tree. working tree.
@ -75,14 +75,13 @@ entries; instead, unmerged entries are ignored.
<repository> <refspec>" explicitly. This behavior is the default <repository> <refspec>" explicitly. This behavior is the default
when the start point is a remote branch. Set the when the start point is a remote branch. Set the
branch.autosetupmerge configuration variable to `false` if you want branch.autosetupmerge configuration variable to `false` if you want
'git-checkout' and 'git-branch' to always behave as if '--no-track' were 'git checkout' and 'git branch' to always behave as if '--no-track' were
given. Set it to `always` if you want this behavior when the given. Set it to `always` if you want this behavior when the
start-point is either a local or remote branch. start point is either a local or remote branch.
+ +
If no '-b' option was given, the name of the new branch will be If no '-b' option is given, the name of the new branch will be
derived from the remote branch, by attempting to guess the name derived from the remote branch. If "remotes/" or "refs/remotes/"
of the branch on remote system. If "remotes/" or "refs/remotes/" is prefixed it is stripped away, and then the part up to the
are prefixed, it is stripped away, and then the part up to the
next slash (which would be the nickname of the remote) is removed. next slash (which would be the nickname of the remote) is removed.
This would tell us to use "hack" as the local branch when branching This would tell us to use "hack" as the local branch when branching
off of "origin/hack" (or "remotes/origin/hack", or even off of "origin/hack" (or "remotes/origin/hack", or even
@ -152,12 +151,12 @@ $ git checkout v2.6.18
------------ ------------
Earlier versions of git did not allow this and asked you to Earlier versions of git did not allow this and asked you to
create a temporary branch using `-b` option, but starting from create a temporary branch using the `-b` option, but starting from
version 1.5.0, the above command 'detaches' your HEAD from the version 1.5.0, the above command 'detaches' your HEAD from the
current branch and directly point at the commit named by the tag current branch and directly points at the commit named by the tag
(`v2.6.18` in the above example). (`v2.6.18` in the example above).
You can use usual git commands while in this state. You can use You can use all git commands while in this state. You can use
`git reset --hard $othercommit` to further move around, for `git reset --hard $othercommit` to further move around, for
example. You can make changes and create a new commit on top of example. You can make changes and create a new commit on top of
a detached HEAD. You can even create a merge by using `git a detached HEAD. You can even create a merge by using `git
@ -191,7 +190,7 @@ $ git checkout hello.c <3>
------------ ------------
+ +
<1> switch branch <1> switch branch
<2> take out a file out of other commit <2> take a file out of another commit
<3> restore hello.c from HEAD of current branch <3> restore hello.c from HEAD of current branch
+ +
If you have an unfortunate branch that is named `hello.c`, this If you have an unfortunate branch that is named `hello.c`, this
@ -202,7 +201,7 @@ You should instead write:
$ git checkout -- hello.c $ git checkout -- hello.c
------------ ------------
. After working in a wrong branch, switching to the correct . After working in the wrong branch, switching to the correct
branch would be done using: branch would be done using:
+ +
------------ ------------
@ -210,7 +209,7 @@ $ git checkout mytopic
------------ ------------
+ +
However, your "wrong" branch and correct "mytopic" branch may However, your "wrong" branch and correct "mytopic" branch may
differ in files that you have locally modified, in which case, differ in files that you have modified locally, in which case
the above checkout would fail like this: the above checkout would fail like this:
+ +
------------ ------------