]>
Commit | Line | Data |
---|---|---|
215a7ad1 JH |
1 | git-checkout(1) |
2 | =============== | |
7fc9d69f JH |
3 | |
4 | NAME | |
5 | ---- | |
c4ac525c | 6 | git-checkout - Switch branches or restore working tree files |
7fc9d69f JH |
7 | |
8 | SYNOPSIS | |
9 | -------- | |
71bb1033 | 10 | [verse] |
76cfadfc | 11 | 'git checkout' [-q] [-f] [-m] [<branch>] |
26776c97 JH |
12 | 'git checkout' [-q] [-f] [-m] --detach [<branch>] |
13 | 'git checkout' [-q] [-f] [-m] [--detach] <commit> | |
02ac9837 | 14 | 'git checkout' [-q] [-f] [-m] [[-b|-B|--orphan] <new_branch>] [<start_point>] |
eac5a401 | 15 | 'git checkout' [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] [--] <paths>... |
b59698ae JH |
16 | 'git checkout' [<tree-ish>] [--] <pathspec>... |
17 | 'git checkout' (-p|--patch) [<tree-ish>] [--] [<paths>...] | |
7fc9d69f JH |
18 | |
19 | DESCRIPTION | |
20 | ----------- | |
b831deda JN |
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 | |
76cfadfc | 24 | branch. |
4aaa7027 | 25 | |
37f80025 | 26 | 'git checkout' [<branch>]:: |
181e3725 | 27 | To prepare for working on `<branch>`, switch to it by updating |
e1cdf633 | 28 | the index and the files in the working tree, and by pointing |
181e3725 | 29 | `HEAD` at the branch. Local modifications to the files in the |
e1cdf633 | 30 | working tree are kept, so that they can be committed to the |
181e3725 | 31 | `<branch>`. |
e1cdf633 | 32 | + |
181e3725 | 33 | If `<branch>` is not found but there does exist a tracking branch in |
ccb111b3 NTND |
34 | exactly one remote (call it `<remote>`) with a matching name and |
35 | `--no-guess` is not specified, treat as equivalent to | |
00bb4378 CR |
36 | + |
37 | ------------ | |
38 | $ git checkout -b <branch> --track <remote>/<branch> | |
39 | ------------ | |
40 | + | |
181e3725 | 41 | You could omit `<branch>`, in which case the command degenerates to |
be94568b | 42 | "check out the current branch", which is a glorified no-op with |
e1cdf633 CR |
43 | rather expensive side-effects to show only the tracking information, |
44 | if exists, for the current branch. | |
45 | ||
02ac9837 | 46 | 'git checkout' -b|-B <new_branch> [<start point>]:: |
4aaa7027 | 47 | |
e1cdf633 CR |
48 | Specifying `-b` causes a new branch to be created as if |
49 | linkgit:git-branch[1] were called and then checked out. In | |
50 | this case you can use the `--track` or `--no-track` options, | |
51 | which will be passed to 'git branch'. As a convenience, | |
52 | `--track` without `-b` implies branch creation; see the | |
53 | description of `--track` below. | |
02ac9837 | 54 | + |
181e3725 | 55 | If `-B` is given, `<new_branch>` is created if it doesn't exist; otherwise, it |
02ac9837 TRC |
56 | is reset. This is the transactional equivalent of |
57 | + | |
58 | ------------ | |
59 | $ git branch -f <branch> [<start point>] | |
60 | $ git checkout <branch> | |
61 | ------------ | |
62 | + | |
63 | that is to say, the branch is not reset/created unless "git checkout" is | |
64 | successful. | |
bb0ceb62 | 65 | |
e1cdf633 | 66 | 'git checkout' --detach [<branch>]:: |
26776c97 | 67 | 'git checkout' [--detach] <commit>:: |
e1cdf633 | 68 | |
181e3725 | 69 | Prepare to work on top of `<commit>`, by detaching `HEAD` at it |
e1cdf633 CR |
70 | (see "DETACHED HEAD" section), and updating the index and the |
71 | files in the working tree. Local modifications to the files | |
72 | in the working tree are kept, so that the resulting working | |
73 | tree will be the state recorded in the commit plus the local | |
74 | modifications. | |
75 | + | |
181e3725 NTND |
76 | When the `<commit>` argument is a branch name, the `--detach` option can |
77 | be used to detach `HEAD` at the tip of the branch (`git checkout | |
78 | <branch>` would check out that branch without detaching `HEAD`). | |
26776c97 | 79 | + |
181e3725 | 80 | Omitting `<branch>` detaches `HEAD` at the tip of the current branch. |
e1cdf633 | 81 | |
b59698ae | 82 | 'git checkout' [<tree-ish>] [--] <pathspec>...:: |
4aaa7027 | 83 | |
b59698ae | 84 | Overwrite paths in the working tree by replacing with the |
181e3725 NTND |
85 | contents in the index or in the `<tree-ish>` (most often a |
86 | commit). When a `<tree-ish>` is given, the paths that | |
87 | match the `<pathspec>` are updated both in the index and in | |
b59698ae | 88 | the working tree. |
c4ac525c | 89 | + |
b831deda JN |
90 | The index may contain unmerged entries because of a previous failed merge. |
91 | By default, if you try to check out such an entry from the index, the | |
db941099 | 92 | checkout operation will fail and nothing will be checked out. |
b831deda | 93 | Using `-f` will ignore these unmerged entries. The contents from a |
38901a48 | 94 | specific side of the merge can be checked out of the index by |
b831deda JN |
95 | using `--ours` or `--theirs`. With `-m`, changes made to the working tree |
96 | file can be discarded to re-create the original conflicted merge result. | |
7fc9d69f | 97 | |
b59698ae JH |
98 | 'git checkout' (-p|--patch) [<tree-ish>] [--] [<pathspec>...]:: |
99 | This is similar to the "check out paths to the working tree | |
100 | from either the index or from a tree-ish" mode described | |
101 | above, but lets you use the interactive interface to show | |
102 | the "diff" output and choose which hunks to use in the | |
103 | result. See below for the description of `--patch` option. | |
104 | ||
105 | ||
7fc9d69f JH |
106 | OPTIONS |
107 | ------- | |
6124aee5 | 108 | -q:: |
f7aec129 | 109 | --quiet:: |
2be7fcb4 | 110 | Quiet, suppress feedback messages. |
6124aee5 | 111 | |
d333f672 NTND |
112 | --progress:: |
113 | --no-progress:: | |
870ebdb9 ECA |
114 | Progress status is reported on the standard error stream |
115 | by default when it is attached to a terminal, unless `--quiet` | |
116 | is specified. This flag enables progress reporting even if not | |
117 | attached to a terminal, regardless of `--quiet`. | |
118 | ||
0270f7c5 | 119 | -f:: |
f7aec129 | 120 | --force:: |
db941099 | 121 | When switching branches, proceed even if the index or the |
181e3725 | 122 | working tree differs from `HEAD`. This is used to throw away |
db941099 JH |
123 | local changes. |
124 | + | |
125 | When checking out paths from the index, do not fail upon unmerged | |
126 | entries; instead, unmerged entries are ignored. | |
0270f7c5 | 127 | |
38901a48 JH |
128 | --ours:: |
129 | --theirs:: | |
130 | When checking out paths from the index, check out stage #2 | |
131 | ('ours') or #3 ('theirs') for unmerged paths. | |
f3030165 SE |
132 | + |
133 | Note that during `git rebase` and `git pull --rebase`, 'ours' and | |
134 | 'theirs' may appear swapped; `--ours` gives the version from the | |
135 | branch the changes are rebased onto, while `--theirs` gives the | |
136 | version from the branch that holds your work that is being rebased. | |
137 | + | |
138 | This is because `rebase` is used in a workflow that treats the | |
139 | history at the remote as the shared canonical one, and treats the | |
140 | work done on the branch you are rebasing as the third-party work to | |
141 | be integrated, and you are temporarily assuming the role of the | |
142 | keeper of the canonical history during the rebase. As the keeper of | |
143 | the canonical history, you need to view the history from the remote | |
144 | as `ours` (i.e. "our shared canonical history"), while what you did | |
145 | on your side branch as `theirs` (i.e. "one contributor's work on top | |
146 | of it"). | |
0270f7c5 | 147 | |
45aaf031 | 148 | -b <new_branch>:: |
181e3725 NTND |
149 | Create a new branch named `<new_branch>` and start it at |
150 | `<start_point>`; see linkgit:git-branch[1] for details. | |
7fc9d69f | 151 | |
45aaf031 | 152 | -B <new_branch>:: |
181e3725 NTND |
153 | Creates the branch `<new_branch>` and start it at `<start_point>`; |
154 | if it already exists, then reset it to `<start_point>`. This is | |
02ac9837 TRC |
155 | equivalent to running "git branch" with "-f"; see |
156 | linkgit:git-branch[1] for details. | |
157 | ||
3240240f SB |
158 | -t:: |
159 | --track:: | |
26d22dc6 JK |
160 | When creating a new branch, set up "upstream" configuration. See |
161 | "--track" in linkgit:git-branch[1] for details. | |
bb0ceb62 | 162 | + |
23f8239b | 163 | If no `-b` option is given, the name of the new branch will be |
fa83a33b JH |
164 | derived from the remote-tracking branch, by looking at the local part of |
165 | the refspec configured for the corresponding remote, and then stripping | |
166 | the initial part up to the "*". | |
181e3725 NTND |
167 | This would tell us to use `hack` as the local branch when branching |
168 | off of `origin/hack` (or `remotes/origin/hack`, or even | |
169 | `refs/remotes/origin/hack`). If the given name has no slash, or the above | |
9188ed89 | 170 | guessing results in an empty name, the guessing is aborted. You can |
23f8239b | 171 | explicitly give a name with `-b` in such a case. |
0746d19a PB |
172 | |
173 | --no-track:: | |
167d7445 | 174 | Do not set up "upstream" configuration, even if the |
181e3725 | 175 | `branch.autoSetupMerge` configuration variable is true. |
0746d19a | 176 | |
ccb111b3 NTND |
177 | --guess:: |
178 | --no-guess:: | |
179 | If `<branch>` is not found but there does exist a tracking | |
180 | branch in exactly one remote (call it `<remote>`) with a | |
181 | matching name, treat as equivalent to | |
182 | + | |
183 | ------------ | |
184 | $ git checkout -b <branch> --track <remote>/<branch> | |
185 | ------------ | |
186 | + | |
187 | If the branch exists in multiple remotes and one of them is named by | |
188 | the `checkout.defaultRemote` configuration variable, we'll use that | |
189 | one for the purposes of disambiguation, even if the `<branch>` isn't | |
190 | unique across all remotes. Set it to | |
191 | e.g. `checkout.defaultRemote=origin` to always checkout remote | |
192 | branches from there if `<branch>` is ambiguous but exists on the | |
193 | 'origin' remote. See also `checkout.defaultRemote` in | |
194 | linkgit:git-config[1]. | |
195 | + | |
196 | Use `--no-guess` to disable this. | |
0746d19a | 197 | |
969d326d | 198 | -l:: |
26d22dc6 JK |
199 | Create the new branch's reflog; see linkgit:git-branch[1] for |
200 | details. | |
969d326d | 201 | |
32669671 JH |
202 | --detach:: |
203 | Rather than checking out a branch to work on it, check out a | |
204 | commit for inspection and discardable experiments. | |
181e3725 NTND |
205 | This is the default behavior of `git checkout <commit>` when |
206 | `<commit>` is not a branch name. See the "DETACHED HEAD" section | |
32669671 JH |
207 | below for details. |
208 | ||
45aaf031 | 209 | --orphan <new_branch>:: |
181e3725 NTND |
210 | Create a new 'orphan' branch, named `<new_branch>`, started from |
211 | `<start_point>` and switch to it. The first commit made on this | |
feb98d13 EM |
212 | new branch will have no parents and it will be the root of a new |
213 | history totally disconnected from all the other branches and | |
214 | commits. | |
9db5ebf4 | 215 | + |
feb98d13 | 216 | The index and the working tree are adjusted as if you had previously run |
181e3725 NTND |
217 | `git checkout <start_point>`. This allows you to start a new history |
218 | that records a set of paths similar to `<start_point>` by easily running | |
219 | `git commit -a` to make the root commit. | |
9db5ebf4 | 220 | + |
feb98d13 EM |
221 | This can be useful when you want to publish the tree from a commit |
222 | without exposing its full history. You might want to do this to publish | |
223 | an open source branch of a project whose current tree is "clean", but | |
224 | whose full history contains proprietary or otherwise encumbered bits of | |
225 | code. | |
226 | + | |
227 | If you want to start a disconnected history that records a set of paths | |
181e3725 | 228 | that is totally different from the one of `<start_point>`, then you should |
feb98d13 | 229 | clear the index and the working tree right after creating the orphan |
181e3725 | 230 | branch by running `git rm -rf .` from the top level of the working tree. |
feb98d13 EM |
231 | Afterwards you will be ready to prepare your new files, repopulating the |
232 | working tree, by copying them from elsewhere, extracting a tarball, etc. | |
9db5ebf4 | 233 | |
08d595dc NTND |
234 | --ignore-skip-worktree-bits:: |
235 | In sparse checkout mode, `git checkout -- <paths>` would | |
181e3725 NTND |
236 | update only entries matched by `<paths>` and sparse patterns |
237 | in `$GIT_DIR/info/sparse-checkout`. This option ignores | |
238 | the sparse patterns and adds back any files in `<paths>`. | |
08d595dc | 239 | |
1be0659e | 240 | -m:: |
eac5a401 | 241 | --merge:: |
0cf8581e JH |
242 | When switching branches, |
243 | if you have local modifications to one or more files that | |
71bb1033 JL |
244 | are different between the current branch and the branch to |
245 | which you are switching, the command refuses to switch | |
246 | branches in order to preserve your modifications in context. | |
247 | However, with this option, a three-way merge between the current | |
1be0659e JH |
248 | branch, your working tree contents, and the new branch |
249 | is done, and you will be on the new branch. | |
250 | + | |
251 | When a merge conflict happens, the index entries for conflicting | |
252 | paths are left unmerged, and you need to resolve the conflicts | |
d7f078b8 SP |
253 | and mark the resolved paths with `git add` (or `git rm` if the merge |
254 | should result in deletion of the path). | |
0cf8581e JH |
255 | + |
256 | When checking out paths from the index, this option lets you recreate | |
257 | the conflicted merge in the specified paths. | |
a7256deb NTND |
258 | + |
259 | When switching branches with `--merge`, staged changes may be lost. | |
1be0659e | 260 | |
eac5a401 | 261 | --conflict=<style>:: |
181e3725 | 262 | The same as `--merge` option above, but changes the way the |
eac5a401 | 263 | conflicting hunks are presented, overriding the |
181e3725 | 264 | `merge.conflictStyle` configuration variable. Possible values are |
eac5a401 JH |
265 | "merge" (default) and "diff3" (in addition to what is shown by |
266 | "merge" style, shows the original contents). | |
1be0659e | 267 | |
4f353658 TR |
268 | -p:: |
269 | --patch:: | |
270 | Interactively select hunks in the difference between the | |
181e3725 | 271 | `<tree-ish>` (or the index, if unspecified) and the working |
4f353658 | 272 | tree. The chosen hunks are then applied in reverse to the |
181e3725 | 273 | working tree (and if a `<tree-ish>` was specified, the index). |
4f353658 TR |
274 | + |
275 | This means that you can use `git checkout -p` to selectively discard | |
a31538e2 | 276 | edits from your current working tree. See the ``Interactive Mode'' |
6cf378f0 | 277 | section of linkgit:git-add[1] to learn how to operate the `--patch` mode. |
091e04bc TG |
278 | + |
279 | Note that this option uses the no overlay mode by default (see also | |
d333f672 | 280 | `--overlay`), and currently doesn't support overlay mode. |
4f353658 | 281 | |
1d0fa898 NTND |
282 | --ignore-other-worktrees:: |
283 | `git checkout` refuses when the wanted ref is already checked | |
284 | out by another worktree. This option makes it check the ref | |
285 | out anyway. In other words, the ref can be held by more than one | |
286 | worktree. | |
287 | ||
9d223d43 NTND |
288 | --overwrite-ignore:: |
289 | --no-overwrite-ignore:: | |
290 | Silently overwrite ignored files when switching branches. This | |
291 | is the default behavior. Use `--no-overwrite-ignore` to abort | |
292 | the operation when the new branch contains ignored files. | |
293 | ||
d333f672 NTND |
294 | --recurse-submodules:: |
295 | --no-recurse-submodules:: | |
181e3725 | 296 | Using `--recurse-submodules` will update the content of all initialized |
1fc458d9 SB |
297 | submodules according to the commit recorded in the superproject. If |
298 | local modifications in a submodule would be overwritten the checkout | |
181e3725 | 299 | will fail unless `-f` is used. If nothing (or `--no-recurse-submodules`) |
1fc458d9 | 300 | is used, the work trees of submodules will not be updated. |
181e3725 NTND |
301 | Just like linkgit:git-submodule[1], this will detach `HEAD` of the |
302 | submodule. | |
be4908f1 | 303 | |
d333f672 NTND |
304 | --overlay:: |
305 | --no-overlay:: | |
091e04bc TG |
306 | In the default overlay mode, `git checkout` never |
307 | removes files from the index or the working tree. When | |
308 | specifying `--no-overlay`, files that appear in the index and | |
181e3725 NTND |
309 | working tree, but not in `<tree-ish>` are removed, to make them |
310 | match `<tree-ish>` exactly. | |
091e04bc | 311 | |
0270f7c5 | 312 | <branch>:: |
0808723b JK |
313 | Branch to checkout; if it refers to a branch (i.e., a name that, |
314 | when prepended with "refs/heads/", is a valid ref), then that | |
315 | branch is checked out. Otherwise, if it refers to a valid | |
181e3725 | 316 | commit, your `HEAD` becomes "detached" and you are no longer on |
0808723b | 317 | any branch (see below for details). |
696acf45 | 318 | + |
181e3725 | 319 | You can use the `@{-N}` syntax to refer to the N-th last |
75ce1495 | 320 | branch/commit checked out using "git checkout" operation. You may |
181e3725 | 321 | also specify `-` which is synonymous to `@{-1}`. |
873c3472 | 322 | + |
181e3725 | 323 | As a special case, you may use `A...B` as a shortcut for the |
873c3472 MG |
324 | merge base of `A` and `B` if there is exactly one merge base. You can |
325 | leave out at most one of `A` and `B`, in which case it defaults to `HEAD`. | |
5e1a2e8c | 326 | |
76cfadfc JK |
327 | <new_branch>:: |
328 | Name for the new branch. | |
329 | ||
330 | <start_point>:: | |
331 | The name of a commit at which to start the new branch; see | |
181e3725 | 332 | linkgit:git-branch[1] for details. Defaults to `HEAD`. |
e3d6539d DL |
333 | + |
334 | As a special case, you may use `"A...B"` as a shortcut for the | |
335 | merge base of `A` and `B` if there is exactly one merge base. You can | |
336 | leave out at most one of `A` and `B`, in which case it defaults to `HEAD`. | |
76cfadfc JK |
337 | |
338 | <tree-ish>:: | |
339 | Tree to checkout from (when paths are given). If not specified, | |
340 | the index will be used. | |
341 | ||
342 | ||
5e1a2e8c | 343 | |
32669671 | 344 | DETACHED HEAD |
5e1a2e8c | 345 | ------------- |
181e3725 | 346 | `HEAD` normally refers to a named branch (e.g. `master`). Meanwhile, each |
be8ef33c | 347 | branch refers to a specific commit. Let's look at a repo with three |
181e3725 | 348 | commits, one of them tagged, and with branch `master` checked out: |
5e1a2e8c | 349 | |
be8ef33c | 350 | ------------ |
39a36827 AH |
351 | HEAD (refers to branch 'master') |
352 | | | |
353 | v | |
be8ef33c JS |
354 | a---b---c branch 'master' (refers to commit 'c') |
355 | ^ | |
356 | | | |
357 | tag 'v2.0' (refers to commit 'b') | |
358 | ------------ | |
359 | ||
360 | When a commit is created in this state, the branch is updated to refer to | |
181e3725 NTND |
361 | the new commit. Specifically, 'git commit' creates a new commit `d`, whose |
362 | parent is commit `c`, and then updates branch `master` to refer to new | |
363 | commit `d`. `HEAD` still refers to branch `master` and so indirectly now refers | |
364 | to commit `d`: | |
5e1a2e8c JH |
365 | |
366 | ------------ | |
be8ef33c JS |
367 | $ edit; git add; git commit |
368 | ||
39a36827 AH |
369 | HEAD (refers to branch 'master') |
370 | | | |
371 | v | |
be8ef33c JS |
372 | a---b---c---d branch 'master' (refers to commit 'd') |
373 | ^ | |
374 | | | |
375 | tag 'v2.0' (refers to commit 'b') | |
5e1a2e8c JH |
376 | ------------ |
377 | ||
be8ef33c JS |
378 | It is sometimes useful to be able to checkout a commit that is not at |
379 | the tip of any named branch, or even to create a new commit that is not | |
380 | referenced by a named branch. Let's look at what happens when we | |
181e3725 | 381 | checkout commit `b` (here we show two ways this may be done): |
cec8d146 JH |
382 | |
383 | ------------ | |
be8ef33c JS |
384 | $ git checkout v2.0 # or |
385 | $ git checkout master^^ | |
386 | ||
387 | HEAD (refers to commit 'b') | |
388 | | | |
389 | v | |
390 | a---b---c---d branch 'master' (refers to commit 'd') | |
391 | ^ | |
392 | | | |
393 | tag 'v2.0' (refers to commit 'b') | |
394 | ------------ | |
5e1a2e8c | 395 | |
181e3725 NTND |
396 | Notice that regardless of which checkout command we use, `HEAD` now refers |
397 | directly to commit `b`. This is known as being in detached `HEAD` state. | |
398 | It means simply that `HEAD` refers to a specific commit, as opposed to | |
be8ef33c | 399 | referring to a named branch. Let's see what happens when we create a commit: |
cec8d146 | 400 | |
cec8d146 | 401 | ------------ |
be8ef33c JS |
402 | $ edit; git add; git commit |
403 | ||
404 | HEAD (refers to commit 'e') | |
405 | | | |
406 | v | |
407 | e | |
408 | / | |
409 | a---b---c---d branch 'master' (refers to commit 'd') | |
410 | ^ | |
411 | | | |
412 | tag 'v2.0' (refers to commit 'b') | |
cec8d146 | 413 | ------------ |
7fc9d69f | 414 | |
181e3725 | 415 | There is now a new commit `e`, but it is referenced only by `HEAD`. We can |
be8ef33c | 416 | of course add yet another commit in this state: |
7fc9d69f | 417 | |
be8ef33c JS |
418 | ------------ |
419 | $ edit; git add; git commit | |
420 | ||
421 | HEAD (refers to commit 'f') | |
422 | | | |
423 | v | |
424 | e---f | |
425 | / | |
426 | a---b---c---d branch 'master' (refers to commit 'd') | |
427 | ^ | |
428 | | | |
429 | tag 'v2.0' (refers to commit 'b') | |
430 | ------------ | |
431 | ||
2de9b711 | 432 | In fact, we can perform all the normal Git operations. But, let's look |
181e3725 | 433 | at what happens when we then checkout `master`: |
be8ef33c JS |
434 | |
435 | ------------ | |
436 | $ git checkout master | |
437 | ||
39a36827 | 438 | HEAD (refers to branch 'master') |
be8ef33c JS |
439 | e---f | |
440 | / v | |
441 | a---b---c---d branch 'master' (refers to commit 'd') | |
442 | ^ | |
443 | | | |
444 | tag 'v2.0' (refers to commit 'b') | |
445 | ------------ | |
446 | ||
447 | It is important to realize that at this point nothing refers to commit | |
181e3725 | 448 | `f`. Eventually commit `f` (and by extension commit `e`) will be deleted |
2de9b711 | 449 | by the routine Git garbage collection process, unless we create a reference |
181e3725 | 450 | before that happens. If we have not yet moved away from commit `f`, |
be8ef33c JS |
451 | any of these will create a reference to it: |
452 | ||
453 | ------------ | |
454 | $ git checkout -b foo <1> | |
455 | $ git branch foo <2> | |
456 | $ git tag foo <3> | |
457 | ------------ | |
458 | ||
181e3725 NTND |
459 | <1> creates a new branch `foo`, which refers to commit `f`, and then |
460 | updates `HEAD` to refer to branch `foo`. In other words, we'll no longer | |
461 | be in detached `HEAD` state after this command. | |
be8ef33c | 462 | |
181e3725 NTND |
463 | <2> similarly creates a new branch `foo`, which refers to commit `f`, |
464 | but leaves `HEAD` detached. | |
be8ef33c | 465 | |
181e3725 NTND |
466 | <3> creates a new tag `foo`, which refers to commit `f`, |
467 | leaving `HEAD` detached. | |
be8ef33c | 468 | |
181e3725 | 469 | If we have moved away from commit `f`, then we must first recover its object |
be8ef33c | 470 | name (typically by using git reflog), and then we can create a reference to |
181e3725 | 471 | it. For example, to see the last two commits to which `HEAD` referred, we |
be8ef33c JS |
472 | can use either of these commands: |
473 | ||
474 | ------------ | |
475 | $ git reflog -2 HEAD # or | |
476 | $ git log -g -2 HEAD | |
477 | ------------ | |
4aaa7027 | 478 | |
19e56563 NTND |
479 | ARGUMENT DISAMBIGUATION |
480 | ----------------------- | |
481 | ||
181e3725 NTND |
482 | When there is only one argument given and it is not `--` (e.g. `git |
483 | checkout abc`), and when the argument is both a valid `<tree-ish>` | |
484 | (e.g. a branch `abc` exists) and a valid `<pathspec>` (e.g. a file | |
19e56563 NTND |
485 | or a directory whose name is "abc" exists), Git would usually ask |
486 | you to disambiguate. Because checking out a branch is so common an | |
181e3725 | 487 | operation, however, `git checkout abc` takes "abc" as a `<tree-ish>` |
19e56563 NTND |
488 | in such a situation. Use `git checkout -- <pathspec>` if you want |
489 | to checkout these paths out of the index. | |
490 | ||
1be0659e JH |
491 | EXAMPLES |
492 | -------- | |
4aaa7027 | 493 | |
1be0659e | 494 | . The following sequence checks out the `master` branch, reverts |
181e3725 | 495 | the `Makefile` to two revisions back, deletes `hello.c` by |
ba170517 | 496 | mistake, and gets it back from the index. |
1be0659e | 497 | + |
4aaa7027 | 498 | ------------ |
48aeecdc SE |
499 | $ git checkout master <1> |
500 | $ git checkout master~2 Makefile <2> | |
4aaa7027 | 501 | $ rm -f hello.c |
48aeecdc SE |
502 | $ git checkout hello.c <3> |
503 | ------------ | |
504 | + | |
1e2ccd3a | 505 | <1> switch branch |
c7cb12b8 | 506 | <2> take a file out of another commit |
181e3725 | 507 | <3> restore `hello.c` from the index |
1be0659e | 508 | + |
caae319e JH |
509 | If you want to check out _all_ C source files out of the index, |
510 | you can say | |
511 | + | |
512 | ------------ | |
513 | $ git checkout -- '*.c' | |
514 | ------------ | |
515 | + | |
516 | Note the quotes around `*.c`. The file `hello.c` will also be | |
517 | checked out, even though it is no longer in the working tree, | |
518 | because the file globbing is used to match entries in the index | |
519 | (not in the working tree by the shell). | |
520 | + | |
48aeecdc SE |
521 | If you have an unfortunate branch that is named `hello.c`, this |
522 | step would be confused as an instruction to switch to that branch. | |
523 | You should instead write: | |
1be0659e | 524 | + |
4aaa7027 JH |
525 | ------------ |
526 | $ git checkout -- hello.c | |
527 | ------------ | |
528 | ||
c7cb12b8 | 529 | . After working in the wrong branch, switching to the correct |
ba170517 | 530 | branch would be done using: |
1be0659e JH |
531 | + |
532 | ------------ | |
533 | $ git checkout mytopic | |
534 | ------------ | |
535 | + | |
181e3725 | 536 | However, your "wrong" branch and correct `mytopic` branch may |
c7cb12b8 | 537 | differ in files that you have modified locally, in which case |
1be0659e JH |
538 | the above checkout would fail like this: |
539 | + | |
540 | ------------ | |
541 | $ git checkout mytopic | |
142183d0 | 542 | error: You have local changes to 'frotz'; not switching branches. |
1be0659e JH |
543 | ------------ |
544 | + | |
545 | You can give the `-m` flag to the command, which would try a | |
546 | three-way merge: | |
547 | + | |
548 | ------------ | |
549 | $ git checkout -m mytopic | |
550 | Auto-merging frotz | |
551 | ------------ | |
552 | + | |
553 | After this three-way merge, the local modifications are _not_ | |
554 | registered in your index file, so `git diff` would show you what | |
555 | changes you made since the tip of the new branch. | |
556 | ||
557 | . When a merge conflict happens during switching branches with | |
ba170517 | 558 | the `-m` option, you would see something like this: |
1be0659e JH |
559 | + |
560 | ------------ | |
561 | $ git checkout -m mytopic | |
562 | Auto-merging frotz | |
1be0659e JH |
563 | ERROR: Merge conflict in frotz |
564 | fatal: merge program failed | |
565 | ------------ | |
566 | + | |
567 | At this point, `git diff` shows the changes cleanly merged as in | |
568 | the previous example, as well as the changes in the conflicted | |
569 | files. Edit and resolve the conflict and mark it resolved with | |
d7f078b8 | 570 | `git add` as usual: |
1be0659e JH |
571 | + |
572 | ------------ | |
573 | $ edit frotz | |
d7f078b8 | 574 | $ git add frotz |
1be0659e JH |
575 | ------------ |
576 | ||
d787d311 NTND |
577 | SEE ALSO |
578 | -------- | |
46e91b66 NTND |
579 | linkgit:git-switch[1], |
580 | linkgit:git-restore[1] | |
d787d311 | 581 | |
7fc9d69f JH |
582 | GIT |
583 | --- | |
9e1f0a85 | 584 | Part of the linkgit:git[1] suite |