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 and start it at <branch>\&.
  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
  69 .nf
  70 $ git checkout master
  71 $ git checkout master~2 Makefile
  72 $ rm \-f hello\&.c
  73 $ git checkout hello\&.c
  74
  75  switch branch
  76  take out a file out of other commit
  77  or "git checkout \-\- hello\&.c", as in the next example\&.
  78 .fi
  79 If you have an unfortunate branch that is named hello\&.c, the last step above would be confused as an instruction to switch to that branch\&. You should instead write:
  80
  81 .nf
  82 $ git checkout \-\- hello\&.c
  83 .fi
  84 .TP
  85 2.
  86 After working in a wrong branch, switching to the correct branch would be done using:
  87
  88
  89 .nf
  90 $ git checkout mytopic
  91 .fi
  92 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:
  93
  94
  95 .nf
  96 $ git checkout mytopic
  97 fatal: Entry 'frotz' not uptodate\&. Cannot merge\&.
  98 .fi
  99 You can give the \-m flag to the command, which would try a three\-way merge:
 100
 101
 102 .nf
 103 $ git checkout \-m mytopic
 104 Auto\-merging frotz
 105 .fi
 106 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\&.
 107 .TP
 108 3.
 109 When a merge conflict happens during switching branches with the \-m option, you would see something like this:
 110
 111
 112 .nf
 113 $ git checkout \-m mytopic
 114 Auto\-merging frotz
 115 merge: warning: conflicts during merge
 116 ERROR: Merge conflict in frotz
 117 fatal: merge program failed
 118 .fi
 119 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:
 120
 121 .nf
 122 $ edit frotz
 123 $ git update\-index frotz
 124 .fi
 125 .LP
 126
 127 .SH "AUTHOR"
 128
 129
 130 Written by Linus Torvalds <torvalds@osdl\&.org>
 131
 132 .SH "DOCUMENTATION"
 133
 134
 135 Documentation by Junio C Hamano and the git\-list <git@vger\&.kernel\&.org>\&.
 136
 137 .SH "GIT"
 138
 139
 140 Part of the \fBgit\fR(7) suite
 141