Documentation/git-checkout.txt

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