git-push.txt: describe how to default to pushing only current branch
[git/git.git] / Documentation / git-checkout.txt
CommitLineData
215a7ad1
JH
1git-checkout(1)
2===============
7fc9d69f
JH
3
4NAME
5----
76ce9462 6git-checkout - Checkout a branch or paths to the working tree
7fc9d69f
JH
7
8SYNOPSIS
9--------
71bb1033 10[verse]
c7cb12b8 11'git checkout' [-q] [-f] [-t | --track | --no-track] [-b <new_branch> [-l]] [-m] [<branch>]
eac5a401 12'git checkout' [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] [--] <paths>...
7fc9d69f
JH
13
14DESCRIPTION
15-----------
4aaa7027 16
71bb1033 17When <paths> are not given, this command switches branches by
4aaa7027
JH
18updating the index and working tree to reflect the specified
19branch, <branch>, and updating HEAD to be <branch> or, if
71bb1033 20specified, <new_branch>. Using -b will cause <new_branch> to
0746d19a
PB
21be created; in this case you can use the --track or --no-track
22options, which will be passed to `git branch`.
4aaa7027 23
c7cb12b8 24As a convenience, --track will default to creating a branch whose
bb0ceb62
JS
25name is constructed from the specified branch name by stripping
26the first namespace level.
27
4aaa7027
JH
28When <paths> are given, this command does *not* switch
29branches. It updates the named paths in the working tree from
ecc03c1c 30the index file, or from a named <tree-ish> (most often a commit). In
c7cb12b8
MG
31this case, the `-b` and `--track` options are meaningless and giving
32either of them results in an error. The <tree-ish> argument can be
84a978f1
JH
33used to specify a specific tree-ish (i.e. commit, tag or tree)
34to update the index for the given paths before updating the
35working tree.
4aaa7027 36
db941099
JH
37The index may contain unmerged entries after a failed merge. By
38default, if you try to check out such an entry from the index, the
39checkout operation will fail and nothing will be checked out.
38901a48
JH
40Using -f will ignore these unmerged entries. The contents from a
41specific side of the merge can be checked out of the index by
0cf8581e
JH
42using --ours or --theirs. With -m, changes made to the working tree
43file can be discarded to recreate the original conflicted merge result.
7fc9d69f
JH
44
45OPTIONS
46-------
6124aee5 47-q::
2be7fcb4 48 Quiet, suppress feedback messages.
6124aee5 49
0270f7c5 50-f::
db941099
JH
51 When switching branches, proceed even if the index or the
52 working tree differs from HEAD. This is used to throw away
53 local changes.
54+
55When checking out paths from the index, do not fail upon unmerged
56entries; instead, unmerged entries are ignored.
0270f7c5 57
38901a48
JH
58--ours::
59--theirs::
60 When checking out paths from the index, check out stage #2
61 ('ours') or #3 ('theirs') for unmerged paths.
0270f7c5
LAS
62
63-b::
2b1f4247
SP
64 Create a new branch named <new_branch> and start it at
65 <branch>. The new branch name must pass all checks defined
5162e697 66 by linkgit:git-check-ref-format[1]. Some of these checks
2b1f4247 67 may restrict the characters allowed in a branch name.
7fc9d69f 68
3240240f
SB
69-t::
70--track::
ba020ef5 71 When creating a new branch, set up configuration so that 'git-pull'
572fc81d
JS
72 will automatically retrieve data from the start point, which must be
73 a branch. Use this if you always pull from the same upstream branch
74 into the new branch, and if you don't want to use "git pull
75 <repository> <refspec>" explicitly. This behavior is the default
76 when the start point is a remote branch. Set the
77 branch.autosetupmerge configuration variable to `false` if you want
c7cb12b8 78 'git checkout' and 'git branch' to always behave as if '--no-track' were
572fc81d 79 given. Set it to `always` if you want this behavior when the
c7cb12b8 80 start point is either a local or remote branch.
bb0ceb62 81+
c7cb12b8
MG
82If no '-b' option is given, the name of the new branch will be
83derived from the remote branch. If "remotes/" or "refs/remotes/"
84is prefixed it is stripped away, and then the part up to the
9188ed89
AR
85next slash (which would be the nickname of the remote) is removed.
86This would tell us to use "hack" as the local branch when branching
87off of "origin/hack" (or "remotes/origin/hack", or even
88"refs/remotes/origin/hack"). If the given name has no slash, or the above
89guessing results in an empty name, the guessing is aborted. You can
971e8352 90explicitly give a name with '-b' in such a case.
0746d19a
PB
91
92--no-track::
572fc81d 93 Ignore the branch.autosetupmerge configuration variable.
0746d19a 94
969d326d 95-l::
792d2370
JK
96 Create the new branch's reflog. This activates recording of
97 all changes made to the branch ref, enabling use of date
967506bb 98 based sha1 expressions such as "<branchname>@\{yesterday}".
969d326d 99
1be0659e 100-m::
eac5a401 101--merge::
0cf8581e
JH
102 When switching branches,
103 if you have local modifications to one or more files that
71bb1033
JL
104 are different between the current branch and the branch to
105 which you are switching, the command refuses to switch
106 branches in order to preserve your modifications in context.
107 However, with this option, a three-way merge between the current
1be0659e
JH
108 branch, your working tree contents, and the new branch
109 is done, and you will be on the new branch.
110+
111When a merge conflict happens, the index entries for conflicting
112paths are left unmerged, and you need to resolve the conflicts
d7f078b8
SP
113and mark the resolved paths with `git add` (or `git rm` if the merge
114should result in deletion of the path).
0cf8581e
JH
115+
116When checking out paths from the index, this option lets you recreate
117the conflicted merge in the specified paths.
1be0659e 118
eac5a401
JH
119--conflict=<style>::
120 The same as --merge option above, but changes the way the
121 conflicting hunks are presented, overriding the
122 merge.conflictstyle configuration variable. Possible values are
123 "merge" (default) and "diff3" (in addition to what is shown by
124 "merge" style, shows the original contents).
1be0659e 125
0270f7c5
LAS
126<new_branch>::
127 Name for the new branch.
7fc9d69f 128
0270f7c5
LAS
129<branch>::
130 Branch to checkout; may be any object ID that resolves to a
5e1a2e8c
JH
131 commit. Defaults to HEAD.
132+
133When this parameter names a non-branch (but still a valid commit object),
134your HEAD becomes 'detached'.
696acf45
TR
135+
136As a special case, the "`@\{-N\}`" syntax for the N-th last branch
137checks out the branch (instead of detaching). You may also specify
138"`-`" which is synonymous with "`@\{-1\}`".
5e1a2e8c
JH
139
140
141Detached HEAD
142-------------
143
144It is sometimes useful to be able to 'checkout' a commit that is
145not at the tip of one of your branches. The most obvious
146example is to check out the commit at a tagged official release
147point, like this:
148
149------------
150$ git checkout v2.6.18
151------------
152
153Earlier versions of git did not allow this and asked you to
c7cb12b8 154create a temporary branch using the `-b` option, but starting from
5e1a2e8c 155version 1.5.0, the above command 'detaches' your HEAD from the
c7cb12b8
MG
156current branch and directly points at the commit named by the tag
157(`v2.6.18` in the example above).
5e1a2e8c 158
c7cb12b8 159You can use all git commands while in this state. You can use
b1889c36 160`git reset --hard $othercommit` to further move around, for
5e1a2e8c
JH
161example. You can make changes and create a new commit on top of
162a detached HEAD. You can even create a merge by using `git
163merge $othercommit`.
164
165The state you are in while your HEAD is detached is not recorded
166by any branch (which is natural --- you are not on any branch).
167What this means is that you can discard your temporary commits
168and merges by switching back to an existing branch (e.g. `git
169checkout master`), and a later `git prune` or `git gc` would
cec8d146
JH
170garbage-collect them. If you did this by mistake, you can ask
171the reflog for HEAD where you were, e.g.
172
173------------
174$ git log -g -2 HEAD
175------------
7fc9d69f 176
4aaa7027 177
1be0659e
JH
178EXAMPLES
179--------
4aaa7027 180
1be0659e 181. The following sequence checks out the `master` branch, reverts
4aaa7027
JH
182the `Makefile` to two revisions back, deletes hello.c by
183mistake, and gets it back from the index.
1be0659e 184+
4aaa7027 185------------
48aeecdc
SE
186$ git checkout master <1>
187$ git checkout master~2 Makefile <2>
4aaa7027 188$ rm -f hello.c
48aeecdc
SE
189$ git checkout hello.c <3>
190------------
191+
1e2ccd3a 192<1> switch branch
c7cb12b8 193<2> take a file out of another commit
48aeecdc 194<3> restore hello.c from HEAD of current branch
1be0659e 195+
48aeecdc
SE
196If you have an unfortunate branch that is named `hello.c`, this
197step would be confused as an instruction to switch to that branch.
198You should instead write:
1be0659e 199+
4aaa7027
JH
200------------
201$ git checkout -- hello.c
202------------
203
c7cb12b8 204. After working in the wrong branch, switching to the correct
71bb1033 205branch would be done using:
1be0659e
JH
206+
207------------
208$ git checkout mytopic
209------------
210+
211However, your "wrong" branch and correct "mytopic" branch may
c7cb12b8 212differ in files that you have modified locally, in which case
1be0659e
JH
213the above checkout would fail like this:
214+
215------------
216$ git checkout mytopic
217fatal: Entry 'frotz' not uptodate. Cannot merge.
218------------
219+
220You can give the `-m` flag to the command, which would try a
221three-way merge:
222+
223------------
224$ git checkout -m mytopic
225Auto-merging frotz
226------------
227+
228After this three-way merge, the local modifications are _not_
229registered in your index file, so `git diff` would show you what
230changes you made since the tip of the new branch.
231
232. When a merge conflict happens during switching branches with
233the `-m` option, you would see something like this:
234+
235------------
236$ git checkout -m mytopic
237Auto-merging frotz
1be0659e
JH
238ERROR: Merge conflict in frotz
239fatal: merge program failed
240------------
241+
242At this point, `git diff` shows the changes cleanly merged as in
243the previous example, as well as the changes in the conflicted
244files. Edit and resolve the conflict and mark it resolved with
d7f078b8 245`git add` as usual:
1be0659e
JH
246+
247------------
248$ edit frotz
d7f078b8 249$ git add frotz
1be0659e
JH
250------------
251
4aaa7027 252
7fc9d69f
JH
253Author
254------
255Written by Linus Torvalds <torvalds@osdl.org>
256
257Documentation
258--------------
259Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
260
261GIT
262---
9e1f0a85 263Part of the linkgit:git[1] suite