git-checkout.txt 17.1 KB
Newer Older
Junio C Hamano's avatar
Junio C Hamano committed
1 2
git-checkout(1)
===============
3 4 5

NAME
----
6
git-checkout - Switch branches or restore working tree files
7 8 9

SYNOPSIS
--------
10
[verse]
11
'git checkout' [-q] [-f] [-m] [<branch>]
12 13
'git checkout' [-q] [-f] [-m] --detach [<branch>]
'git checkout' [-q] [-f] [-m] [--detach] <commit>
Ray's avatar
Ray committed
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>...]
17 18 19

DESCRIPTION
-----------
20 21 22
Updates files in the working tree to match the version in the index
or the specified tree.  If no paths are given, 'git checkout' will
also update `HEAD` to set the specified branch as the current
23
branch.
24

25 26 27 28 29 30 31
'git checkout' <branch>::
	To prepare for working on <branch>, switch to it by updating
	the index and the files in the working tree, and by pointing
	HEAD at the branch. Local modifications to the files in the
	working tree are kept, so that they can be committed to the
	<branch>.
+
32 33 34 35 36 37 38 39
If <branch> is not found but there does exist a tracking branch in
exactly one remote (call it <remote>) with a matching name, treat as
equivalent to
+
------------
$ git checkout -b <branch> --track <remote>/<branch>
------------
+
40 41 42 43 44
You could omit <branch>, in which case the command degenerates to
"check out the current branch", which is a glorified no-op with a
rather expensive side-effects to show only the tracking information,
if exists, for the current branch.

Ray's avatar
Ray committed
45
'git checkout' -b|-B <new_branch> [<start point>]::
46

47 48 49 50 51 52
	Specifying `-b` causes a new branch to be created as if
	linkgit:git-branch[1] were called and then checked out.  In
	this case you can use the `--track` or `--no-track` options,
	which will be passed to 'git branch'.  As a convenience,
	`--track` without `-b` implies branch creation; see the
	description of `--track` below.
Ray's avatar
Ray committed
53 54 55 56 57 58 59 60 61 62 63
+
If `-B` is given, <new_branch> is created if it doesn't exist; otherwise, it
is reset. This is the transactional equivalent of
+
------------
$ git branch -f <branch> [<start point>]
$ git checkout <branch>
------------
+
that is to say, the branch is not reset/created unless "git checkout" is
successful.
64

65
'git checkout' --detach [<branch>]::
66
'git checkout' [--detach] <commit>::
67 68 69 70 71 72 73 74

	Prepare to work on top of <commit>, by detaching HEAD at it
	(see "DETACHED HEAD" section), and updating the index and the
	files in the working tree.  Local modifications to the files
	in the working tree are kept, so that the resulting working
	tree will be the state recorded in the commit plus the local
	modifications.
+
75 76 77 78 79
When the <commit> argument is a branch name, the `--detach` option can
be used to detach HEAD at the tip of the branch (`git checkout
<branch>` would check out that branch without detaching HEAD).
+
Omitting <branch> detaches HEAD at the tip of the current branch.
80

81
'git checkout' [-p|--patch] [<tree-ish>] [--] <pathspec>...::
82

83 84 85 86 87 88 89 90
	When <paths> or `--patch` are given, 'git checkout' does *not*
	switch 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 this case, the `-b` and `--track` options are
	meaningless and giving 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) to update the index for the given
	paths before updating the working tree.
91
+
92 93 94 95
'git checkout' with <paths> or `--patch` is used to restore modified or
deleted paths to their original contents from the index or replace paths
with the contents from a named <tree-ish> (most often a commit-ish).
+
96 97
The index may contain unmerged entries because of a previous failed merge.
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 102
using `--ours` or `--theirs`.  With `-m`, changes made to the working tree
file can be discarded to re-create the original conflicted merge result.
103 104 105

OPTIONS
-------
106
-q::
107
--quiet::
108
	Quiet, suppress feedback messages.
109

110 111 112 113 114 115
--[no-]progress::
	Progress status is reported on the standard error stream
	by default when it is attached to a terminal, unless `--quiet`
	is specified. This flag enables progress reporting even if not
	attached to a terminal, regardless of `--quiet`.

116
-f::
117
--force::
118 119 120 121 122 123
	When switching branches, proceed even if the index or the
	working tree differs from HEAD.  This is used to throw away
	local changes.
