Merge branch 'cb/uname-in-untracked'
[git.git] / Documentation / git-checkout.txt
blobe269fb110835305633ccafa6aa87cf1f425f7b8c
1 git-checkout(1)
2 ===============
4 NAME
5 ----
6 git-checkout - Switch branches or restore working tree files
8 SYNOPSIS
9 --------
10 [verse]
11 'git checkout' [-q] [-f] [-m] [<branch>]
12 'git checkout' [-q] [-f] [-m] --detach [<branch>]
13 'git checkout' [-q] [-f] [-m] [--detach] <commit>
14 'git checkout' [-q] [-f] [-m] [[-b|-B|--orphan] <new_branch>] [<start_point>]
15 'git checkout' [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] [--] <paths>...
16 'git checkout' [-p|--patch] [<tree-ish>] [--] [<paths>...]
18 DESCRIPTION
19 -----------
20 Updates files in the working tree to match the version in the index
21 or the specified tree.  If no paths are given, 'git checkout' will
22 also update `HEAD` to set the specified branch as the current
23 branch.
25 'git checkout' <branch>::
26         To prepare for working on <branch>, switch to it by updating
27         the index and the files in the working tree, and by pointing
28         HEAD at the branch. Local modifications to the files in the
29         working tree are kept, so that they can be committed to the
30         <branch>.
32 If <branch> is not found but there does exist a tracking branch in
33 exactly one remote (call it <remote>) with a matching name, treat as
34 equivalent to
36 ------------
37 $ git checkout -b <branch> --track <remote>/<branch>
38 ------------
40 You could omit <branch>, in which case the command degenerates to
41 "check out the current branch", which is a glorified no-op with a
42 rather expensive side-effects to show only the tracking information,
43 if exists, for the current branch.
45 'git checkout' -b|-B <new_branch> [<start point>]::
47         Specifying `-b` causes a new branch to be created as if
48         linkgit:git-branch[1] were called and then checked out.  In
49         this case you can use the `--track` or `--no-track` options,
50         which will be passed to 'git branch'.  As a convenience,
51         `--track` without `-b` implies branch creation; see the
52         description of `--track` below.
54 If `-B` is given, <new_branch> is created if it doesn't exist; otherwise, it
55 is reset. This is the transactional equivalent of
57 ------------
58 $ git branch -f <branch> [<start point>]
59 $ git checkout <branch>
60 ------------
62 that is to say, the branch is not reset/created unless "git checkout" is
63 successful.
65 'git checkout' --detach [<branch>]::
66 'git checkout' [--detach] <commit>::
68         Prepare to work on top of <commit>, by detaching HEAD at it
69         (see "DETACHED HEAD" section), and updating the index and the
70         files in the working tree.  Local modifications to the files
71         in the working tree are kept, so that the resulting working
72         tree will be the state recorded in the commit plus the local
73         modifications.
75 When the <commit> argument is a branch name, the `--detach` option can
76 be used to detach HEAD at the tip of the branch (`git checkout
77 <branch>` would check out that branch without detaching HEAD).
79 Omitting <branch> detaches HEAD at the tip of the current branch.
81 'git checkout' [-p|--patch] [<tree-ish>] [--] <pathspec>...::
83         When <paths> or `--patch` are given, 'git checkout' does *not*
84         switch branches.  It updates the named paths in the working tree
85         from the index file or from a named <tree-ish> (most often a
86         commit).  In this case, the `-b` and `--track` options are
87         meaningless and giving either of them results in an error.  The
88         <tree-ish> argument can be used to specify a specific tree-ish
89         (i.e.  commit, tag or tree) to update the index for the given
90         paths before updating the working tree.
92 'git checkout' with <paths> or `--patch` is used to restore modified or
93 deleted paths to their original contents from the index or replace paths
94 with the contents from a named <tree-ish> (most often a commit-ish).
96 The index may contain unmerged entries because of a previous failed merge.
97 By default, if you try to check out such an entry from the index, the
98 checkout operation will fail and nothing will be checked out.
99 Using `-f` will ignore these unmerged entries.  The contents from a
100 specific side of the merge can be checked out of the index by
101 using `--ours` or `--theirs`.  With `-m`, changes made to the working tree
102 file can be discarded to re-create the original conflicted merge result.
104 OPTIONS
105 -------
106 -q::
107 --quiet::
108         Quiet, suppress feedback messages.
110 -f::
111 --force::
112         When switching branches, proceed even if the index or the
113         working tree differs from HEAD.  This is used to throw away
114         local changes.
116 When checking out paths from the index, do not fail upon unmerged
117 entries; instead, unmerged entries are ignored.
119 --ours::
120 --theirs::
121         When checking out paths from the index, check out stage #2
122         ('ours') or #3 ('theirs') for unmerged paths.
124 Note that during `git rebase` and `git pull --rebase`, 'ours' and
125 'theirs' may appear swapped; `--ours` gives the version from the
126 branch the changes are rebased onto, while `--theirs` gives the
127 version from the branch that holds your work that is being rebased.
129 This is because `rebase` is used in a workflow that treats the
130 history at the remote as the shared canonical one, and treats the
131 work done on the branch you are rebasing as the third-party work to
132 be integrated, and you are temporarily assuming the role of the
133 keeper of the canonical history during the rebase.  As the keeper of
134 the canonical history, you need to view the history from the remote
135 as `ours` (i.e. "our shared canonical history"), while what you did
136 on your side branch as `theirs` (i.e. "one contributor's work on top
137 of it").
139 -b <new_branch>::
140         Create a new branch named <new_branch> and start it at
141         <start_point>; see linkgit:git-branch[1] for details.
143 -B <new_branch>::
144         Creates the branch <new_branch> and start it at <start_point>;
145         if it already exists, then reset it to <start_point>. This is
146         equivalent to running "git branch" with "-f"; see
147         linkgit:git-branch[1] for details.
149 -t::
150 --track::
151         When creating a new branch, set up "upstream" configuration. See
152         "--track" in linkgit:git-branch[1] for details.
154 If no '-b' option is given, the name of the new branch will be
155 derived from the remote-tracking branch, by looking at the local part of
156 the refspec configured for the corresponding remote, and then stripping
157 the initial part up to the "*".
158 This would tell us to use "hack" as the local branch when branching
159 off of "origin/hack" (or "remotes/origin/hack", or even
160 "refs/remotes/origin/hack").  If the given name has no slash, or the above
161 guessing results in an empty name, the guessing is aborted.  You can
162 explicitly give a name with '-b' in such a case.
164 --no-track::
165         Do not set up "upstream" configuration, even if the
166         branch.autoSetupMerge configuration variable is true.
168 -l::
169         Create the new branch's reflog; see linkgit:git-branch[1] for
170         details.
172 --detach::
173         Rather than checking out a branch to work on it, check out a
174         commit for inspection and discardable experiments.
175         This is the default behavior of "git checkout <commit>" when
176         <commit> is not a branch name.  See the "DETACHED HEAD" section
177         below for details.
179 --orphan <new_branch>::
180         Create a new 'orphan' branch, named <new_branch>, started from
181         <start_point> and switch to it.  The first commit made on this
182         new branch will have no parents and it will be the root of a new
183         history totally disconnected from all the other branches and
184         commits.
186 The index and the working tree are adjusted as if you had previously run
187 "git checkout <start_point>".  This allows you to start a new history
188 that records a set of paths similar to <start_point> by easily running
189 "git commit -a" to make the root commit.
191 This can be useful when you want to publish the tree from a commit
192 without exposing its full history. You might want to do this to publish
193 an open source branch of a project whose current tree is "clean", but
194 whose full history contains proprietary or otherwise encumbered bits of
195 code.
197 If you want to start a disconnected history that records a set of paths
198 that is totally different from the one of <start_point>, then you should
199 clear the index and the working tree right after creating the orphan
200 branch by running "git rm -rf ." from the top level of the working tree.
201 Afterwards you will be ready to prepare your new files, repopulating the
202 working tree, by copying them from elsewhere, extracting a tarball, etc.
204 --ignore-skip-worktree-bits::
205         In sparse checkout mode, `git checkout -- <paths>` would
206         update only entries matched by <paths> and sparse patterns
207         in $GIT_DIR/info/sparse-checkout. This option ignores
208         the sparse patterns and adds back any files in <paths>.
210 -m::
211 --merge::
212         When switching branches,
213         if you have local modifications to one or more files that
214         are different between the current branch and the branch to
215         which you are switching, the command refuses to switch
216         branches in order to preserve your modifications in context.
217         However, with this option, a three-way merge between the current
218         branch, your working tree contents, and the new branch
219         is done, and you will be on the new branch.
221 When a merge conflict happens, the index entries for conflicting
222 paths are left unmerged, and you need to resolve the conflicts
223 and mark the resolved paths with `git add` (or `git rm` if the merge
224 should result in deletion of the path).
226 When checking out paths from the index, this option lets you recreate
227 the conflicted merge in the specified paths.
229 --conflict=<style>::
230         The same as --merge option above, but changes the way the
231         conflicting hunks are presented, overriding the
232         merge.conflictStyle configuration variable.  Possible values are
233         "merge" (default) and "diff3" (in addition to what is shown by
234         "merge" style, shows the original contents).
236 -p::
237 --patch::
238         Interactively select hunks in the difference between the
239         <tree-ish> (or the index, if unspecified) and the working
240         tree.  The chosen hunks are then applied in reverse to the
241         working tree (and if a <tree-ish> was specified, the index).
243 This means that you can use `git checkout -p` to selectively discard
244 edits from your current working tree. See the ``Interactive Mode''
245 section of linkgit:git-add[1] to learn how to operate the `--patch` mode.
247 --ignore-other-worktrees::
248         `git checkout` refuses when the wanted ref is already checked
249         out by another worktree. This option makes it check the ref
250         out anyway. In other words, the ref can be held by more than one
251         worktree.
253 <branch>::
254         Branch to checkout; if it refers to a branch (i.e., a name that,
255         when prepended with "refs/heads/", is a valid ref), then that
256         branch is checked out. Otherwise, if it refers to a valid
257         commit, your HEAD becomes "detached" and you are no longer on
258         any branch (see below for details).
260 As a special case, the `"@{-N}"` syntax for the N-th last branch/commit
261 checks out branches (instead of detaching).  You may also specify
262 `-` which is synonymous with `"@{-1}"`.
264 As a further special case, you may use `"A...B"` as a shortcut for the
265 merge base of `A` and `B` if there is exactly one merge base. You can
266 leave out at most one of `A` and `B`, in which case it defaults to `HEAD`.
268 <new_branch>::
269         Name for the new branch.
271 <start_point>::
272         The name of a commit at which to start the new branch; see
273         linkgit:git-branch[1] for details. Defaults to HEAD.
275 <tree-ish>::
276         Tree to checkout from (when paths are given). If not specified,
277         the index will be used.
281 DETACHED HEAD
282 -------------
283 HEAD normally refers to a named branch (e.g. 'master'). Meanwhile, each
284 branch refers to a specific commit. Let's look at a repo with three
285 commits, one of them tagged, and with branch 'master' checked out:
287 ------------
288            HEAD (refers to branch 'master')
289             |
290             v
291 a---b---c  branch 'master' (refers to commit 'c')
292     ^
293     |
294   tag 'v2.0' (refers to commit 'b')
295 ------------
297 When a commit is created in this state, the branch is updated to refer to
298 the new commit. Specifically, 'git commit' creates a new commit 'd', whose
299 parent is commit 'c', and then updates branch 'master' to refer to new
300 commit 'd'. HEAD still refers to branch 'master' and so indirectly now refers
301 to commit 'd':
303 ------------
304 $ edit; git add; git commit
306                HEAD (refers to branch 'master')
307                 |
308                 v
309 a---b---c---d  branch 'master' (refers to commit 'd')
310     ^
311     |
312   tag 'v2.0' (refers to commit 'b')
313 ------------
315 It is sometimes useful to be able to checkout a commit that is not at
316 the tip of any named branch, or even to create a new commit that is not
317 referenced by a named branch. Let's look at what happens when we
318 checkout commit 'b' (here we show two ways this may be done):
320 ------------
321 $ git checkout v2.0  # or
322 $ git checkout master^^
324    HEAD (refers to commit 'b')
325     |
326     v
327 a---b---c---d  branch 'master' (refers to commit 'd')
328     ^
329     |
330   tag 'v2.0' (refers to commit 'b')
331 ------------
333 Notice that regardless of which checkout command we use, HEAD now refers
334 directly to commit 'b'. This is known as being in detached HEAD state.
335 It means simply that HEAD refers to a specific commit, as opposed to
336 referring to a named branch. Let's see what happens when we create a commit:
338 ------------
339 $ edit; git add; git commit
341      HEAD (refers to commit 'e')
342       |
343       v
344       e
345      /
346 a---b---c---d  branch 'master' (refers to commit 'd')
347     ^
348     |
349   tag 'v2.0' (refers to commit 'b')
350 ------------
352 There is now a new commit 'e', but it is referenced only by HEAD. We can
353 of course add yet another commit in this state:
355 ------------
356 $ edit; git add; git commit
358          HEAD (refers to commit 'f')
359           |
360           v
361       e---f
362      /
363 a---b---c---d  branch 'master' (refers to commit 'd')
364     ^
365     |
366   tag 'v2.0' (refers to commit 'b')
367 ------------
369 In fact, we can perform all the normal Git operations. But, let's look
370 at what happens when we then checkout master:
372 ------------
373 $ git checkout master
375                HEAD (refers to branch 'master')
376       e---f     |
377      /          v
378 a---b---c---d  branch 'master' (refers to commit 'd')
379     ^
380     |
381   tag 'v2.0' (refers to commit 'b')
382 ------------
384 It is important to realize that at this point nothing refers to commit
385 'f'. Eventually commit 'f' (and by extension commit 'e') will be deleted
386 by the routine Git garbage collection process, unless we create a reference
387 before that happens. If we have not yet moved away from commit 'f',
388 any of these will create a reference to it:
390 ------------
391 $ git checkout -b foo   <1>
392 $ git branch foo        <2>
393 $ git tag foo           <3>
394 ------------
396 <1> creates a new branch 'foo', which refers to commit 'f', and then
397 updates HEAD to refer to branch 'foo'. In other words, we'll no longer
398 be in detached HEAD state after this command.
400 <2> similarly creates a new branch 'foo', which refers to commit 'f',
401 but leaves HEAD detached.
403 <3> creates a new tag 'foo', which refers to commit 'f',
404 leaving HEAD detached.
406 If we have moved away from commit 'f', then we must first recover its object
407 name (typically by using git reflog), and then we can create a reference to
408 it. For example, to see the last two commits to which HEAD referred, we
409 can use either of these commands:
411 ------------
412 $ git reflog -2 HEAD # or
413 $ git log -g -2 HEAD
414 ------------
416 EXAMPLES
417 --------
419 . The following sequence checks out the `master` branch, reverts
420 the `Makefile` to two revisions back, deletes hello.c by
421 mistake, and gets it back from the index.
423 ------------
424 $ git checkout master             <1>
425 $ git checkout master~2 Makefile  <2>
426 $ rm -f hello.c
427 $ git checkout hello.c            <3>
428 ------------
430 <1> switch branch
431 <2> take a file out of another commit
432 <3> restore hello.c from the index
434 If you want to check out _all_ C source files out of the index,
435 you can say
437 ------------
438 $ git checkout -- '*.c'
439 ------------
441 Note the quotes around `*.c`.  The file `hello.c` will also be
442 checked out, even though it is no longer in the working tree,
443 because the file globbing is used to match entries in the index
444 (not in the working tree by the shell).
446 If you have an unfortunate branch that is named `hello.c`, this
447 step would be confused as an instruction to switch to that branch.
448 You should instead write:
450 ------------
451 $ git checkout -- hello.c
452 ------------
454 . After working in the wrong branch, switching to the correct
455 branch would be done using:
457 ------------
458 $ git checkout mytopic
459 ------------
461 However, your "wrong" branch and correct "mytopic" branch may
462 differ in files that you have modified locally, in which case
463 the above checkout would fail like this:
465 ------------
466 $ git checkout mytopic
467 error: You have local changes to 'frotz'; not switching branches.
468 ------------
470 You can give the `-m` flag to the command, which would try a
471 three-way merge:
473 ------------
474 $ git checkout -m mytopic
475 Auto-merging frotz
476 ------------
478 After this three-way merge, the local modifications are _not_
479 registered in your index file, so `git diff` would show you what
480 changes you made since the tip of the new branch.
482 . When a merge conflict happens during switching branches with
483 the `-m` option, you would see something like this:
485 ------------
486 $ git checkout -m mytopic
487 Auto-merging frotz
488 ERROR: Merge conflict in frotz
489 fatal: merge program failed
490 ------------
492 At this point, `git diff` shows the changes cleanly merged as in
493 the previous example, as well as the changes in the conflicted
494 files.  Edit and resolve the conflict and mark it resolved with
495 `git add` as usual:
497 ------------
498 $ edit frotz
499 $ git add frotz
500 ------------
504 Part of the linkgit:git[1] suite