man1/git-checkout.1

   1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
   2 .de Sh \" Subsection
   3 .br
   4 .if t .Sp
   5 .ne 5
   6 .PP
   7 \fB\\$1\fR
   8 .PP
   9 ..
  10 .de Sp \" Vertical space (when we can't use .PP)
  11 .if t .sp .5v
  12 .if n .sp
  13 ..
  14 .de Ip \" List item
  15 .br
  16 .ie \\n(.$>=3 .ne \\$3
  17 .el .ne 3
  18 .IP "\\$1" \\$2
  19 ..
  20 .TH "GIT-CHECKOUT" 1 "" "" ""
  21 .SH NAME
  22 git-checkout \- Checkout and switch to a branch
  23 .SH "SYNOPSIS"
  24
  25 .nf
  26 \fIgit\-checkout\fR [\-f] [\-b <new_branch>] [\-m] [<branch>]
  27 \fIgit\-checkout\fR [\-m] [<branch>] <paths>...
  28 .fi
  29
  30 .SH "DESCRIPTION"
  31
  32
  33 When <paths> are not given, this command switches branches by updating the index and working tree to reflect the specified branch, <branch>, and updating HEAD to be <branch> or, if specified, <new_branch>\&. Using \-b will cause <new_branch> to be created\&.
  34
  35
  36 When <paths> are given, this command does \fInot\fR switch branches\&. It updates the named paths in the working tree from the index file (i\&.e\&. it runs git\-checkout\-index \-f \-u)\&. In this case, \-f and \-b options are meaningless and giving either of them results in an error\&. <branch> argument can be used to specify a specific tree\-ish to update the index for the given paths before updating the working tree\&.
  37
  38 .SH "OPTIONS"
  39
  40 .TP
  41 \-f
  42 Force a re\-read of everything\&.
  43
  44 .TP
  45 \-b
  46 Create a new branch named <new_branch> and start it at <branch>\&. The new branch name must pass all checks defined by \fBgit\-check\-ref\-format\fR(1)\&. Some of these checks may restrict the characters allowed in a branch name\&.
  47
  48 .TP
  49 \-m
  50 If you have local modifications to one or more files that are different between the current branch and the branch to which you are switching, the command refuses to switch branches in order to preserve your modifications in context\&. However, with this option, a three\-way merge between the current branch, your working tree contents, and the new branch is done, and you will be on the new branch\&.
  51
  52 When a merge conflict happens, the index entries for conflicting paths are left unmerged, and you need to resolve the conflicts and mark the resolved paths with git update\-index\&.
  53
  54 .TP
  55 <new_branch>
  56 Name for the new branch\&.
  57
  58 .TP
  59 <branch>
  60 Branch to checkout; may be any object ID that resolves to a commit\&. Defaults to HEAD\&.
  61
  62 .SH "EXAMPLES"
  63
  64 .TP 3
  65 1.
  66 The following sequence checks out the master branch, reverts the Makefile to two revisions back, deletes hello\&.c by mistake, and gets it back from the index\&.
  67
  68 .nf
  69 $ git checkout master             \fB(1)\fR
  70 $ git checkout master~2 Makefile  \fB(2)\fR
  71 $ rm \-f hello\&.c
  72 $ git checkout hello\&.c            \fB(3)\fR
  73 .fi
  74 .sp
  75 \fB1. \fRswitch branch
  76 .br
  77 \fB2. \fRtake out a file out of other commit
  78 .br
  79 \fB3. \fRrestore hello\&.c from HEAD of current branch
  80
  81 If you have an unfortunate branch that is named hello\&.c, this step would be confused as an instruction to switch to that branch\&. You should instead write:
  82
  83 .nf
  84 $ git checkout \-\- hello\&.c
  85 .fi
  86 .br
  87
  88 .TP
  89 2.
  90 After working in a wrong branch, switching to the correct branch would be done using:
  91
  92
  93 .nf
  94 $ git checkout mytopic
  95 .fi
  96 However, your "wrong" branch and correct "mytopic" branch may differ in files that you have locally modified, in which case, the above checkout would fail like this:
  97
  98
  99 .nf
 100 $ git checkout mytopic
 101 fatal: Entry 'frotz' not uptodate\&. Cannot merge\&.
 102 .fi
 103 You can give the \-m flag to the command, which would try a three\-way merge:
 104
 105
 106 .nf
 107 $ git checkout \-m mytopic
 108 Auto\-merging frotz
 109 .fi
 110 After this three\-way merge, the local modifications are _not_ registered in your index file, so git diff would show you what changes you made since the tip of the new branch\&.
 111 .TP
 112 3.
 113 When a merge conflict happens during switching branches with the \-m option, you would see something like this:
 114
 115
 116 .nf
 117 $ git checkout \-m mytopic
 118 Auto\-merging frotz
 119 merge: warning: conflicts during merge
 120 ERROR: Merge conflict in frotz
 121 fatal: merge program failed
 122 .fi
 123 At this point, git diff shows the changes cleanly merged as in the previous example, as well as the changes in the conflicted files\&. Edit and resolve the conflict and mark it resolved with git update\-index as usual:
 124
 125 .nf
 126 $ edit frotz
 127 $ git update\-index frotz
 128 .fi
 129 .LP
 130
 131 .SH "AUTHOR"
 132
 133
 134 Written by Linus Torvalds <torvalds@osdl\&.org>
 135
 136 .SH "DOCUMENTATION"
 137
 138
 139 Documentation by Junio C Hamano and the git\-list <git@vger\&.kernel\&.org>\&.
 140
 141 .SH "GIT"
 142
 143
 144 Part of the \fBgit\fR(7) suite
 145