+
When checking out paths from the index, do not fail upon unmerged
entries; instead, unmerged entries are ignored.
124

125 126 127 128
--ours::
--theirs::
	When checking out paths from the index, check out stage #2
	('ours') or #3 ('theirs') for unmerged paths.
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
+
Note that during `git rebase` and `git pull --rebase`, 'ours' and
'theirs' may appear swapped; `--ours` gives the version from the
branch the changes are rebased onto, while `--theirs` gives the
version from the branch that holds your work that is being rebased.
+
This is because `rebase` is used in a workflow that treats the
history at the remote as the shared canonical one, and treats the
work done on the branch you are rebasing as the third-party work to
be integrated, and you are temporarily assuming the role of the
keeper of the canonical history during the rebase.  As the keeper of
the canonical history, you need to view the history from the remote
as `ours` (i.e. "our shared canonical history"), while what you did
on your side branch as `theirs` (i.e. "one contributor's work on top
of it").
144

145
-b <new_branch>::
146
	Create a new branch named <new_branch> and start it at
147
	<start_point>; see linkgit:git-branch[1] for details.
148

149
-B <new_branch>::
Ray's avatar
Ray committed
150 151 152 153 154
	Creates the branch <new_branch> and start it at <start_point>;
	if it already exists, then reset it to <start_point>. This is
	equivalent to running "git branch" with "-f"; see
	linkgit:git-branch[1] for details.

155 156
-t::
--track::
157 158
	When creating a new branch, set up "upstream" configuration. See
	"--track" in linkgit:git-branch[1] for details.
159
+
160
If no `-b` option is given, the name of the new branch will be
161 162 163
derived from the remote-tracking branch, by looking at the local part of
the refspec configured for the corresponding remote, and then stripping
the initial part up to the "*".
164 165 166 167
This would tell us to use "hack" as the local branch when branching
off of "origin/hack" (or "remotes/origin/hack", or even
"refs/remotes/origin/hack").  If the given name has no slash, or the above
guessing results in an empty name, the guessing is aborted.  You can
168
explicitly give a name with `-b` in such a case.
169 170

--no-track::
171
	Do not set up "upstream" configuration, even if the
172
	branch.autoSetupMerge configuration variable is true.
173

174
-l::
175 176
	Create the new branch's reflog; see linkgit:git-branch[1] for
	details.
177

178 179 180 181 182 183 184
--detach::
	Rather than checking out a branch to work on it, check out a
	commit for inspection and discardable experiments.
	This is the default behavior of "git checkout <commit>" when
	<commit> is not a branch name.  See the "DETACHED HEAD" section
	below for details.

185
--orphan <new_branch>::
186 187 188 189 190
	Create a new 'orphan' branch, named <new_branch>, started from
	<start_point> and switch to it.  The first commit made on this
	new branch will have no parents and it will be the root of a new
	history totally disconnected from all the other branches and
	commits.
191
+
192 193 194 195
The index and the working tree are adjusted as if you had previously run
"git checkout <start_point>".  This allows you to start a new history
that records a set of paths similar to <start_point> by easily running
"git commit -a" to make the root commit.
196
+
197 198 199 200 201 202 203 204 205 206 207 208
This can be useful when you want to publish the tree from a commit
without exposing its full history. You might want to do this to publish
an open source branch of a project whose current tree is "clean", but
whose full history contains proprietary or otherwise encumbered bits of
code.
+
If you want to start a disconnected history that records a set of paths
that is totally different from the one of <start_point>, then you should
clear the index and the working tree right after creating the orphan
branch by running "git rm -rf ." from the top level of the working tree.
Afterwards you will be ready to prepare your new files, repopulating the
working tree, by copying them from elsewhere, extracting a tarball, etc.
209

210 211 212 213 214 215
--ignore-skip-worktree-bits::
	In sparse checkout mode, `git checkout -- <paths>` would
	update only entries matched by <paths> and sparse patterns
	in $GIT_DIR/info/sparse-checkout. This option ignores
	the sparse patterns and adds back any files in <paths>.

216
-m::
217
--merge::
218 219
	When switching branches,
	if you have local modifications to one or more files that
220 221 222 223
	are different between the current branch and the branch to
	which you are switching, the command refuses to switch
	branches in order to preserve your modifications in context.
	However, with this option, a three-way merge between the current
224 225 226 227 228
	branch, your working tree contents, and the new branch
	is done, and you will be on the new branch.
+
When a merge conflict happens, the index entries for conflicting
paths are left unmerged, and you need to resolve the conflicts
229 230
and mark the resolved paths with `git add` (or `git rm` if the merge
should result in deletion of the path).
231 232 233
+
When checking out paths from the index, this option lets you recreate
the conflicted merge in the specified paths.
234

235 236 237
--conflict=<style>::
	The same as --merge option above, but changes the way the
	conflicting hunks are presented, overriding the
238
	merge.conflictStyle configuration variable.  Possible values are
239 240
	"merge" (default) and "diff3" (in addition to what is shown by
	"merge" style, shows the original contents).
241

242 243 244 245 246 247 248 249
-p::
--patch::
	Interactively select hunks in the difference between the
	<tree-ish> (or the index, if unspecified) and the working
	tree.  The chosen hunks are then applied in reverse to the
	working tree (and if a <tree-ish> was specified, the index).
+
This means that you can use `git checkout -p` to selectively discard
250
edits from your current working tree. See the ``Interactive Mode''
251
section of linkgit:git-add[1] to learn how to operate the `--patch` mode.
252

253 254 255 256 257 258
--ignore-other-worktrees::
	`git checkout` refuses when the wanted ref is already checked
	out by another worktree. This option makes it check the ref
	out anyway. In other words, the ref can be held by more than one
	worktree.

259
<branch>::
260 261 262 263 264
	Branch to checkout; if it refers to a branch (i.e., a name that,
	when prepended with "refs/heads/", is a valid ref), then that
	branch is checked out. Otherwise, if it refers to a valid
	commit, your HEAD becomes "detached" and you are no longer on
	any branch (see below for details).
265
+
266 267
As a special case, the `"@{-N}"` syntax for the N-th last branch/commit
checks out branches (instead of detaching).  You may also specify
268
`-` which is synonymous with `"@{-1}"`.
269
+
270
As a further special case, you may use `"A...B"` as a shortcut for the
271 272
merge base of `A` and `B` if there is exactly one merge base. You can
leave out at most one of `A` and `B`, in which case it defaults to `HEAD`.
273

274 275 276 277 278 279 280 281 282 283 284 285
<new_branch>::
	Name for the new branch.

<start_point>::
	The name of a commit at which to start the new branch; see
	linkgit:git-branch[1] for details. Defaults to HEAD.

<tree-ish>::
	Tree to checkout from (when paths are given). If not specified,
	the index will be used.


286

287
DETACHED HEAD
288
-------------
289 290 291
HEAD normally refers to a named branch (e.g. 'master'). Meanwhile, each
branch refers to a specific commit. Let's look at a repo with three
commits, one of them tagged, and with branch 'master' checked out:
292

293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
------------
	   HEAD (refers to branch 'master')
	    |
	    v
a---b---c  branch 'master' (refers to commit 'c')
    ^
    |
  tag 'v2.0' (refers to commit 'b')
------------

When a commit is created in this state, the branch is updated to refer to
the new commit. Specifically, 'git commit' creates a new commit 'd', whose
parent is commit 'c', and then updates branch 'master' to refer to new
commit 'd'. HEAD still refers to branch 'master' and so indirectly now refers
to commit 'd':
308 309

------------
310 311 312 313 314 315 316 317 318
$ edit; git add; git commit

	       HEAD (refers to branch 'master')
		|
		v
a---b---c---d  branch 'master' (refers to commit 'd')
    ^
    |
  tag 'v2.0' (refers to commit 'b')
319 320
------------

321 322 323 324
It is sometimes useful to be able to checkout a commit that is not at
the tip of any named branch, or even to create a new commit that is not
referenced by a named branch. Let's look at what happens when we
checkout commit 'b' (here we show two ways this may be done):
325 326

------------
327 328 329 330 331 332 333 334 335 336 337
$ git checkout v2.0  # or
$ git checkout master^^

   HEAD (refers to commit 'b')
    |
    v
a---b---c---d  branch 'master' (refers to commit 'd')
    ^
    |
  tag 'v2.0' (refers to commit 'b')
------------
338

339 340 341 342
Notice that regardless of which checkout command we use, HEAD now refers
directly to commit 'b'. This is known as being in detached HEAD state.
It means simply that HEAD refers to a specific commit, as opposed to
referring to a named branch. Let's see what happens when we create a commit:
343 344

------------
345 346 347 348 349 350 351 352 353 354 355
$ edit; git add; git commit

     HEAD (refers to commit 'e')
      |
      v
      e
     /
a---b---c---d  branch 'master' (refers to commit 'd')
    ^
    |
  tag 'v2.0' (refers to commit 'b')
356
------------
357

358 359
There is now a new commit 'e', but it is referenced only by HEAD. We can
of course add yet another commit in this state:
360

361 362 363 364 365 366 367 368 369 370 371 372 373 374
------------
$ edit; git add; git commit

	 HEAD (refers to commit 'f')
	  |
	  v
      e---f
     /
a---b---c---d  branch 'master' (refers to commit 'd')
    ^
    |
  tag 'v2.0' (refers to commit 'b')
------------

375
In fact, we can perform all the normal Git operations. But, let's look
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
at what happens when we then checkout master:

------------
$ git checkout master

	       HEAD (refers to branch 'master')
      e---f     |
     /          v
a---b---c---d  branch 'master' (refers to commit 'd')
    ^
    |
  tag 'v2.0' (refers to commit 'b')
------------

It is important to realize that at this point nothing refers to commit
'f'. Eventually commit 'f' (and by extension commit 'e') will be deleted
392
by the routine Git garbage collection process, unless we create a reference
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
before that happens. If we have not yet moved away from commit 'f',
any of these will create a reference to it:

------------
$ git checkout -b foo   <1>
$ git branch foo        <2>
$ git tag foo           <3>
------------

<1> creates a new branch 'foo', which refers to commit 'f', and then
updates HEAD to refer to branch 'foo'. In other words, we'll no longer
be in detached HEAD state after this command.

<2> similarly creates a new branch 'foo', which refers to commit 'f',
but leaves HEAD detached.

<3> creates a new tag 'foo', which refers to commit 'f',
leaving HEAD detached.

If we have moved away from commit 'f', then we must first recover its object
name (typically by using git reflog), and then we can create a reference to
it. For example, to see the last two commits to which HEAD referred, we
can use either of these commands:

------------
$ git reflog -2 HEAD # or
$ git log -g -2 HEAD
------------
421

422 423
EXAMPLES
--------
424

425
. The following sequence checks out the `master` branch, reverts
426 427
the `Makefile` to two revisions back, deletes hello.c by
mistake, and gets it back from the index.
428
+
429
------------
430 431
$ git checkout master             <1>
$ git checkout master~2 Makefile  <2>
432
$ rm -f hello.c
433 434 435
$ git checkout hello.c            <3>
------------
+
436
<1> switch branch
437
<2> take a file out of another commit
438
<3> restore hello.c from the index
439
+
440 441 442 443 444 445 446 447 448 449 450 451
If you want to check out _all_ C source files out of the index,
you can say
+
------------
$ git checkout -- '*.c'
------------
+
Note the quotes around `*.c`.  The file `hello.c` will also be
checked out, even though it is no longer in the working tree,
because the file globbing is used to match entries in the index
(not in the working tree by the shell).
+
452 453 454
If you have an unfortunate branch that is named `hello.c`, this
step would be confused as an instruction to switch to that branch.
You should instead write:
455
+
456 457 458 459
------------
$ git checkout -- hello.c
------------

460
. After working in the wrong branch, switching to the correct
461
branch would be done using:
462 463 464 465 466 467
+
------------
$ git checkout mytopic
------------
+
However, your "wrong" branch and correct "mytopic" branch may
468
differ in files that you have modified locally, in which case
469 470 471 472
the above checkout would fail like this:
+
------------
$ git checkout mytopic
473
error: You have local changes to 'frotz'; not switching branches.
474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
------------
+
You can give the `-m` flag to the command, which would try a
three-way merge:
+
------------
$ git checkout -m mytopic
Auto-merging frotz
------------
+
After this three-way merge, the local modifications are _not_
registered in your index file, so `git diff` would show you what
changes you made since the tip of the new branch.

. When a merge conflict happens during switching branches with
the `-m` option, you would see something like this:
+
------------
$ git checkout -m mytopic
Auto-merging frotz
ERROR: Merge conflict in frotz
fatal: merge program failed
------------
+
At this point, `git diff` shows the changes cleanly merged as in
the previous example, as well as the changes in the conflicted
files.  Edit and resolve the conflict and mark it resolved with
501
`git add` as usual:
502 503 504
+
------------
$ edit frotz
505
$ git add frotz
506 507
------------

508 509
GIT
---
510
Part of the linkgit:git[1] suite