Documentation/git-checkout.txt

   1 git-checkout(1)
   2 ===============
   3
   4 NAME
   5 ----
   6 git-checkout - Checkout a branch or paths to the working tree
   7
   8 SYNOPSIS
   9 --------
  10 [verse]
  11 'git checkout' [-q] [-f] [-t | --track | --no-track] [-b <new_branch> [-l]] [-m] [<branch>]
  12 'git checkout' [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] [--] <paths>...
  13
  14 DESCRIPTION
  15 -----------
  16
  17 When <paths> are not given, this command switches branches by
  18 updating the index and working tree to reflect the specified
  19 branch, <branch>, and updating HEAD to be <branch> or, if
  20 specified, <new_branch>.  Using -b will cause <new_branch> to
  21 be created; in this case you can use the --track or --no-track
  22 options, which will be passed to `git branch`.
  23
  24 As a convenience, --track will default to creating a branch whose
  25 name is constructed from the specified branch name by stripping
  26 the first namespace level.
  27
  28 When <paths> are given, this command does *not* switch
  29 branches.  It updates the named paths in the working tree from
  30 the index file, or from a named <tree-ish> (most often a commit).  In
  31 this case, the `-b` and `--track` options are meaningless and giving
  32 either of them results in an error. The <tree-ish> argument can be
  33 used to specify a specific tree-ish (i.e. commit, tag or tree)
  34 to update the index for the given paths before updating the
  35 working tree.
  36
  37 The index may contain unmerged entries after a failed merge.  By
  38 default, if you try to check out such an entry from the index, the
  39 checkout operation will fail and nothing will be checked out.
  40 Using -f will ignore these unmerged entries.  The contents from a
  41 specific side of the merge can be checked out of the index by
  42 using --ours or --theirs.  With -m, changes made to the working tree
  43 file can be discarded to recreate the original conflicted merge result.
  44
  45 OPTIONS
  46 -------
  47 -q::
  48         Quiet, suppress feedback messages.
  49
  50 -f::
  51         When switching branches, proceed even if the index or the
  52         working tree differs from HEAD.  This is used to throw away
  53         local changes.
  54 +
  55 When checking out paths from the index, do not fail upon unmerged
  56 entries; instead, unmerged entries are ignored.
  57
  58 --ours::
  59 --theirs::
  60         When checking out paths from the index, check out stage #2
  61         ('ours') or #3 ('theirs') for unmerged paths.
  62
  63 -b::
  64         Create a new branch named <new_branch> and start it at
  65         <branch>.  The new branch name must pass all checks defined
  66         by linkgit:git-check-ref-format[1].  Some of these checks
  67         may restrict the characters allowed in a branch name.
  68
  69 -t::
  70 --track::
  71         When creating a new branch, set up configuration so that 'git-pull'
  72         will automatically retrieve data from the start point, which must be
  73         a branch. Use this if you always pull from the same upstream branch
  74         into the new branch, and if you don't want to use "git pull
  75         <repository> <refspec>" explicitly. This behavior is the default
  76         when the start point is a remote branch. Set the
  77         branch.autosetupmerge configuration variable to `false` if you want
  78         'git checkout' and 'git branch' to always behave as if '--no-track' were
  79         given. Set it to `always` if you want this behavior when the
  80         start point is either a local or remote branch.
  81 +
  82 If no '-b' option is given, the name of the new branch will be
  83 derived from the remote branch.  If "remotes/" or "refs/remotes/"
  84 is prefixed it is stripped away, and then the part up to the
  85 next slash (which would be the nickname of the remote) is removed.
  86 This would tell us to use "hack" as the local branch when branching
  87 off of "origin/hack" (or "remotes/origin/hack", or even
  88 "refs/remotes/origin/hack").  If the given name has no slash, or the above
  89 guessing results in an empty name, the guessing is aborted.  You can
  90 explicitly give a name with '-b' in such a case.
  91
  92 --no-track::
  93         Ignore the branch.autosetupmerge configuration variable.
  94
  95 -l::
  96         Create the new branch's reflog.  This activates recording of
  97         all changes made to the branch ref, enabling use of date
  98         based sha1 expressions such as "<branchname>@\{yesterday}".
  99
 100 -m::
 101 --merge::
 102         When switching branches,
 103         if you have local modifications to one or more files that
 104         are different between the current branch and the branch to
 105         which you are switching, the command refuses to switch
 106         branches in order to preserve your modifications in context.
 107         However, with this option, a three-way merge between the current
 108         branch, your working tree contents, and the new branch
 109         is done, and you will be on the new branch.
 110 +
 111 When a merge conflict happens, the index entries for conflicting
 112 paths are left unmerged, and you need to resolve the conflicts
 113 and mark the resolved paths with `git add` (or `git rm` if the merge
 114 should result in deletion of the path).
 115 +
 116 When checking out paths from the index, this option lets you recreate
 117 the conflicted merge in the specified paths.
 118
 119 --conflict=<style>::
 120         The same as --merge option above, but changes the way the
 121         conflicting hunks are presented, overriding the
 122         merge.conflictstyle configuration variable.  Possible values are
 123         "merge" (default) and "diff3" (in addition to what is shown by
 124         "merge" style, shows the original contents).
 125
 126 <new_branch>::
 127         Name for the new branch.
 128
 129 <branch>::
 130         Branch to checkout; may be any object ID that resolves to a
 131         commit.  Defaults to HEAD.
 132 +
 133 When this parameter names a non-branch (but still a valid commit object),
 134 your HEAD becomes 'detached'.
 135 +
 136 As a special case, the `"@\{-N\}"` syntax for the N-th last branch
 137 checks out the branch (instead of detaching).  You may also specify
 138 `-` which is synonymous with `"@\{-1\}"`.
 139
 140
 141 Detached HEAD
 142 -------------
 143
 144 It is sometimes useful to be able to 'checkout' a commit that is
 145 not at the tip of one of your branches.  The most obvious
 146 example is to check out the commit at a tagged official release
 147 point, like this:
 148
 149 ------------
 150 $ git checkout v2.6.18
 151 ------------
 152
 153 Earlier versions of git did not allow this and asked you to
 154 create a temporary branch using the `-b` option, but starting from
 155 version 1.5.0, the above command 'detaches' your HEAD from the
 156 current branch and directly points at the commit named by the tag
 157 (`v2.6.18` in the example above).
 158
 159 You can use all git commands while in this state.  You can use
 160 `git reset --hard $othercommit` to further move around, for
 161 example.  You can make changes and create a new commit on top of
 162 a detached HEAD.  You can even create a merge by using `git
 163 merge $othercommit`.
 164
 165 The state you are in while your HEAD is detached is not recorded
 166 by any branch (which is natural --- you are not on any branch).
 167 What this means is that you can discard your temporary commits
 168 and merges by switching back to an existing branch (e.g. `git
 169 checkout master`), and a later `git prune` or `git gc` would
 170 garbage-collect them.  If you did this by mistake, you can ask
 171 the reflog for HEAD where you were, e.g.
 172
 173 ------------
 174 $ git log -g -2 HEAD
 175 ------------
 176
 177
 178 EXAMPLES
 179 --------
 180
 181 . The following sequence checks out the `master` branch, reverts
 182 the `Makefile` to two revisions back, deletes hello.c by
 183 mistake, and gets it back from the index.
 184 +
 185 ------------
 186 $ git checkout master             <1>
 187 $ git checkout master~2 Makefile  <2>
 188 $ rm -f hello.c
 189 $ git checkout hello.c            <3>
 190 ------------
 191 +
 192 <1> switch branch
 193 <2> take a file out of another commit
 194 <3> restore hello.c from HEAD of current branch
 195 +
 196 If you have an unfortunate branch that is named `hello.c`, this
 197 step would be confused as an instruction to switch to that branch.
 198 You should instead write:
 199 +
 200 ------------
 201 $ git checkout -- hello.c
 202 ------------
 203
 204 . After working in the wrong branch, switching to the correct
 205 branch would be done using:
 206 +
 207 ------------
 208 $ git checkout mytopic
 209 ------------
 210 +
 211 However, your "wrong" branch and correct "mytopic" branch may
 212 differ in files that you have modified locally, in which case
 213 the above checkout would fail like this:
 214 +
 215 ------------
 216 $ git checkout mytopic
 217 fatal: Entry 'frotz' not uptodate. Cannot merge.
 218 ------------
 219 +
 220 You can give the `-m` flag to the command, which would try a
 221 three-way merge:
 222 +
 223 ------------
 224 $ git checkout -m mytopic
 225 Auto-merging frotz
 226 ------------
 227 +
 228 After this three-way merge, the local modifications are _not_
 229 registered in your index file, so `git diff` would show you what
 230 changes you made since the tip of the new branch.
 231
 232 . When a merge conflict happens during switching branches with
 233 the `-m` option, you would see something like this:
 234 +
 235 ------------
 236 $ git checkout -m mytopic
 237 Auto-merging frotz
 238 ERROR: Merge conflict in frotz
 239 fatal: merge program failed
 240 ------------
 241 +
 242 At this point, `git diff` shows the changes cleanly merged as in
 243 the previous example, as well as the changes in the conflicted
 244 files.  Edit and resolve the conflict and mark it resolved with
 245 `git add` as usual:
 246 +
 247 ------------
 248 $ edit frotz
 249 $ git add frotz
 250 ------------
 251
 252
 253 Author
 254 ------
 255 Written by Linus Torvalds <torvalds@osdl.org>
 256
 257 Documentation
 258 --------------
 259 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 260
 261 GIT
 262 ---
 263 Part of the linkgit:git[1] suite