Merge branch 'nd/clone-case-smashing-warning'
[git.git] / Documentation / git-checkout.txt
blob801de2f7645bf0b1fc506da58d469519abca8863
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' [<tree-ish>] [--] <pathspec>...
17 'git checkout' (-p|--patch) [<tree-ish>] [--] [<paths>...]
19 DESCRIPTION
20 -----------
21 Updates files in the working tree to match the version in the index
22 or the specified tree.  If no paths are given, 'git checkout' will
23 also update `HEAD` to set the specified branch as the current
24 branch.
26 'git checkout' <branch>::
27         To prepare for working on <branch>, switch to it by updating
28         the index and the files in the working tree, and by pointing
29         HEAD at the branch. Local modifications to the files in the
30         working tree are kept, so that they can be committed to the
31         <branch>.
33 If <branch> is not found but there does exist a tracking branch in
34 exactly one remote (call it <remote>) with a matching name, treat as
35 equivalent to
37 ------------
38 $ git checkout -b <branch> --track <remote>/<branch>
39 ------------
41 If the branch exists in multiple remotes and one of them is named by
42 the `checkout.defaultRemote` configuration variable, we'll use that
43 one for the purposes of disambiguation, even if the `<branch>` isn't
44 unique across all remotes. Set it to
45 e.g. `checkout.defaultRemote=origin` to always checkout remote
46 branches from there if `<branch>` is ambiguous but exists on the
47 'origin' remote. See also `checkout.defaultRemote` in
48 linkgit:git-config[1].
50 You could omit <branch>, in which case the command degenerates to
51 "check out the current branch", which is a glorified no-op with
52 rather expensive side-effects to show only the tracking information,
53 if exists, for the current branch.
55 'git checkout' -b|-B <new_branch> [<start point>]::
57         Specifying `-b` causes a new branch to be created as if
58         linkgit:git-branch[1] were called and then checked out.  In
59         this case you can use the `--track` or `--no-track` options,
60         which will be passed to 'git branch'.  As a convenience,
61         `--track` without `-b` implies branch creation; see the
62         description of `--track` below.
64 If `-B` is given, <new_branch> is created if it doesn't exist; otherwise, it
65 is reset. This is the transactional equivalent of
67 ------------
68 $ git branch -f <branch> [<start point>]
69 $ git checkout <branch>
70 ------------
72 that is to say, the branch is not reset/created unless "git checkout" is
73 successful.
75 'git checkout' --detach [<branch>]::
76 'git checkout' [--detach] <commit>::
78         Prepare to work on top of <commit>, by detaching HEAD at it
79         (see "DETACHED HEAD" section), and updating the index and the
80         files in the working tree.  Local modifications to the files
81         in the working tree are kept, so that the resulting working
82         tree will be the state recorded in the commit plus the local
83         modifications.
85 When the <commit> argument is a branch name, the `--detach` option can
86 be used to detach HEAD at the tip of the branch (`git checkout
87 <branch>` would check out that branch without detaching HEAD).
89 Omitting <branch> detaches HEAD at the tip of the current branch.
91 'git checkout' [<tree-ish>] [--] <pathspec>...::
93         Overwrite paths in the working tree by replacing with the
94         contents in the index or in the <tree-ish> (most often a
95         commit).  When a <tree-ish> is given, the paths that
96         match the <pathspec> are updated both in the index and in
97         the working tree.
99 The index may contain unmerged entries because of a previous failed merge.
100 By default, if you try to check out such an entry from the index, the
101 checkout operation will fail and nothing will be checked out.
102 Using `-f` will ignore these unmerged entries.  The contents from a
103 specific side of the merge can be checked out of the index by
104 using `--ours` or `--theirs`.  With `-m`, changes made to the working tree
105 file can be discarded to re-create the original conflicted merge result.
107 'git checkout' (-p|--patch) [<tree-ish>] [--] [<pathspec>...]::
108         This is similar to the "check out paths to the working tree
109         from either the index or from a tree-ish" mode described
110         above, but lets you use the interactive interface to show
111         the "diff" output and choose which hunks to use in the
112         result.  See below for the description of `--patch` option.
115 OPTIONS
116 -------
117 -q::
118 --quiet::
119         Quiet, suppress feedback messages.
121 --[no-]progress::
122         Progress status is reported on the standard error stream
123         by default when it is attached to a terminal, unless `--quiet`
124         is specified. This flag enables progress reporting even if not
125         attached to a terminal, regardless of `--quiet`.
127 -f::
128 --force::
129         When switching branches, proceed even if the index or the
130         working tree differs from HEAD.  This is used to throw away
131         local changes.
133 When checking out paths from the index, do not fail upon unmerged
134 entries; instead, unmerged entries are ignored.
136 --ours::
137 --theirs::
138         When checking out paths from the index, check out stage #2
139         ('ours') or #3 ('theirs') for unmerged paths.
141 Note that during `git rebase` and `git pull --rebase`, 'ours' and
142 'theirs' may appear swapped; `--ours` gives the version from the
143 branch the changes are rebased onto, while `--theirs` gives the
144 version from the branch that holds your work that is being rebased.
146 This is because `rebase` is used in a workflow that treats the
147 history at the remote as the shared canonical one, and treats the
148 work done on the branch you are rebasing as the third-party work to
149 be integrated, and you are temporarily assuming the role of the
150 keeper of the canonical history during the rebase.  As the keeper of
151 the canonical history, you need to view the history from the remote
152 as `ours` (i.e. "our shared canonical history"), while what you did
153 on your side branch as `theirs` (i.e. "one contributor's work on top
154 of it").
156 -b <new_branch>::
157         Create a new branch named <new_branch> and start it at
158         <start_point>; see linkgit:git-branch[1] for details.
160 -B <new_branch>::
161         Creates the branch <new_branch> and start it at <start_point>;
162         if it already exists, then reset it to <start_point>. This is
163         equivalent to running "git branch" with "-f"; see
164         linkgit:git-branch[1] for details.
166 -t::
167 --track::
168         When creating a new branch, set up "upstream" configuration. See
169         "--track" in linkgit:git-branch[1] for details.
171 If no `-b` option is given, the name of the new branch will be
172 derived from the remote-tracking branch, by looking at the local part of
173 the refspec configured for the corresponding remote, and then stripping
174 the initial part up to the "*".
175 This would tell us to use "hack" as the local branch when branching
176 off of "origin/hack" (or "remotes/origin/hack", or even
177 "refs/remotes/origin/hack").  If the given name has no slash, or the above
178 guessing results in an empty name, the guessing is aborted.  You can
179 explicitly give a name with `-b` in such a case.
181 --no-track::
182         Do not set up "upstream" configuration, even if the
183         branch.autoSetupMerge configuration variable is true.
185 -l::
186         Create the new branch's reflog; see linkgit:git-branch[1] for
187         details.
189 --detach::
190         Rather than checking out a branch to work on it, check out a
191         commit for inspection and discardable experiments.
192         This is the default behavior of "git checkout <commit>" when
193         <commit> is not a branch name.  See the "DETACHED HEAD" section
194         below for details.
196 --orphan <new_branch>::
197         Create a new 'orphan' branch, named <new_branch>, started from
198         <start_point> and switch to it.  The first commit made on this
199         new branch will have no parents and it will be the root of a new
200         history totally disconnected from all the other branches and
201         commits.
203 The index and the working tree are adjusted as if you had previously run
204 "git checkout <start_point>".  This allows you to start a new history
205 that records a set of paths similar to <start_point> by easily running
206 "git commit -a" to make the root commit.
208 This can be useful when you want to publish the tree from a commit
209 without exposing its full history. You might want to do this to publish
210 an open source branch of a project whose current tree is "clean", but
211 whose full history contains proprietary or otherwise encumbered bits of
212 code.
214 If you want to start a disconnected history that records a set of paths
215 that is totally different from the one of <start_point>, then you should
216 clear the index and the working tree right after creating the orphan
217 branch by running "git rm -rf ." from the top level of the working tree.
218 Afterwards you will be ready to prepare your new files, repopulating the
219 working tree, by copying them from elsewhere, extracting a tarball, etc.
221 --ignore-skip-worktree-bits::
222         In sparse checkout mode, `git checkout -- <paths>` would
223         update only entries matched by <paths> and sparse patterns
224         in $GIT_DIR/info/sparse-checkout. This option ignores
225         the sparse patterns and adds back any files in <paths>.
227 -m::
228 --merge::
229         When switching branches,
230         if you have local modifications to one or more files that
231         are different between the current branch and the branch to
232         which you are switching, the command refuses to switch
233         branches in order to preserve your modifications in context.
234         However, with this option, a three-way merge between the current
235         branch, your working tree contents, and the new branch
236         is done, and you will be on the new branch.
238 When a merge conflict happens, the index entries for conflicting
239 paths are left unmerged, and you need to resolve the conflicts
240 and mark the resolved paths with `git add` (or `git rm` if the merge
241 should result in deletion of the path).
243 When checking out paths from the index, this option lets you recreate
244 the conflicted merge in the specified paths.
246 --conflict=<style>::
247         The same as --merge option above, but changes the way the
248         conflicting hunks are presented, overriding the
249         merge.conflictStyle configuration variable.  Possible values are
250         "merge" (default) and "diff3" (in addition to what is shown by
251         "merge" style, shows the original contents).
253 -p::
254 --patch::
255         Interactively select hunks in the difference between the
256         <tree-ish> (or the index, if unspecified) and the working
257         tree.  The chosen hunks are then applied in reverse to the
258         working tree (and if a <tree-ish> was specified, the index).
260 This means that you can use `git checkout -p` to selectively discard
261 edits from your current working tree. See the ``Interactive Mode''
262 section of linkgit:git-add[1] to learn how to operate the `--patch` mode.
264 --ignore-other-worktrees::
265         `git checkout` refuses when the wanted ref is already checked
266         out by another worktree. This option makes it check the ref
267         out anyway. In other words, the ref can be held by more than one
268         worktree.
270 --[no-]recurse-submodules::
271         Using --recurse-submodules will update the content of all initialized
272         submodules according to the commit recorded in the superproject. If
273         local modifications in a submodule would be overwritten the checkout
274         will fail unless `-f` is used. If nothing (or --no-recurse-submodules)
275         is used, the work trees of submodules will not be updated.
276         Just like linkgit:git-submodule[1], this will detach the
277         submodules HEAD.
279 <branch>::
280         Branch to checkout; if it refers to a branch (i.e., a name that,
281         when prepended with "refs/heads/", is a valid ref), then that
282         branch is checked out. Otherwise, if it refers to a valid
283         commit, your HEAD becomes "detached" and you are no longer on
284         any branch (see below for details).
286 You can use the `"@{-N}"` syntax to refer to the N-th last
287 branch/commit checked out using "git checkout" operation. You may
288 also specify `-` which is synonymous to `"@{-1}`.
290 As a special case, you may use `"A...B"` as a shortcut for the
291 merge base of `A` and `B` if there is exactly one merge base. You can
292 leave out at most one of `A` and `B`, in which case it defaults to `HEAD`.
294 <new_branch>::
295         Name for the new branch.
297 <start_point>::
298         The name of a commit at which to start the new branch; see
299         linkgit:git-branch[1] for details. Defaults to HEAD.
301 <tree-ish>::
302         Tree to checkout from (when paths are given). If not specified,
303         the index will be used.
307 DETACHED HEAD
308 -------------
309 HEAD normally refers to a named branch (e.g. 'master'). Meanwhile, each
310 branch refers to a specific commit. Let's look at a repo with three
311 commits, one of them tagged, and with branch 'master' checked out:
313 ------------
314            HEAD (refers to branch 'master')
315             |
316             v
317 a---b---c  branch 'master' (refers to commit 'c')
318     ^
319     |
320   tag 'v2.0' (refers to commit 'b')
321 ------------
323 When a commit is created in this state, the branch is updated to refer to
324 the new commit. Specifically, 'git commit' creates a new commit 'd', whose
325 parent is commit 'c', and then updates branch 'master' to refer to new
326 commit 'd'. HEAD still refers to branch 'master' and so indirectly now refers
327 to commit 'd':
329 ------------
330 $ edit; git add; git commit
332                HEAD (refers to branch 'master')
333                 |
334                 v
335 a---b---c---d  branch 'master' (refers to commit 'd')
336     ^
337     |
338   tag 'v2.0' (refers to commit 'b')
339 ------------
341 It is sometimes useful to be able to checkout a commit that is not at
342 the tip of any named branch, or even to create a new commit that is not
343 referenced by a named branch. Let's look at what happens when we
344 checkout commit 'b' (here we show two ways this may be done):
346 ------------
347 $ git checkout v2.0  # or
348 $ git checkout master^^
350    HEAD (refers to commit 'b')
351     |
352     v
353 a---b---c---d  branch 'master' (refers to commit 'd')
354     ^
355     |
356   tag 'v2.0' (refers to commit 'b')
357 ------------
359 Notice that regardless of which checkout command we use, HEAD now refers
360 directly to commit 'b'. This is known as being in detached HEAD state.
361 It means simply that HEAD refers to a specific commit, as opposed to
362 referring to a named branch. Let's see what happens when we create a commit:
364 ------------
365 $ edit; git add; git commit
367      HEAD (refers to commit 'e')
368       |
369       v
370       e
371      /
372 a---b---c---d  branch 'master' (refers to commit 'd')
373     ^
374     |
375   tag 'v2.0' (refers to commit 'b')
376 ------------
378 There is now a new commit 'e', but it is referenced only by HEAD. We can
379 of course add yet another commit in this state:
381 ------------
382 $ edit; git add; git commit
384          HEAD (refers to commit 'f')
385           |
386           v
387       e---f
388      /
389 a---b---c---d  branch 'master' (refers to commit 'd')
390     ^
391     |
392   tag 'v2.0' (refers to commit 'b')
393 ------------
395 In fact, we can perform all the normal Git operations. But, let's look
396 at what happens when we then checkout master:
398 ------------
399 $ git checkout master
401                HEAD (refers to branch 'master')
402       e---f     |
403      /          v
404 a---b---c---d  branch 'master' (refers to commit 'd')
405     ^
406     |
407   tag 'v2.0' (refers to commit 'b')
408 ------------
410 It is important to realize that at this point nothing refers to commit
411 'f'. Eventually commit 'f' (and by extension commit 'e') will be deleted
412 by the routine Git garbage collection process, unless we create a reference
413 before that happens. If we have not yet moved away from commit 'f',
414 any of these will create a reference to it:
416 ------------
417 $ git checkout -b foo   <1>
418 $ git branch foo        <2>
419 $ git tag foo           <3>
420 ------------
422 <1> creates a new branch 'foo', which refers to commit 'f', and then
423 updates HEAD to refer to branch 'foo'. In other words, we'll no longer
424 be in detached HEAD state after this command.
426 <2> similarly creates a new branch 'foo', which refers to commit 'f',
427 but leaves HEAD detached.
429 <3> creates a new tag 'foo', which refers to commit 'f',
430 leaving HEAD detached.
432 If we have moved away from commit 'f', then we must first recover its object
433 name (typically by using git reflog), and then we can create a reference to
434 it. For example, to see the last two commits to which HEAD referred, we
435 can use either of these commands:
437 ------------
438 $ git reflog -2 HEAD # or
439 $ git log -g -2 HEAD
440 ------------
442 ARGUMENT DISAMBIGUATION
443 -----------------------
445 When there is only one argument given and it is not `--` (e.g. "git
446 checkout abc"), and when the argument is both a valid `<tree-ish>`
447 (e.g. a branch "abc" exists) and a valid `<pathspec>` (e.g. a file
448 or a directory whose name is "abc" exists), Git would usually ask
449 you to disambiguate.  Because checking out a branch is so common an
450 operation, however, "git checkout abc" takes "abc" as a `<tree-ish>`
451 in such a situation.  Use `git checkout -- <pathspec>` if you want
452 to checkout these paths out of the index.
454 EXAMPLES
455 --------
457 . The following sequence checks out the `master` branch, reverts
458 the `Makefile` to two revisions back, deletes hello.c by
459 mistake, and gets it back from the index.
461 ------------
462 $ git checkout master             <1>
463 $ git checkout master~2 Makefile  <2>
464 $ rm -f hello.c
465 $ git checkout hello.c            <3>
466 ------------
468 <1> switch branch
469 <2> take a file out of another commit
470 <3> restore hello.c from the index
472 If you want to check out _all_ C source files out of the index,
473 you can say
475 ------------
476 $ git checkout -- '*.c'
477 ------------
479 Note the quotes around `*.c`.  The file `hello.c` will also be
480 checked out, even though it is no longer in the working tree,
481 because the file globbing is used to match entries in the index
482 (not in the working tree by the shell).
484 If you have an unfortunate branch that is named `hello.c`, this
485 step would be confused as an instruction to switch to that branch.
486 You should instead write:
488 ------------
489 $ git checkout -- hello.c
490 ------------
492 . After working in the wrong branch, switching to the correct
493 branch would be done using:
495 ------------
496 $ git checkout mytopic
497 ------------
499 However, your "wrong" branch and correct "mytopic" branch may
500 differ in files that you have modified locally, in which case
501 the above checkout would fail like this:
503 ------------
504 $ git checkout mytopic
505 error: You have local changes to 'frotz'; not switching branches.
506 ------------
508 You can give the `-m` flag to the command, which would try a
509 three-way merge:
511 ------------
512 $ git checkout -m mytopic
513 Auto-merging frotz
514 ------------
516 After this three-way merge, the local modifications are _not_
517 registered in your index file, so `git diff` would show you what
518 changes you made since the tip of the new branch.
520 . When a merge conflict happens during switching branches with
521 the `-m` option, you would see something like this:
523 ------------
524 $ git checkout -m mytopic
525 Auto-merging frotz
526 ERROR: Merge conflict in frotz
527 fatal: merge program failed
528 ------------
530 At this point, `git diff` shows the changes cleanly merged as in
531 the previous example, as well as the changes in the conflicted
532 files.  Edit and resolve the conflict and mark it resolved with
533 `git add` as usual:
535 ------------
536 $ edit frotz
537 $ git add frotz
538 ------------
542 Part of the linkgit:git[1] suite