Junio C Hamano | 215a7ad | 2005-09-07 17:26:23 -0700 | [diff] [blame] | 1 | git-checkout(1) |
| 2 | =============== |
Junio C Hamano | 7fc9d69 | 2005-08-23 01:49:47 -0700 | [diff] [blame] | 3 | |
| 4 | NAME |
| 5 | ---- |
Torsten Bögershausen | c4ac525 | 2015-06-17 09:54:51 +0200 | [diff] [blame] | 6 | git-checkout - Switch branches or restore working tree files |
Junio C Hamano | 7fc9d69 | 2005-08-23 01:49:47 -0700 | [diff] [blame] | 7 | |
| 8 | SYNOPSIS |
| 9 | -------- |
Jon Loeliger | 71bb103 | 2006-03-17 18:26:01 -0600 | [diff] [blame] | 10 | [verse] |
Jeff King | 76cfadf | 2009-04-13 07:19:33 -0400 | [diff] [blame] | 11 | 'git checkout' [-q] [-f] [-m] [<branch>] |
Junio C Hamano | 26776c9 | 2013-09-11 10:05:17 -0700 | [diff] [blame] | 12 | 'git checkout' [-q] [-f] [-m] --detach [<branch>] |
| 13 | 'git checkout' [-q] [-f] [-m] [--detach] <commit> |
Tay Ray Chuan | 02ac983 | 2010-06-24 03:29:00 +0800 | [diff] [blame] | 14 | 'git checkout' [-q] [-f] [-m] [[-b|-B|--orphan] <new_branch>] [<start_point>] |
Alexandr Miloslavskiy | 8ea1189 | 2019-12-03 14:02:16 +0000 | [diff] [blame] | 15 | 'git checkout' [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] [--] <pathspec>... |
Alexandr Miloslavskiy | a9aecc7 | 2019-12-03 14:02:18 +0000 | [diff] [blame] | 16 | 'git checkout' [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] --pathspec-from-file=<file> [--pathspec-file-nul] |
Alexandr Miloslavskiy | 8ea1189 | 2019-12-03 14:02:16 +0000 | [diff] [blame] | 17 | 'git checkout' (-p|--patch) [<tree-ish>] [--] [<pathspec>...] |
Junio C Hamano | 7fc9d69 | 2005-08-23 01:49:47 -0700 | [diff] [blame] | 18 | |
| 19 | DESCRIPTION |
| 20 | ----------- |
Jonathan Nieder | b831ded | 2010-06-01 02:25:23 -0500 | [diff] [blame] | 21 | Updates files in the working tree to match the version in the index |
Alexandr Miloslavskiy | 8ea1189 | 2019-12-03 14:02:16 +0000 | [diff] [blame] | 22 | or the specified tree. If no pathspec was given, 'git checkout' will |
Jonathan Nieder | b831ded | 2010-06-01 02:25:23 -0500 | [diff] [blame] | 23 | also update `HEAD` to set the specified branch as the current |
Jeff King | 76cfadf | 2009-04-13 07:19:33 -0400 | [diff] [blame] | 24 | branch. |
Junio C Hamano | 4aaa702 | 2005-10-18 01:29:27 -0700 | [diff] [blame] | 25 | |
Nguyễn Thái Ngọc Duy | 37f8002 | 2019-03-29 17:38:54 +0700 | [diff] [blame] | 26 | 'git checkout' [<branch>]:: |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 27 | To prepare for working on `<branch>`, switch to it by updating |
Chris Rorvick | e1cdf63 | 2012-12-17 00:45:01 -0600 | [diff] [blame] | 28 | the index and the files in the working tree, and by pointing |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 29 | `HEAD` at the branch. Local modifications to the files in the |
Chris Rorvick | e1cdf63 | 2012-12-17 00:45:01 -0600 | [diff] [blame] | 30 | working tree are kept, so that they can be committed to the |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 31 | `<branch>`. |
Jonathan Nieder | c5b4151 | 2010-05-30 03:41:53 -0500 | [diff] [blame] | 32 | + |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 33 | If `<branch>` is not found but there does exist a tracking branch in |
Nguyễn Thái Ngọc Duy | ccb111b | 2019-03-29 17:39:13 +0700 | [diff] [blame] | 34 | exactly one remote (call it `<remote>`) with a matching name and |
| 35 | `--no-guess` is not specified, treat as equivalent to |
Chris Rorvick | 00bb437 | 2012-12-17 00:45:02 -0600 | [diff] [blame] | 36 | + |
| 37 | ------------ |
| 38 | $ git checkout -b <branch> --track <remote>/<branch> |
| 39 | ------------ |
| 40 | + |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 41 | You could omit `<branch>`, in which case the command degenerates to |
Evan Zacks | be94568 | 2017-09-12 15:58:39 -0700 | [diff] [blame] | 42 | "check out the current branch", which is a glorified no-op with |
Chris Rorvick | e1cdf63 | 2012-12-17 00:45:01 -0600 | [diff] [blame] | 43 | rather expensive side-effects to show only the tracking information, |
| 44 | if exists, for the current branch. |
| 45 | |
| 46 | 'git checkout' -b|-B <new_branch> [<start point>]:: |
| 47 | |
| 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. |
Tay Ray Chuan | 02ac983 | 2010-06-24 03:29:00 +0800 | [diff] [blame] | 54 | + |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 55 | If `-B` is given, `<new_branch>` is created if it doesn't exist; otherwise, it |
Tay Ray Chuan | 02ac983 | 2010-06-24 03:29:00 +0800 | [diff] [blame] | 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. |
Junio C Hamano | 4aaa702 | 2005-10-18 01:29:27 -0700 | [diff] [blame] | 65 | |
Chris Rorvick | e1cdf63 | 2012-12-17 00:45:01 -0600 | [diff] [blame] | 66 | 'git checkout' --detach [<branch>]:: |
Junio C Hamano | 26776c9 | 2013-09-11 10:05:17 -0700 | [diff] [blame] | 67 | 'git checkout' [--detach] <commit>:: |
Chris Rorvick | e1cdf63 | 2012-12-17 00:45:01 -0600 | [diff] [blame] | 68 | |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 69 | Prepare to work on top of `<commit>`, by detaching `HEAD` at it |
Chris Rorvick | e1cdf63 | 2012-12-17 00:45:01 -0600 | [diff] [blame] | 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 | + |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 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`). |
Junio C Hamano | 26776c9 | 2013-09-11 10:05:17 -0700 | [diff] [blame] | 79 | + |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 80 | Omitting `<branch>` detaches `HEAD` at the tip of the current branch. |
Chris Rorvick | e1cdf63 | 2012-12-17 00:45:01 -0600 | [diff] [blame] | 81 | |
Alexandr Miloslavskiy | 8ea1189 | 2019-12-03 14:02:16 +0000 | [diff] [blame] | 82 | 'git checkout' [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] [--] <pathspec>...:: |
Alexandr Miloslavskiy | a9aecc7 | 2019-12-03 14:02:18 +0000 | [diff] [blame] | 83 | 'git checkout' [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] --pathspec-from-file=<file> [--pathspec-file-nul]:: |
A Large Angry SCM | 0270f7c | 2005-09-07 17:17:18 -0400 | [diff] [blame] | 84 | |
Alexandr Miloslavskiy | 8ea1189 | 2019-12-03 14:02:16 +0000 | [diff] [blame] | 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>`. |
Torsten Bögershausen | c4ac525 | 2015-06-17 09:54:51 +0200 | [diff] [blame] | 90 | + |
Jonathan Nieder | b831ded | 2010-06-01 02:25:23 -0500 | [diff] [blame] | 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 |
Junio C Hamano | db94109 | 2008-08-30 07:46:55 -0700 | [diff] [blame] | 93 | checkout operation will fail and nothing will be checked out. |
Jonathan Nieder | b831ded | 2010-06-01 02:25:23 -0500 | [diff] [blame] | 94 | Using `-f` will ignore these unmerged entries. The contents from a |
Junio C Hamano | 38901a4 | 2008-08-30 07:48:18 -0700 | [diff] [blame] | 95 | specific side of the merge can be checked out of the index by |
Jonathan Nieder | b831ded | 2010-06-01 02:25:23 -0500 | [diff] [blame] | 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. |
Junio C Hamano | 7fc9d69 | 2005-08-23 01:49:47 -0700 | [diff] [blame] | 98 | |
Junio C Hamano | b59698a | 2017-10-11 11:21:03 +0900 | [diff] [blame] | 99 | 'git checkout' (-p|--patch) [<tree-ish>] [--] [<pathspec>...]:: |
Alexandr Miloslavskiy | 6fdc9ad | 2019-12-03 14:02:15 +0000 | [diff] [blame] | 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. |
Junio C Hamano | b59698a | 2017-10-11 11:21:03 +0900 | [diff] [blame] | 104 | |
Junio C Hamano | 7fc9d69 | 2005-08-23 01:49:47 -0700 | [diff] [blame] | 105 | OPTIONS |
| 106 | ------- |
Nicolas Pitre | 6124aee | 2007-02-01 12:31:26 -0500 | [diff] [blame] | 107 | -q:: |
René Scharfe | f7aec12 | 2009-08-29 11:05:00 +0200 | [diff] [blame] | 108 | --quiet:: |
Dave Watson | 2be7fcb | 2007-08-19 22:27:52 -0400 | [diff] [blame] | 109 | Quiet, suppress feedback messages. |
Nicolas Pitre | 6124aee | 2007-02-01 12:31:26 -0500 | [diff] [blame] | 110 | |
Nguyễn Thái Ngọc Duy | d333f67 | 2019-03-29 17:38:53 +0700 | [diff] [blame] | 111 | --progress:: |
| 112 | --no-progress:: |
Edmundo Carmona Antoranz | 870ebdb | 2015-11-01 15:19:05 -0600 | [diff] [blame] | 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 | |
A Large Angry SCM | 0270f7c | 2005-09-07 17:17:18 -0400 | [diff] [blame] | 118 | -f:: |
René Scharfe | f7aec12 | 2009-08-29 11:05:00 +0200 | [diff] [blame] | 119 | --force:: |
Junio C Hamano | db94109 | 2008-08-30 07:46:55 -0700 | [diff] [blame] | 120 | When switching branches, proceed even if the index or the |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 121 | working tree differs from `HEAD`. This is used to throw away |
Junio C Hamano | db94109 | 2008-08-30 07:46:55 -0700 | [diff] [blame] | 122 | local changes. |
| 123 | + |
| 124 | When checking out paths from the index, do not fail upon unmerged |
| 125 | entries; instead, unmerged entries are ignored. |
Junio C Hamano | 7fc9d69 | 2005-08-23 01:49:47 -0700 | [diff] [blame] | 126 | |
Junio C Hamano | 38901a4 | 2008-08-30 07:48:18 -0700 | [diff] [blame] | 127 | --ours:: |
| 128 | --theirs:: |
| 129 | When checking out paths from the index, check out stage #2 |
| 130 | ('ours') or #3 ('theirs') for unmerged paths. |
Simon A. Eugster | f303016 | 2015-07-10 13:07:11 -0700 | [diff] [blame] | 131 | + |
| 132 | Note that during `git rebase` and `git pull --rebase`, 'ours' and |
| 133 | 'theirs' may appear swapped; `--ours` gives the version from the |
| 134 | branch the changes are rebased onto, while `--theirs` gives the |
| 135 | version from the branch that holds your work that is being rebased. |
| 136 | + |
| 137 | This is because `rebase` is used in a workflow that treats the |
| 138 | history at the remote as the shared canonical one, and treats the |
| 139 | work done on the branch you are rebasing as the third-party work to |
| 140 | be integrated, and you are temporarily assuming the role of the |
| 141 | keeper of the canonical history during the rebase. As the keeper of |
| 142 | the canonical history, you need to view the history from the remote |
| 143 | as `ours` (i.e. "our shared canonical history"), while what you did |
| 144 | on your side branch as `theirs` (i.e. "one contributor's work on top |
| 145 | of it"). |
Junio C Hamano | 7fc9d69 | 2005-08-23 01:49:47 -0700 | [diff] [blame] | 146 | |
Junio C Hamano | 45aaf03 | 2012-08-26 11:40:08 -0700 | [diff] [blame] | 147 | -b <new_branch>:: |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 148 | Create a new branch named `<new_branch>` and start it at |
| 149 | `<start_point>`; see linkgit:git-branch[1] for details. |
Junio C Hamano | 7fc9d69 | 2005-08-23 01:49:47 -0700 | [diff] [blame] | 150 | |
Junio C Hamano | 45aaf03 | 2012-08-26 11:40:08 -0700 | [diff] [blame] | 151 | -B <new_branch>:: |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 152 | Creates the branch `<new_branch>` and start it at `<start_point>`; |
| 153 | if it already exists, then reset it to `<start_point>`. This is |
Tay Ray Chuan | 02ac983 | 2010-06-24 03:29:00 +0800 | [diff] [blame] | 154 | equivalent to running "git branch" with "-f"; see |
| 155 | linkgit:git-branch[1] for details. |
| 156 | |
Stephan Beyer | 3240240 | 2008-06-08 03:36:09 +0200 | [diff] [blame] | 157 | -t:: |
| 158 | --track:: |
Jeff King | 26d22dc | 2009-04-13 07:18:52 -0400 | [diff] [blame] | 159 | When creating a new branch, set up "upstream" configuration. See |
| 160 | "--track" in linkgit:git-branch[1] for details. |
Johannes Schindelin | bb0ceb6 | 2008-08-09 16:00:12 +0200 | [diff] [blame] | 161 | + |
Matthieu Moy | 23f8239 | 2016-06-28 13:40:10 +0200 | [diff] [blame] | 162 | If no `-b` option is given, the name of the new branch will be |
Johan Herland | fa83a33 | 2013-04-21 23:52:01 +0200 | [diff] [blame] | 163 | derived from the remote-tracking branch, by looking at the local part of |
| 164 | the refspec configured for the corresponding remote, and then stripping |
| 165 | the initial part up to the "*". |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 166 | This would tell us to use `hack` as the local branch when branching |
| 167 | off of `origin/hack` (or `remotes/origin/hack`, or even |
| 168 | `refs/remotes/origin/hack`). If the given name has no slash, or the above |
Alex Riesen | 9188ed8 | 2008-08-21 19:23:20 +0200 | [diff] [blame] | 169 | guessing results in an empty name, the guessing is aborted. You can |
Matthieu Moy | 23f8239 | 2016-06-28 13:40:10 +0200 | [diff] [blame] | 170 | explicitly give a name with `-b` in such a case. |
Paolo Bonzini | 0746d19 | 2007-03-08 10:58:35 +0100 | [diff] [blame] | 171 | |
| 172 | --no-track:: |
Jeff King | 167d744 | 2009-04-13 07:11:56 -0400 | [diff] [blame] | 173 | Do not set up "upstream" configuration, even if the |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 174 | `branch.autoSetupMerge` configuration variable is true. |
Paolo Bonzini | 0746d19 | 2007-03-08 10:58:35 +0100 | [diff] [blame] | 175 | |
Nguyễn Thái Ngọc Duy | ccb111b | 2019-03-29 17:39:13 +0700 | [diff] [blame] | 176 | --guess:: |
| 177 | --no-guess:: |
| 178 | If `<branch>` is not found but there does exist a tracking |
| 179 | branch in exactly one remote (call it `<remote>`) with a |
| 180 | matching name, treat as equivalent to |
| 181 | + |
| 182 | ------------ |
| 183 | $ git checkout -b <branch> --track <remote>/<branch> |
| 184 | ------------ |
| 185 | + |
| 186 | If the branch exists in multiple remotes and one of them is named by |
| 187 | the `checkout.defaultRemote` configuration variable, we'll use that |
| 188 | one for the purposes of disambiguation, even if the `<branch>` isn't |
| 189 | unique across all remotes. Set it to |
| 190 | e.g. `checkout.defaultRemote=origin` to always checkout remote |
| 191 | branches from there if `<branch>` is ambiguous but exists on the |
| 192 | 'origin' remote. See also `checkout.defaultRemote` in |
| 193 | linkgit:git-config[1]. |
| 194 | + |
Denton Liu | 64f1f58 | 2020-10-07 22:48:15 -0700 | [diff] [blame] | 195 | `--guess` is the default behavior. Use `--no-guess` to disable it. |
| 196 | + |
| 197 | The default behavior can be set via the `checkout.guess` configuration |
| 198 | variable. |
Paolo Bonzini | 0746d19 | 2007-03-08 10:58:35 +0100 | [diff] [blame] | 199 | |
Shawn Pearce | 969d326 | 2006-05-19 05:17:16 -0400 | [diff] [blame] | 200 | -l:: |
Jeff King | 26d22dc | 2009-04-13 07:18:52 -0400 | [diff] [blame] | 201 | Create the new branch's reflog; see linkgit:git-branch[1] for |
| 202 | details. |
Shawn Pearce | 969d326 | 2006-05-19 05:17:16 -0400 | [diff] [blame] | 203 | |
Eric Sunshine | 07351d9 | 2020-09-06 20:02:20 -0400 | [diff] [blame] | 204 | -d:: |
Junio C Hamano | 3266967 | 2011-02-08 04:32:49 -0600 | [diff] [blame] | 205 | --detach:: |
| 206 | Rather than checking out a branch to work on it, check out a |
| 207 | commit for inspection and discardable experiments. |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 208 | This is the default behavior of `git checkout <commit>` when |
| 209 | `<commit>` is not a branch name. See the "DETACHED HEAD" section |
Junio C Hamano | 3266967 | 2011-02-08 04:32:49 -0600 | [diff] [blame] | 210 | below for details. |
| 211 | |
Junio C Hamano | 45aaf03 | 2012-08-26 11:40:08 -0700 | [diff] [blame] | 212 | --orphan <new_branch>:: |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 213 | Create a new 'orphan' branch, named `<new_branch>`, started from |
| 214 | `<start_point>` and switch to it. The first commit made on this |
Erick Mattos | feb98d1 | 2010-05-21 21:28:35 -0300 | [diff] [blame] | 215 | new branch will have no parents and it will be the root of a new |
| 216 | history totally disconnected from all the other branches and |
| 217 | commits. |
Erick Mattos | 9db5ebf | 2010-03-21 12:34:38 -0300 | [diff] [blame] | 218 | + |
Erick Mattos | feb98d1 | 2010-05-21 21:28:35 -0300 | [diff] [blame] | 219 | The index and the working tree are adjusted as if you had previously run |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 220 | `git checkout <start_point>`. This allows you to start a new history |
| 221 | that records a set of paths similar to `<start_point>` by easily running |
| 222 | `git commit -a` to make the root commit. |
Erick Mattos | 9db5ebf | 2010-03-21 12:34:38 -0300 | [diff] [blame] | 223 | + |
Erick Mattos | feb98d1 | 2010-05-21 21:28:35 -0300 | [diff] [blame] | 224 | This can be useful when you want to publish the tree from a commit |
| 225 | without exposing its full history. You might want to do this to publish |
| 226 | an open source branch of a project whose current tree is "clean", but |
| 227 | whose full history contains proprietary or otherwise encumbered bits of |
| 228 | code. |
| 229 | + |
| 230 | If you want to start a disconnected history that records a set of paths |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 231 | that is totally different from the one of `<start_point>`, then you should |
Erick Mattos | feb98d1 | 2010-05-21 21:28:35 -0300 | [diff] [blame] | 232 | clear the index and the working tree right after creating the orphan |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 233 | branch by running `git rm -rf .` from the top level of the working tree. |
Erick Mattos | feb98d1 | 2010-05-21 21:28:35 -0300 | [diff] [blame] | 234 | Afterwards you will be ready to prepare your new files, repopulating the |
| 235 | working tree, by copying them from elsewhere, extracting a tarball, etc. |
Erick Mattos | 9db5ebf | 2010-03-21 12:34:38 -0300 | [diff] [blame] | 236 | |
Nguyễn Thái Ngọc Duy | 08d595d | 2013-04-13 09:12:08 +1000 | [diff] [blame] | 237 | --ignore-skip-worktree-bits:: |
| 238 | In sparse checkout mode, `git checkout -- <paths>` would |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 239 | update only entries matched by `<paths>` and sparse patterns |
| 240 | in `$GIT_DIR/info/sparse-checkout`. This option ignores |
| 241 | the sparse patterns and adds back any files in `<paths>`. |
Nguyễn Thái Ngọc Duy | 08d595d | 2013-04-13 09:12:08 +1000 | [diff] [blame] | 242 | |
Junio C Hamano | 1be0659 | 2006-01-12 14:04:36 -0800 | [diff] [blame] | 243 | -m:: |
Junio C Hamano | eac5a40 | 2008-08-31 19:32:40 -0700 | [diff] [blame] | 244 | --merge:: |
Junio C Hamano | 0cf8581 | 2008-08-30 07:52:24 -0700 | [diff] [blame] | 245 | When switching branches, |
| 246 | if you have local modifications to one or more files that |
Jon Loeliger | 71bb103 | 2006-03-17 18:26:01 -0600 | [diff] [blame] | 247 | are different between the current branch and the branch to |
| 248 | which you are switching, the command refuses to switch |
| 249 | branches in order to preserve your modifications in context. |
| 250 | However, with this option, a three-way merge between the current |
Junio C Hamano | 1be0659 | 2006-01-12 14:04:36 -0800 | [diff] [blame] | 251 | branch, your working tree contents, and the new branch |
| 252 | is done, and you will be on the new branch. |
| 253 | + |
| 254 | When a merge conflict happens, the index entries for conflicting |
| 255 | paths are left unmerged, and you need to resolve the conflicts |
Shawn O. Pearce | d7f078b | 2007-02-17 04:43:42 -0500 | [diff] [blame] | 256 | and mark the resolved paths with `git add` (or `git rm` if the merge |
| 257 | should result in deletion of the path). |
Junio C Hamano | 0cf8581 | 2008-08-30 07:52:24 -0700 | [diff] [blame] | 258 | + |
| 259 | When checking out paths from the index, this option lets you recreate |
| 260 | the conflicted merge in the specified paths. |
Nguyễn Thái Ngọc Duy | a7256de | 2019-03-19 16:39:10 +0700 | [diff] [blame] | 261 | + |
| 262 | When switching branches with `--merge`, staged changes may be lost. |
Junio C Hamano | 1be0659 | 2006-01-12 14:04:36 -0800 | [diff] [blame] | 263 | |
Junio C Hamano | eac5a40 | 2008-08-31 19:32:40 -0700 | [diff] [blame] | 264 | --conflict=<style>:: |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 265 | The same as `--merge` option above, but changes the way the |
Junio C Hamano | eac5a40 | 2008-08-31 19:32:40 -0700 | [diff] [blame] | 266 | conflicting hunks are presented, overriding the |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 267 | `merge.conflictStyle` configuration variable. Possible values are |
Junio C Hamano | eac5a40 | 2008-08-31 19:32:40 -0700 | [diff] [blame] | 268 | "merge" (default) and "diff3" (in addition to what is shown by |
| 269 | "merge" style, shows the original contents). |
Junio C Hamano | 7fc9d69 | 2005-08-23 01:49:47 -0700 | [diff] [blame] | 270 | |
Thomas Rast | 4f35365 | 2009-08-15 13:48:30 +0200 | [diff] [blame] | 271 | -p:: |
| 272 | --patch:: |
| 273 | Interactively select hunks in the difference between the |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 274 | `<tree-ish>` (or the index, if unspecified) and the working |
Thomas Rast | 4f35365 | 2009-08-15 13:48:30 +0200 | [diff] [blame] | 275 | tree. The chosen hunks are then applied in reverse to the |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 276 | working tree (and if a `<tree-ish>` was specified, the index). |
Thomas Rast | 4f35365 | 2009-08-15 13:48:30 +0200 | [diff] [blame] | 277 | + |
| 278 | This means that you can use `git checkout -p` to selectively discard |
Valentin Haenel | a31538e | 2011-05-05 20:48:48 +0200 | [diff] [blame] | 279 | edits from your current working tree. See the ``Interactive Mode'' |
Jeff King | 6cf378f | 2012-04-26 04:51:57 -0400 | [diff] [blame] | 280 | section of linkgit:git-add[1] to learn how to operate the `--patch` mode. |
Thomas Gummerer | 091e04b | 2019-01-08 21:52:24 +0000 | [diff] [blame] | 281 | + |
| 282 | Note that this option uses the no overlay mode by default (see also |
Nguyễn Thái Ngọc Duy | d333f67 | 2019-03-29 17:38:53 +0700 | [diff] [blame] | 283 | `--overlay`), and currently doesn't support overlay mode. |
Thomas Rast | 4f35365 | 2009-08-15 13:48:30 +0200 | [diff] [blame] | 284 | |
Nguyễn Thái Ngọc Duy | 1d0fa89 | 2015-01-03 16:41:26 +0700 | [diff] [blame] | 285 | --ignore-other-worktrees:: |
| 286 | `git checkout` refuses when the wanted ref is already checked |
| 287 | out by another worktree. This option makes it check the ref |
| 288 | out anyway. In other words, the ref can be held by more than one |
| 289 | worktree. |
| 290 | |
Nguyễn Thái Ngọc Duy | 9d223d4 | 2019-03-29 17:38:55 +0700 | [diff] [blame] | 291 | --overwrite-ignore:: |
| 292 | --no-overwrite-ignore:: |
| 293 | Silently overwrite ignored files when switching branches. This |
| 294 | is the default behavior. Use `--no-overwrite-ignore` to abort |
| 295 | the operation when the new branch contains ignored files. |
| 296 | |
Nguyễn Thái Ngọc Duy | d333f67 | 2019-03-29 17:38:53 +0700 | [diff] [blame] | 297 | --recurse-submodules:: |
| 298 | --no-recurse-submodules:: |
Damien Robert | acbfae3 | 2020-04-06 15:57:09 +0200 | [diff] [blame] | 299 | Using `--recurse-submodules` will update the content of all active |
Stefan Beller | 1fc458d | 2017-03-14 14:46:41 -0700 | [diff] [blame] | 300 | submodules according to the commit recorded in the superproject. If |
| 301 | local modifications in a submodule would be overwritten the checkout |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 302 | will fail unless `-f` is used. If nothing (or `--no-recurse-submodules`) |
Damien Robert | b3cec57 | 2020-04-06 15:57:06 +0200 | [diff] [blame] | 303 | is used, submodules working trees will not be updated. |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 304 | Just like linkgit:git-submodule[1], this will detach `HEAD` of the |
| 305 | submodule. |
Stefan Beller | 1fc458d | 2017-03-14 14:46:41 -0700 | [diff] [blame] | 306 | |
Nguyễn Thái Ngọc Duy | d333f67 | 2019-03-29 17:38:53 +0700 | [diff] [blame] | 307 | --overlay:: |
| 308 | --no-overlay:: |
Thomas Gummerer | 091e04b | 2019-01-08 21:52:24 +0000 | [diff] [blame] | 309 | In the default overlay mode, `git checkout` never |
| 310 | removes files from the index or the working tree. When |
| 311 | specifying `--no-overlay`, files that appear in the index and |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 312 | working tree, but not in `<tree-ish>` are removed, to make them |
| 313 | match `<tree-ish>` exactly. |
Thomas Gummerer | 091e04b | 2019-01-08 21:52:24 +0000 | [diff] [blame] | 314 | |
Alexandr Miloslavskiy | a9aecc7 | 2019-12-03 14:02:18 +0000 | [diff] [blame] | 315 | --pathspec-from-file=<file>:: |
| 316 | Pathspec is passed in `<file>` instead of commandline args. If |
| 317 | `<file>` is exactly `-` then standard input is used. Pathspec |
| 318 | elements are separated by LF or CR/LF. Pathspec elements can be |
| 319 | quoted as explained for the configuration variable `core.quotePath` |
| 320 | (see linkgit:git-config[1]). See also `--pathspec-file-nul` and |
| 321 | global `--literal-pathspecs`. |
| 322 | |
| 323 | --pathspec-file-nul:: |
| 324 | Only meaningful with `--pathspec-from-file`. Pathspec elements are |
| 325 | separated with NUL character and all other characters are taken |
| 326 | literally (including newlines and quotes). |
| 327 | |
A Large Angry SCM | 0270f7c | 2005-09-07 17:17:18 -0400 | [diff] [blame] | 328 | <branch>:: |
Jeff King | 0808723 | 2009-04-13 07:21:04 -0400 | [diff] [blame] | 329 | Branch to checkout; if it refers to a branch (i.e., a name that, |
| 330 | when prepended with "refs/heads/", is a valid ref), then that |
| 331 | branch is checked out. Otherwise, if it refers to a valid |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 332 | commit, your `HEAD` becomes "detached" and you are no longer on |
Jeff King | 0808723 | 2009-04-13 07:21:04 -0400 | [diff] [blame] | 333 | any branch (see below for details). |
Thomas Rast | 696acf4 | 2009-01-17 17:09:56 +0100 | [diff] [blame] | 334 | + |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 335 | You can use the `@{-N}` syntax to refer to the N-th last |
Kaartic Sivaraam | 75ce149 | 2017-11-27 22:58:33 +0530 | [diff] [blame] | 336 | branch/commit checked out using "git checkout" operation. You may |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 337 | also specify `-` which is synonymous to `@{-1}`. |
Michael J Gruber | 873c347 | 2010-06-01 17:16:42 +0200 | [diff] [blame] | 338 | + |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 339 | As a special case, you may use `A...B` as a shortcut for the |
Michael J Gruber | 873c347 | 2010-06-01 17:16:42 +0200 | [diff] [blame] | 340 | merge base of `A` and `B` if there is exactly one merge base. You can |
| 341 | leave out at most one of `A` and `B`, in which case it defaults to `HEAD`. |
Junio C Hamano | 5e1a2e8 | 2007-01-17 10:43:50 -0800 | [diff] [blame] | 342 | |
Jeff King | 76cfadf | 2009-04-13 07:19:33 -0400 | [diff] [blame] | 343 | <new_branch>:: |
| 344 | Name for the new branch. |
| 345 | |
| 346 | <start_point>:: |
| 347 | The name of a commit at which to start the new branch; see |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 348 | linkgit:git-branch[1] for details. Defaults to `HEAD`. |
Denton Liu | e3d6539 | 2019-04-27 05:02:22 -0700 | [diff] [blame] | 349 | + |
| 350 | As a special case, you may use `"A...B"` as a shortcut for the |
| 351 | merge base of `A` and `B` if there is exactly one merge base. You can |
| 352 | leave out at most one of `A` and `B`, in which case it defaults to `HEAD`. |
Jeff King | 76cfadf | 2009-04-13 07:19:33 -0400 | [diff] [blame] | 353 | |
| 354 | <tree-ish>:: |
| 355 | Tree to checkout from (when paths are given). If not specified, |
| 356 | the index will be used. |
Denton Liu | c693ef7 | 2020-10-07 00:56:16 -0700 | [diff] [blame] | 357 | + |
| 358 | As a special case, you may use `"A...B"` as a shortcut for the |
| 359 | merge base of `A` and `B` if there is exactly one merge base. You can |
| 360 | leave out at most one of `A` and `B`, in which case it defaults to `HEAD`. |
Jeff King | 76cfadf | 2009-04-13 07:19:33 -0400 | [diff] [blame] | 361 | |
Alexandr Miloslavskiy | 8ea1189 | 2019-12-03 14:02:16 +0000 | [diff] [blame] | 362 | \--:: |
| 363 | Do not interpret any more arguments as options. |
Jeff King | 76cfadf | 2009-04-13 07:19:33 -0400 | [diff] [blame] | 364 | |
Alexandr Miloslavskiy | 8ea1189 | 2019-12-03 14:02:16 +0000 | [diff] [blame] | 365 | <pathspec>...:: |
| 366 | Limits the paths affected by the operation. |
| 367 | + |
| 368 | For more details, see the 'pathspec' entry in linkgit:gitglossary[7]. |
Junio C Hamano | 5e1a2e8 | 2007-01-17 10:43:50 -0800 | [diff] [blame] | 369 | |
Junio C Hamano | 3266967 | 2011-02-08 04:32:49 -0600 | [diff] [blame] | 370 | DETACHED HEAD |
Junio C Hamano | 5e1a2e8 | 2007-01-17 10:43:50 -0800 | [diff] [blame] | 371 | ------------- |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 372 | `HEAD` normally refers to a named branch (e.g. `master`). Meanwhile, each |
Jay Soffian | be8ef33 | 2011-02-20 00:21:50 -0500 | [diff] [blame] | 373 | branch refers to a specific commit. Let's look at a repo with three |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 374 | commits, one of them tagged, and with branch `master` checked out: |
Junio C Hamano | 5e1a2e8 | 2007-01-17 10:43:50 -0800 | [diff] [blame] | 375 | |
| 376 | ------------ |
Andreas Heiduk | 39a3682 | 2018-10-22 22:45:42 +0200 | [diff] [blame] | 377 | HEAD (refers to branch 'master') |
| 378 | | |
| 379 | v |
Jay Soffian | be8ef33 | 2011-02-20 00:21:50 -0500 | [diff] [blame] | 380 | a---b---c branch 'master' (refers to commit 'c') |
| 381 | ^ |
| 382 | | |
| 383 | tag 'v2.0' (refers to commit 'b') |
Junio C Hamano | 5e1a2e8 | 2007-01-17 10:43:50 -0800 | [diff] [blame] | 384 | ------------ |
| 385 | |
Jay Soffian | be8ef33 | 2011-02-20 00:21:50 -0500 | [diff] [blame] | 386 | When a commit is created in this state, the branch is updated to refer to |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 387 | the new commit. Specifically, 'git commit' creates a new commit `d`, whose |
| 388 | parent is commit `c`, and then updates branch `master` to refer to new |
| 389 | commit `d`. `HEAD` still refers to branch `master` and so indirectly now refers |
| 390 | to commit `d`: |
Junio C Hamano | 5e1a2e8 | 2007-01-17 10:43:50 -0800 | [diff] [blame] | 391 | |
Junio C Hamano | cec8d14 | 2007-02-13 08:58:01 -0800 | [diff] [blame] | 392 | ------------ |
Jay Soffian | be8ef33 | 2011-02-20 00:21:50 -0500 | [diff] [blame] | 393 | $ edit; git add; git commit |
| 394 | |
Andreas Heiduk | 39a3682 | 2018-10-22 22:45:42 +0200 | [diff] [blame] | 395 | HEAD (refers to branch 'master') |
| 396 | | |
| 397 | v |
Jay Soffian | be8ef33 | 2011-02-20 00:21:50 -0500 | [diff] [blame] | 398 | a---b---c---d branch 'master' (refers to commit 'd') |
| 399 | ^ |
| 400 | | |
| 401 | tag 'v2.0' (refers to commit 'b') |
| 402 | ------------ |
| 403 | |
| 404 | It is sometimes useful to be able to checkout a commit that is not at |
| 405 | the tip of any named branch, or even to create a new commit that is not |
| 406 | referenced by a named branch. Let's look at what happens when we |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 407 | checkout commit `b` (here we show two ways this may be done): |
Jay Soffian | be8ef33 | 2011-02-20 00:21:50 -0500 | [diff] [blame] | 408 | |
| 409 | ------------ |
| 410 | $ git checkout v2.0 # or |
| 411 | $ git checkout master^^ |
| 412 | |
| 413 | HEAD (refers to commit 'b') |
| 414 | | |
| 415 | v |
| 416 | a---b---c---d branch 'master' (refers to commit 'd') |
| 417 | ^ |
| 418 | | |
| 419 | tag 'v2.0' (refers to commit 'b') |
| 420 | ------------ |
| 421 | |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 422 | Notice that regardless of which checkout command we use, `HEAD` now refers |
| 423 | directly to commit `b`. This is known as being in detached `HEAD` state. |
| 424 | It means simply that `HEAD` refers to a specific commit, as opposed to |
Jay Soffian | be8ef33 | 2011-02-20 00:21:50 -0500 | [diff] [blame] | 425 | referring to a named branch. Let's see what happens when we create a commit: |
| 426 | |
| 427 | ------------ |
| 428 | $ edit; git add; git commit |
| 429 | |
| 430 | HEAD (refers to commit 'e') |
| 431 | | |
| 432 | v |
| 433 | e |
| 434 | / |
| 435 | a---b---c---d branch 'master' (refers to commit 'd') |
| 436 | ^ |
| 437 | | |
| 438 | tag 'v2.0' (refers to commit 'b') |
| 439 | ------------ |
| 440 | |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 441 | There is now a new commit `e`, but it is referenced only by `HEAD`. We can |
Jay Soffian | be8ef33 | 2011-02-20 00:21:50 -0500 | [diff] [blame] | 442 | of course add yet another commit in this state: |
| 443 | |
| 444 | ------------ |
| 445 | $ edit; git add; git commit |
| 446 | |
| 447 | HEAD (refers to commit 'f') |
| 448 | | |
| 449 | v |
| 450 | e---f |
| 451 | / |
| 452 | a---b---c---d branch 'master' (refers to commit 'd') |
| 453 | ^ |
| 454 | | |
| 455 | tag 'v2.0' (refers to commit 'b') |
| 456 | ------------ |
| 457 | |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 458 | In fact, we can perform all the normal Git operations. But, let's look |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 459 | at what happens when we then checkout `master`: |
Jay Soffian | be8ef33 | 2011-02-20 00:21:50 -0500 | [diff] [blame] | 460 | |
| 461 | ------------ |
| 462 | $ git checkout master |
| 463 | |
Andreas Heiduk | 39a3682 | 2018-10-22 22:45:42 +0200 | [diff] [blame] | 464 | HEAD (refers to branch 'master') |
Jay Soffian | be8ef33 | 2011-02-20 00:21:50 -0500 | [diff] [blame] | 465 | e---f | |
| 466 | / v |
| 467 | a---b---c---d branch 'master' (refers to commit 'd') |
| 468 | ^ |
| 469 | | |
| 470 | tag 'v2.0' (refers to commit 'b') |
| 471 | ------------ |
| 472 | |
| 473 | It is important to realize that at this point nothing refers to commit |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 474 | `f`. Eventually commit `f` (and by extension commit `e`) will be deleted |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 475 | by the routine Git garbage collection process, unless we create a reference |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 476 | before that happens. If we have not yet moved away from commit `f`, |
Jay Soffian | be8ef33 | 2011-02-20 00:21:50 -0500 | [diff] [blame] | 477 | any of these will create a reference to it: |
| 478 | |
| 479 | ------------ |
| 480 | $ git checkout -b foo <1> |
| 481 | $ git branch foo <2> |
| 482 | $ git tag foo <3> |
| 483 | ------------ |
| 484 | |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 485 | <1> creates a new branch `foo`, which refers to commit `f`, and then |
| 486 | updates `HEAD` to refer to branch `foo`. In other words, we'll no longer |
| 487 | be in detached `HEAD` state after this command. |
Jay Soffian | be8ef33 | 2011-02-20 00:21:50 -0500 | [diff] [blame] | 488 | |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 489 | <2> similarly creates a new branch `foo`, which refers to commit `f`, |
| 490 | but leaves `HEAD` detached. |
Jay Soffian | be8ef33 | 2011-02-20 00:21:50 -0500 | [diff] [blame] | 491 | |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 492 | <3> creates a new tag `foo`, which refers to commit `f`, |
| 493 | leaving `HEAD` detached. |
Jay Soffian | be8ef33 | 2011-02-20 00:21:50 -0500 | [diff] [blame] | 494 | |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 495 | If we have moved away from commit `f`, then we must first recover its object |
Jay Soffian | be8ef33 | 2011-02-20 00:21:50 -0500 | [diff] [blame] | 496 | name (typically by using git reflog), and then we can create a reference to |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 497 | it. For example, to see the last two commits to which `HEAD` referred, we |
Jay Soffian | be8ef33 | 2011-02-20 00:21:50 -0500 | [diff] [blame] | 498 | can use either of these commands: |
| 499 | |
| 500 | ------------ |
| 501 | $ git reflog -2 HEAD # or |
Junio C Hamano | cec8d14 | 2007-02-13 08:58:01 -0800 | [diff] [blame] | 502 | $ git log -g -2 HEAD |
| 503 | ------------ |
Junio C Hamano | 7fc9d69 | 2005-08-23 01:49:47 -0700 | [diff] [blame] | 504 | |
Nguyễn Thái Ngọc Duy | 19e5656 | 2016-09-07 18:19:40 +0700 | [diff] [blame] | 505 | ARGUMENT DISAMBIGUATION |
| 506 | ----------------------- |
| 507 | |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 508 | When there is only one argument given and it is not `--` (e.g. `git |
| 509 | checkout abc`), and when the argument is both a valid `<tree-ish>` |
| 510 | (e.g. a branch `abc` exists) and a valid `<pathspec>` (e.g. a file |
Nguyễn Thái Ngọc Duy | 19e5656 | 2016-09-07 18:19:40 +0700 | [diff] [blame] | 511 | or a directory whose name is "abc" exists), Git would usually ask |
| 512 | you to disambiguate. Because checking out a branch is so common an |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 513 | operation, however, `git checkout abc` takes "abc" as a `<tree-ish>` |
Nguyễn Thái Ngọc Duy | 19e5656 | 2016-09-07 18:19:40 +0700 | [diff] [blame] | 514 | in such a situation. Use `git checkout -- <pathspec>` if you want |
| 515 | to checkout these paths out of the index. |
| 516 | |
Junio C Hamano | 1be0659 | 2006-01-12 14:04:36 -0800 | [diff] [blame] | 517 | EXAMPLES |
| 518 | -------- |
Junio C Hamano | 4aaa702 | 2005-10-18 01:29:27 -0700 | [diff] [blame] | 519 | |
Junio C Hamano | 1be0659 | 2006-01-12 14:04:36 -0800 | [diff] [blame] | 520 | . The following sequence checks out the `master` branch, reverts |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 521 | the `Makefile` to two revisions back, deletes `hello.c` by |
Jean-Noël Avila | ba17051 | 2019-01-22 21:16:35 +0100 | [diff] [blame] | 522 | mistake, and gets it back from the index. |
Junio C Hamano | 1be0659 | 2006-01-12 14:04:36 -0800 | [diff] [blame] | 523 | + |
Junio C Hamano | 4aaa702 | 2005-10-18 01:29:27 -0700 | [diff] [blame] | 524 | ------------ |
Sean Estabrooks | 48aeecd | 2006-04-28 09:15:05 -0400 | [diff] [blame] | 525 | $ git checkout master <1> |
| 526 | $ git checkout master~2 Makefile <2> |
Junio C Hamano | 4aaa702 | 2005-10-18 01:29:27 -0700 | [diff] [blame] | 527 | $ rm -f hello.c |
Sean Estabrooks | 48aeecd | 2006-04-28 09:15:05 -0400 | [diff] [blame] | 528 | $ git checkout hello.c <3> |
Junio C Hamano | 4aaa702 | 2005-10-18 01:29:27 -0700 | [diff] [blame] | 529 | ------------ |
Junio C Hamano | 1be0659 | 2006-01-12 14:04:36 -0800 | [diff] [blame] | 530 | + |
Sean Estabrooks | 48aeecd | 2006-04-28 09:15:05 -0400 | [diff] [blame] | 531 | <1> switch branch |
Michael J Gruber | c7cb12b | 2009-03-10 16:06:30 +0100 | [diff] [blame] | 532 | <2> take a file out of another commit |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 533 | <3> restore `hello.c` from the index |
Sean Estabrooks | 48aeecd | 2006-04-28 09:15:05 -0400 | [diff] [blame] | 534 | + |
Junio C Hamano | caae319 | 2012-09-04 08:28:27 -0700 | [diff] [blame] | 535 | If you want to check out _all_ C source files out of the index, |
| 536 | you can say |
| 537 | + |
| 538 | ------------ |
| 539 | $ git checkout -- '*.c' |
| 540 | ------------ |
| 541 | + |
| 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). |
| 546 | + |
Sean Estabrooks | 48aeecd | 2006-04-28 09:15:05 -0400 | [diff] [blame] | 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: |
Junio C Hamano | 1be0659 | 2006-01-12 14:04:36 -0800 | [diff] [blame] | 550 | + |
Junio C Hamano | 4aaa702 | 2005-10-18 01:29:27 -0700 | [diff] [blame] | 551 | ------------ |
| 552 | $ git checkout -- hello.c |
| 553 | ------------ |
| 554 | |
Michael J Gruber | c7cb12b | 2009-03-10 16:06:30 +0100 | [diff] [blame] | 555 | . After working in the wrong branch, switching to the correct |
Jean-Noël Avila | ba17051 | 2019-01-22 21:16:35 +0100 | [diff] [blame] | 556 | branch would be done using: |
Junio C Hamano | 1be0659 | 2006-01-12 14:04:36 -0800 | [diff] [blame] | 557 | + |
| 558 | ------------ |
| 559 | $ git checkout mytopic |
| 560 | ------------ |
| 561 | + |
Nguyễn Thái Ngọc Duy | 181e372 | 2019-03-29 17:38:56 +0700 | [diff] [blame] | 562 | However, your "wrong" branch and correct `mytopic` branch may |
Michael J Gruber | c7cb12b | 2009-03-10 16:06:30 +0100 | [diff] [blame] | 563 | differ in files that you have modified locally, in which case |
Junio C Hamano | 1be0659 | 2006-01-12 14:04:36 -0800 | [diff] [blame] | 564 | the above checkout would fail like this: |
| 565 | + |
| 566 | ------------ |
| 567 | $ git checkout mytopic |
Nicolas Sebrecht | 142183d | 2010-07-09 22:27:48 +0200 | [diff] [blame] | 568 | error: You have local changes to 'frotz'; not switching branches. |
Junio C Hamano | 1be0659 | 2006-01-12 14:04:36 -0800 | [diff] [blame] | 569 | ------------ |
| 570 | + |
| 571 | You can give the `-m` flag to the command, which would try a |
| 572 | three-way merge: |
| 573 | + |
| 574 | ------------ |
| 575 | $ git checkout -m mytopic |
| 576 | Auto-merging frotz |
| 577 | ------------ |
| 578 | + |
| 579 | After this three-way merge, the local modifications are _not_ |
| 580 | registered in your index file, so `git diff` would show you what |
| 581 | changes you made since the tip of the new branch. |
| 582 | |
| 583 | . When a merge conflict happens during switching branches with |
Jean-Noël Avila | ba17051 | 2019-01-22 21:16:35 +0100 | [diff] [blame] | 584 | the `-m` option, you would see something like this: |
Junio C Hamano | 1be0659 | 2006-01-12 14:04:36 -0800 | [diff] [blame] | 585 | + |
| 586 | ------------ |
| 587 | $ git checkout -m mytopic |
| 588 | Auto-merging frotz |
Junio C Hamano | 1be0659 | 2006-01-12 14:04:36 -0800 | [diff] [blame] | 589 | ERROR: Merge conflict in frotz |
| 590 | fatal: merge program failed |
| 591 | ------------ |
| 592 | + |
| 593 | At this point, `git diff` shows the changes cleanly merged as in |
| 594 | the previous example, as well as the changes in the conflicted |
| 595 | files. Edit and resolve the conflict and mark it resolved with |
Shawn O. Pearce | d7f078b | 2007-02-17 04:43:42 -0500 | [diff] [blame] | 596 | `git add` as usual: |
Junio C Hamano | 1be0659 | 2006-01-12 14:04:36 -0800 | [diff] [blame] | 597 | + |
| 598 | ------------ |
| 599 | $ edit frotz |
Shawn O. Pearce | d7f078b | 2007-02-17 04:43:42 -0500 | [diff] [blame] | 600 | $ git add frotz |
Junio C Hamano | 1be0659 | 2006-01-12 14:04:36 -0800 | [diff] [blame] | 601 | ------------ |
| 602 | |
Nguyễn Thái Ngọc Duy | d787d31 | 2019-03-29 17:39:05 +0700 | [diff] [blame] | 603 | SEE ALSO |
| 604 | -------- |
Nguyễn Thái Ngọc Duy | 46e91b6 | 2019-04-25 16:45:45 +0700 | [diff] [blame] | 605 | linkgit:git-switch[1], |
| 606 | linkgit:git-restore[1] |
Nguyễn Thái Ngọc Duy | d787d31 | 2019-03-29 17:39:05 +0700 | [diff] [blame] | 607 | |
Junio C Hamano | 7fc9d69 | 2005-08-23 01:49:47 -0700 | [diff] [blame] | 608 | GIT |
| 609 | --- |
Christian Couder | 9e1f0a8 | 2008-06-06 09:07:32 +0200 | [diff] [blame] | 610 | Part of the linkgit:git[1] suite |