connect.c: remove a few globals by using git_config callback data
[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]
bb0ceb62 11'git checkout' [-q] [-f] [--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
bb0ceb62
JS
24As a convenience, --track will default to create a branch whose
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
db941099 31this case, the `-b` options is meaningless and giving
84a978f1
JH
32either of them results in an error. <tree-ish> argument can be
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
ba020ef5 78 'git-checkout' and 'git-branch' to always behave as if '--no-track' were
572fc81d
JS
79 given. Set it to `always` if you want this behavior when the
80 start-point is either a local or remote branch.
bb0ceb62 81+
9188ed89
AR
82If no '-b' option was given, the name of the new branch will be
83derived from the remote branch, by attempting to guess the name
84of the branch on remote system. If "remotes/" or "refs/remotes/"
85are prefixed, it is stripped away, and then the part up to the
86next slash (which would be the nickname of the remote) is removed.
87This would tell us to use "hack" as the local branch when branching
88off of "origin/hack" (or "remotes/origin/hack", or even
89"refs/remotes/origin/hack"). If the given name has no slash, or the above
90guessing results in an empty name, the guessing is aborted. You can
971e8352 91explicitly give a name with '-b' in such a case.
0746d19a
PB
92
93--no-track::
572fc81d 94 Ignore the branch.autosetupmerge configuration variable.
0746d19a 95
969d326d 96-l::
792d2370
JK
97 Create the new branch's reflog. This activates recording of
98 all changes made to the branch ref, enabling use of date
967506bb 99 based sha1 expressions such as "<branchname>@\{yesterday}".
969d326d 100
1be0659e 101-m::
eac5a401 102--merge::
0cf8581e
JH
103 When switching branches,
104 if you have local modifications to one or more files that
71bb1033
JL
105 are different between the current branch and the branch to
106 which you are switching, the command refuses to switch
107 branches in order to preserve your modifications in context.
108 However, with this option, a three-way merge between the current
1be0659e
JH
109 branch, your working tree contents, and the new branch
110 is done, and you will be on the new branch.
111+
112When a merge conflict happens, the index entries for conflicting
113paths are left unmerged, and you need to resolve the conflicts
d7f078b8
SP
114and mark the resolved paths with `git add` (or `git rm` if the merge
115should result in deletion of the path).
0cf8581e
JH
116+
117When checking out paths from the index, this option lets you recreate
118the conflicted merge in the specified paths.
1be0659e 119
eac5a401
JH
120--conflict=<style>::
121 The same as --merge option above, but changes the way the
122 conflicting hunks are presented, overriding the
123 merge.conflictstyle configuration variable. Possible values are
124 "merge" (default) and "diff3" (in addition to what is shown by
125 "merge" style, shows the original contents).
1be0659e 126
0270f7c5
LAS
127<new_branch>::
128 Name for the new branch.
7fc9d69f 129
0270f7c5
LAS
130<branch>::
131 Branch to checkout; may be any object ID that resolves to a
5e1a2e8c
JH
132 commit. Defaults to HEAD.
133+
134When this parameter names a non-branch (but still a valid commit object),
135your HEAD becomes 'detached'.
696acf45
TR
136+
137As a special case, the "`@\{-N\}`" syntax for the N-th last branch
138checks out the branch (instead of detaching). You may also specify
139"`-`" which is synonymous with "`@\{-1\}`".
5e1a2e8c
JH
140
141
142Detached HEAD
143-------------
144
145It is sometimes useful to be able to 'checkout' a commit that is
146not at the tip of one of your branches. The most obvious
147example is to check out the commit at a tagged official release
148point, like this:
149
150------------
151$ git checkout v2.6.18
152------------
153
154Earlier versions of git did not allow this and asked you to
155create a temporary branch using `-b` option, but starting from
156version 1.5.0, the above command 'detaches' your HEAD from the
157current branch and directly point at the commit named by the tag
158(`v2.6.18` in the above example).
159
160You can use usual git commands while in this state. You can use
b1889c36 161`git reset --hard $othercommit` to further move around, for
5e1a2e8c
JH
162example. You can make changes and create a new commit on top of
163a detached HEAD. You can even create a merge by using `git
164merge $othercommit`.
165
166The state you are in while your HEAD is detached is not recorded
167by any branch (which is natural --- you are not on any branch).
168What this means is that you can discard your temporary commits
169and merges by switching back to an existing branch (e.g. `git
170checkout master`), and a later `git prune` or `git gc` would
cec8d146
JH
171garbage-collect them. If you did this by mistake, you can ask
172the reflog for HEAD where you were, e.g.
173
174------------
175$ git log -g -2 HEAD
176------------
7fc9d69f 177
4aaa7027 178
1be0659e
JH
179EXAMPLES
180--------
4aaa7027 181
1be0659e 182. The following sequence checks out the `master` branch, reverts
4aaa7027
JH
183the `Makefile` to two revisions back, deletes hello.c by
184mistake, and gets it back from the index.
1be0659e 185+
4aaa7027 186------------
48aeecdc
SE
187$ git checkout master <1>
188$ git checkout master~2 Makefile <2>
4aaa7027 189$ rm -f hello.c
48aeecdc
SE
190$ git checkout hello.c <3>
191------------
192+
1e2ccd3a
JH
193<1> switch branch
194<2> take out a file out of other commit
48aeecdc 195<3> restore hello.c from HEAD of current branch
1be0659e 196+
48aeecdc
SE
197If you have an unfortunate branch that is named `hello.c`, this
198step would be confused as an instruction to switch to that branch.
199You should instead write:
1be0659e 200+
4aaa7027
JH
201------------
202$ git checkout -- hello.c
203------------
204
1be0659e 205. After working in a wrong branch, switching to the correct
71bb1033 206branch would be done using:
1be0659e
JH
207+
208------------
209$ git checkout mytopic
210------------
211+
212However, your "wrong" branch and correct "mytopic" branch may
213differ in files that you have locally modified, in which case,
214the above checkout would fail like this:
215+
216------------
217$ git checkout mytopic
218fatal: Entry 'frotz' not uptodate. Cannot merge.
219------------
220+
221You can give the `-m` flag to the command, which would try a
222three-way merge:
223+
224------------
225$ git checkout -m mytopic
226Auto-merging frotz
227------------
228+
229After this three-way merge, the local modifications are _not_
230registered in your index file, so `git diff` would show you what
231changes you made since the tip of the new branch.
232
233. When a merge conflict happens during switching branches with
234the `-m` option, you would see something like this:
235+
236------------
237$ git checkout -m mytopic
238Auto-merging frotz
1be0659e
JH
239ERROR: Merge conflict in frotz
240fatal: merge program failed
241------------
242+
243At this point, `git diff` shows the changes cleanly merged as in
244the previous example, as well as the changes in the conflicted
245files. Edit and resolve the conflict and mark it resolved with
d7f078b8 246`git add` as usual:
1be0659e
JH
247+
248------------
249$ edit frotz
d7f078b8 250$ git add frotz
1be0659e
JH
251------------
252
4aaa7027 253
7fc9d69f
JH
254Author
255------
256Written by Linus Torvalds <torvalds@osdl.org>
257
258Documentation
259--------------
260Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
261
262GIT
263---
9e1f0a85 264Part of the linkgit:git[1] suite