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' [-f] [-b <new_branch>] [-m] [<branch>]
  12 'git-checkout' [-m] [<branch>] <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.
  22
  23 When <paths> are given, this command does *not* switch
  24 branches.  It updates the named paths in the working tree from
  25 the index file (i.e. it runs `git-checkout-index -f -u`).  In
  26 this case, `-f` and `-b` options are meaningless and giving
  27 either of them results in an error.  <branch> argument can be
  28 used to specify a specific tree-ish to update the index for the
  29 given paths before updating the working tree.
  30
  31
  32 OPTIONS
  33 -------
  34 -f::
  35         Force a re-read of everything.
  36
  37 -b::
  38         Create a new branch and start it at <branch>.
  39
  40 -m::
  41         If you have local modifications to one or more files that
  42         are different between the current branch and the branch to
  43         which you are switching, the command refuses to switch
  44         branches in order to preserve your modifications in context.
  45         However, with this option, a three-way merge between the current
  46         branch, your working tree contents, and the new branch
  47         is done, and you will be on the new branch.
  48 +
  49 When a merge conflict happens, the index entries for conflicting
  50 paths are left unmerged, and you need to resolve the conflicts
  51 and mark the resolved paths with `git update-index`.
  52
  53 <new_branch>::
  54         Name for the new branch.
  55
  56 <branch>::
  57         Branch to checkout; may be any object ID that resolves to a
  58         commit. Defaults to HEAD.
  59
  60
  61 EXAMPLES
  62 --------
  63
  64 . The following sequence checks out the `master` branch, reverts
  65 the `Makefile` to two revisions back, deletes hello.c by
  66 mistake, and gets it back from the index.
  67 +
  68 ------------
  69 $ git checkout master             <1>
  70 $ git checkout master~2 Makefile  <2>
  71 $ rm -f hello.c
  72 $ git checkout hello.c            <3>
  73 ------------
  74 +
  75 <1> switch branch
  76 <2> take out a file out of other commit
  77 <3> restore hello.c from HEAD of current branch
  78 +
  79 If you have an unfortunate branch that is named `hello.c`, this
  80 step would be confused as an instruction to switch to that branch.
  81 You should instead write:
  82 +
  83 ------------
  84 $ git checkout -- hello.c
  85 ------------
  86
  87 . After working in a wrong branch, switching to the correct
  88 branch would be done using:
  89 +
  90 ------------
  91 $ git checkout mytopic
  92 ------------
  93 +
  94 However, your "wrong" branch and correct "mytopic" branch may
  95 differ in files that you have locally modified, in which case,
  96 the above checkout would fail like this:
  97 +
  98 ------------
  99 $ git checkout mytopic
 100 fatal: Entry 'frotz' not uptodate. Cannot merge.
 101 ------------
 102 +
 103 You can give the `-m` flag to the command, which would try a
 104 three-way merge:
 105 +
 106 ------------
 107 $ git checkout -m mytopic
 108 Auto-merging frotz
 109 ------------
 110 +
 111 After this three-way merge, the local modifications are _not_
 112 registered in your index file, so `git diff` would show you what
 113 changes you made since the tip of the new branch.
 114
 115 . When a merge conflict happens during switching branches with
 116 the `-m` option, you would see something like this:
 117 +
 118 ------------
 119 $ git checkout -m mytopic
 120 Auto-merging frotz
 121 merge: warning: conflicts during merge
 122 ERROR: Merge conflict in frotz
 123 fatal: merge program failed
 124 ------------
 125 +
 126 At this point, `git diff` shows the changes cleanly merged as in
 127 the previous example, as well as the changes in the conflicted
 128 files.  Edit and resolve the conflict and mark it resolved with
 129 `git update-index` as usual:
 130 +
 131 ------------
 132 $ edit frotz
 133 $ git update-index frotz
 134 ------------
 135
 136
 137 Author
 138 ------
 139 Written by Linus Torvalds <torvalds@osdl.org>
 140
 141 Documentation
 142 --------------
 143 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 144
 145 GIT
 146 ---
 147 Part of the gitlink:git[7] suite
 148