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] [[--track | --no-track] -b <new_branch> [-l]] [-m] [<branch>]
  12 'git checkout' [<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 When <paths> are given, this command does *not* switch
  25 branches.  It updates the named paths in the working tree from
  26 the index file (i.e. it runs `git checkout-index -f -u`), or
  27 from a named commit.  In
  28 this case, the `-f` and `-b` options are meaningless and giving
  29 either of them results in an error.  <tree-ish> argument can be
  30 used to specify a specific tree-ish (i.e. commit, tag or tree)
  31 to update the index for the given paths before updating the
  32 working tree.
  33
  34
  35 OPTIONS
  36 -------
  37 -q::
  38         Quiet, suppress feedback messages.
  39
  40 -f::
  41         Proceed even if the index or the working tree differs
  42         from HEAD.  This is used to throw away local changes.
  43
  44 -b::
  45         Create a new branch named <new_branch> and start it at
  46         <branch>.  The new branch name must pass all checks defined
  47         by linkgit:git-check-ref-format[1].  Some of these checks
  48         may restrict the characters allowed in a branch name.
  49
  50 -t::
  51 --track::
  52         When creating a new branch, set up configuration so that 'git-pull'
  53         will automatically retrieve data from the start point, which must be
  54         a branch. Use this if you always pull from the same upstream branch
  55         into the new branch, and if you don't want to use "git pull
  56         <repository> <refspec>" explicitly. This behavior is the default
  57         when the start point is a remote branch. Set the
  58         branch.autosetupmerge configuration variable to `false` if you want
  59         'git-checkout' and 'git-branch' to always behave as if '--no-track' were
  60         given. Set it to `always` if you want this behavior when the
  61         start-point is either a local or remote branch.
  62
  63 --no-track::
  64         Ignore the branch.autosetupmerge configuration variable.
  65
  66 -l::
  67         Create the new branch's reflog.  This activates recording of
  68         all changes made to the branch ref, enabling use of date
  69         based sha1 expressions such as "<branchname>@\{yesterday}".
  70
  71 -m::
  72         If you have local modifications to one or more files that
  73         are different between the current branch and the branch to
  74         which you are switching, the command refuses to switch
  75         branches in order to preserve your modifications in context.
  76         However, with this option, a three-way merge between the current
  77         branch, your working tree contents, and the new branch
  78         is done, and you will be on the new branch.
  79 +
  80 When a merge conflict happens, the index entries for conflicting
  81 paths are left unmerged, and you need to resolve the conflicts
  82 and mark the resolved paths with `git add` (or `git rm` if the merge
  83 should result in deletion of the path).
  84
  85 <new_branch>::
  86         Name for the new branch.
  87
  88 <tree-ish>::
  89         Tree to checkout from (when paths are given). If not specified,
  90         the index will be used.
  91
  92 <branch>::
  93         Branch to checkout (when no paths are given); may be any object
  94         ID that resolves to a commit.  Defaults to HEAD.
  95 +
  96 When this parameter names a non-branch (but still a valid commit object),
  97 your HEAD becomes 'detached'.
  98
  99
 100 Detached HEAD
 101 -------------
 102
 103 It is sometimes useful to be able to 'checkout' a commit that is
 104 not at the tip of one of your branches.  The most obvious
 105 example is to check out the commit at a tagged official release
 106 point, like this:
 107
 108 ------------
 109 $ git checkout v2.6.18
 110 ------------
 111
 112 Earlier versions of git did not allow this and asked you to
 113 create a temporary branch using `-b` option, but starting from
 114 version 1.5.0, the above command 'detaches' your HEAD from the
 115 current branch and directly point at the commit named by the tag
 116 (`v2.6.18` in the above example).
 117
 118 You can use usual git commands while in this state.  You can use
 119 `git reset --hard $othercommit` to further move around, for
 120 example.  You can make changes and create a new commit on top of
 121 a detached HEAD.  You can even create a merge by using `git
 122 merge $othercommit`.
 123
 124 The state you are in while your HEAD is detached is not recorded
 125 by any branch (which is natural --- you are not on any branch).
 126 What this means is that you can discard your temporary commits
 127 and merges by switching back to an existing branch (e.g. `git
 128 checkout master`), and a later `git prune` or `git gc` would
 129 garbage-collect them.  If you did this by mistake, you can ask
 130 the reflog for HEAD where you were, e.g.
 131
 132 ------------
 133 $ git log -g -2 HEAD
 134 ------------
 135
 136
 137 EXAMPLES
 138 --------
 139
 140 . The following sequence checks out the `master` branch, reverts
 141 the `Makefile` to two revisions back, deletes hello.c by
 142 mistake, and gets it back from the index.
 143 +
 144 ------------
 145 $ git checkout master             <1>
 146 $ git checkout master~2 Makefile  <2>
 147 $ rm -f hello.c
 148 $ git checkout hello.c            <3>
 149 ------------
 150 +
 151 <1> switch branch
 152 <2> take a file out of another commit
 153 <3> restore hello.c from the index
 154 +
 155 If you have an unfortunate branch that is named `hello.c`, this
 156 step would be confused as an instruction to switch to that branch.
 157 You should instead write:
 158 +
 159 ------------
 160 $ git checkout -- hello.c
 161 ------------
 162
 163 . After working in a wrong branch, switching to the correct
 164 branch would be done using:
 165 +
 166 ------------
 167 $ git checkout mytopic
 168 ------------
 169 +
 170 However, your "wrong" branch and correct "mytopic" branch may
 171 differ in files that you have locally modified, in which case,
 172 the above checkout would fail like this:
 173 +
 174 ------------
 175 $ git checkout mytopic
 176 fatal: Entry 'frotz' not uptodate. Cannot merge.
 177 ------------
 178 +
 179 You can give the `-m` flag to the command, which would try a
 180 three-way merge:
 181 +
 182 ------------
 183 $ git checkout -m mytopic
 184 Auto-merging frotz
 185 ------------
 186 +
 187 After this three-way merge, the local modifications are _not_
 188 registered in your index file, so `git diff` would show you what
 189 changes you made since the tip of the new branch.
 190
 191 . When a merge conflict happens during switching branches with
 192 the `-m` option, you would see something like this:
 193 +
 194 ------------
 195 $ git checkout -m mytopic
 196 Auto-merging frotz
 197 merge: warning: conflicts during merge
 198 ERROR: Merge conflict in frotz
 199 fatal: merge program failed
 200 ------------
 201 +
 202 At this point, `git diff` shows the changes cleanly merged as in
 203 the previous example, as well as the changes in the conflicted
 204 files.  Edit and resolve the conflict and mark it resolved with
 205 `git add` as usual:
 206 +
 207 ------------
 208 $ edit frotz
 209 $ git add frotz
 210 ------------
 211
 212
 213 Author
 214 ------
 215 Written by Linus Torvalds <torvalds@osdl.org>
 216
 217 Documentation
 218 --------------
 219 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 220
 221 GIT
 222 ---
 223 Part of the linkgit:git[1] suite