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