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