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