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