]>
Commit | Line | Data |
---|---|---|
215a7ad1 JH |
1 | git-checkout(1) |
2 | =============== | |
7fc9d69f JH |
3 | |
4 | NAME | |
5 | ---- | |
76ce9462 | 6 | git-checkout - Checkout a branch or paths to the working tree |
7fc9d69f JH |
7 | |
8 | SYNOPSIS | |
9 | -------- | |
71bb1033 | 10 | [verse] |
b1889c36 | 11 | 'git checkout' [-q] [-f] [[--track | --no-track] -b <new_branch> [-l]] [-m] [<branch>] |
0cf8581e | 12 | 'git checkout' [-f|--ours|--theirs|-m] [<tree-ish>] [--] <paths>... |
7fc9d69f JH |
13 | |
14 | DESCRIPTION | |
15 | ----------- | |
4aaa7027 | 16 | |
71bb1033 | 17 | When <paths> are not given, this command switches branches by |
4aaa7027 JH |
18 | updating the index and working tree to reflect the specified |
19 | branch, <branch>, and updating HEAD to be <branch> or, if | |
71bb1033 | 20 | specified, <new_branch>. Using -b will cause <new_branch> to |
0746d19a PB |
21 | be created; in this case you can use the --track or --no-track |
22 | options, which will be passed to `git branch`. | |
4aaa7027 JH |
23 | |
24 | When <paths> are given, this command does *not* switch | |
25 | branches. It updates the named paths in the working tree from | |
db941099 JH |
26 | the index file, or from a named commit. In |
27 | this case, the `-b` options is meaningless and giving | |
84a978f1 JH |
28 | either of them results in an error. <tree-ish> argument can be |
29 | used to specify a specific tree-ish (i.e. commit, tag or tree) | |
30 | to update the index for the given paths before updating the | |
31 | working tree. | |
4aaa7027 | 32 | |
db941099 JH |
33 | The index may contain unmerged entries after a failed merge. By |
34 | default, if you try to check out such an entry from the index, the | |
35 | checkout operation will fail and nothing will be checked out. | |
38901a48 JH |
36 | Using -f will ignore these unmerged entries. The contents from a |
37 | specific side of the merge can be checked out of the index by | |
0cf8581e JH |
38 | using --ours or --theirs. With -m, changes made to the working tree |
39 | file can be discarded to recreate the original conflicted merge result. | |
7fc9d69f JH |
40 | |
41 | OPTIONS | |
42 | ------- | |
6124aee5 | 43 | -q:: |
2be7fcb4 | 44 | Quiet, suppress feedback messages. |
6124aee5 | 45 | |
0270f7c5 | 46 | -f:: |
db941099 JH |
47 | When switching branches, proceed even if the index or the |
48 | working tree differs from HEAD. This is used to throw away | |
49 | local changes. | |
50 | + | |
51 | When checking out paths from the index, do not fail upon unmerged | |
52 | entries; instead, unmerged entries are ignored. | |
0270f7c5 | 53 | |
38901a48 JH |
54 | --ours:: |
55 | --theirs:: | |
56 | When checking out paths from the index, check out stage #2 | |
57 | ('ours') or #3 ('theirs') for unmerged paths. | |
58 | ||
0270f7c5 | 59 | -b:: |
2b1f4247 SP |
60 | Create a new branch named <new_branch> and start it at |
61 | <branch>. The new branch name must pass all checks defined | |
5162e697 | 62 | by linkgit:git-check-ref-format[1]. Some of these checks |
2b1f4247 | 63 | may restrict the characters allowed in a branch name. |
7fc9d69f | 64 | |
3240240f SB |
65 | -t:: |
66 | --track:: | |
ba020ef5 | 67 | When creating a new branch, set up configuration so that 'git-pull' |
572fc81d JS |
68 | will automatically retrieve data from the start point, which must be |
69 | a branch. Use this if you always pull from the same upstream branch | |
70 | into the new branch, and if you don't want to use "git pull | |
71 | <repository> <refspec>" explicitly. This behavior is the default | |
72 | when the start point is a remote branch. Set the | |
73 | branch.autosetupmerge configuration variable to `false` if you want | |
ba020ef5 | 74 | 'git-checkout' and 'git-branch' to always behave as if '--no-track' were |
572fc81d JS |
75 | given. Set it to `always` if you want this behavior when the |
76 | start-point is either a local or remote branch. | |
0746d19a PB |
77 | |
78 | --no-track:: | |
572fc81d | 79 | Ignore the branch.autosetupmerge configuration variable. |
0746d19a | 80 | |
969d326d | 81 | -l:: |
792d2370 JK |
82 | Create the new branch's reflog. This activates recording of |
83 | all changes made to the branch ref, enabling use of date | |
967506bb | 84 | based sha1 expressions such as "<branchname>@\{yesterday}". |
969d326d | 85 | |
1be0659e | 86 | -m:: |
0cf8581e JH |
87 | When switching branches, |
88 | if you have local modifications to one or more files that | |
71bb1033 JL |
89 | are different between the current branch and the branch to |
90 | which you are switching, the command refuses to switch | |
91 | branches in order to preserve your modifications in context. | |
92 | However, with this option, a three-way merge between the current | |
1be0659e JH |
93 | branch, your working tree contents, and the new branch |
94 | is done, and you will be on the new branch. | |
95 | + | |
96 | When a merge conflict happens, the index entries for conflicting | |
97 | paths are left unmerged, and you need to resolve the conflicts | |
d7f078b8 SP |
98 | and mark the resolved paths with `git add` (or `git rm` if the merge |
99 | should result in deletion of the path). | |
0cf8581e JH |
100 | + |
101 | When checking out paths from the index, this option lets you recreate | |
102 | the conflicted merge in the specified paths. | |
1be0659e | 103 | |
0270f7c5 LAS |
104 | <new_branch>:: |
105 | Name for the new branch. | |
7fc9d69f | 106 | |
0270f7c5 LAS |
107 | <branch>:: |
108 | Branch to checkout; may be any object ID that resolves to a | |
5e1a2e8c JH |
109 | commit. Defaults to HEAD. |
110 | + | |
111 | When this parameter names a non-branch (but still a valid commit object), | |
112 | your HEAD becomes 'detached'. | |
113 | ||
114 | ||
115 | Detached HEAD | |
116 | ------------- | |
117 | ||
118 | It is sometimes useful to be able to 'checkout' a commit that is | |
119 | not at the tip of one of your branches. The most obvious | |
120 | example is to check out the commit at a tagged official release | |
121 | point, like this: | |
122 | ||
123 | ------------ | |
124 | $ git checkout v2.6.18 | |
125 | ------------ | |
126 | ||
127 | Earlier versions of git did not allow this and asked you to | |
128 | create a temporary branch using `-b` option, but starting from | |
129 | version 1.5.0, the above command 'detaches' your HEAD from the | |
130 | current branch and directly point at the commit named by the tag | |
131 | (`v2.6.18` in the above example). | |
132 | ||
133 | You can use usual git commands while in this state. You can use | |
b1889c36 | 134 | `git reset --hard $othercommit` to further move around, for |
5e1a2e8c JH |
135 | example. You can make changes and create a new commit on top of |
136 | a detached HEAD. You can even create a merge by using `git | |
137 | merge $othercommit`. | |
138 | ||
139 | The state you are in while your HEAD is detached is not recorded | |
140 | by any branch (which is natural --- you are not on any branch). | |
141 | What this means is that you can discard your temporary commits | |
142 | and merges by switching back to an existing branch (e.g. `git | |
143 | checkout master`), and a later `git prune` or `git gc` would | |
cec8d146 JH |
144 | garbage-collect them. If you did this by mistake, you can ask |
145 | the reflog for HEAD where you were, e.g. | |
146 | ||
147 | ------------ | |
148 | $ git log -g -2 HEAD | |
149 | ------------ | |
7fc9d69f | 150 | |
4aaa7027 | 151 | |
1be0659e JH |
152 | EXAMPLES |
153 | -------- | |
4aaa7027 | 154 | |
1be0659e | 155 | . The following sequence checks out the `master` branch, reverts |
4aaa7027 JH |
156 | the `Makefile` to two revisions back, deletes hello.c by |
157 | mistake, and gets it back from the index. | |
1be0659e | 158 | + |
4aaa7027 | 159 | ------------ |
48aeecdc SE |
160 | $ git checkout master <1> |
161 | $ git checkout master~2 Makefile <2> | |
4aaa7027 | 162 | $ rm -f hello.c |
48aeecdc SE |
163 | $ git checkout hello.c <3> |
164 | ------------ | |
165 | + | |
1e2ccd3a JH |
166 | <1> switch branch |
167 | <2> take out a file out of other commit | |
48aeecdc | 168 | <3> restore hello.c from HEAD of current branch |
1be0659e | 169 | + |
48aeecdc SE |
170 | If you have an unfortunate branch that is named `hello.c`, this |
171 | step would be confused as an instruction to switch to that branch. | |
172 | You should instead write: | |
1be0659e | 173 | + |
4aaa7027 JH |
174 | ------------ |
175 | $ git checkout -- hello.c | |
176 | ------------ | |
177 | ||
1be0659e | 178 | . After working in a wrong branch, switching to the correct |
71bb1033 | 179 | branch would be done using: |
1be0659e JH |
180 | + |
181 | ------------ | |
182 | $ git checkout mytopic | |
183 | ------------ | |
184 | + | |
185 | However, your "wrong" branch and correct "mytopic" branch may | |
186 | differ in files that you have locally modified, in which case, | |
187 | the above checkout would fail like this: | |
188 | + | |
189 | ------------ | |
190 | $ git checkout mytopic | |
191 | fatal: Entry 'frotz' not uptodate. Cannot merge. | |
192 | ------------ | |
193 | + | |
194 | You can give the `-m` flag to the command, which would try a | |
195 | three-way merge: | |
196 | + | |
197 | ------------ | |
198 | $ git checkout -m mytopic | |
199 | Auto-merging frotz | |
200 | ------------ | |
201 | + | |
202 | After this three-way merge, the local modifications are _not_ | |
203 | registered in your index file, so `git diff` would show you what | |
204 | changes you made since the tip of the new branch. | |
205 | ||
206 | . When a merge conflict happens during switching branches with | |
207 | the `-m` option, you would see something like this: | |
208 | + | |
209 | ------------ | |
210 | $ git checkout -m mytopic | |
211 | Auto-merging frotz | |
212 | merge: warning: conflicts during merge | |
213 | ERROR: Merge conflict in frotz | |
214 | fatal: merge program failed | |
215 | ------------ | |
216 | + | |
217 | At this point, `git diff` shows the changes cleanly merged as in | |
218 | the previous example, as well as the changes in the conflicted | |
219 | files. Edit and resolve the conflict and mark it resolved with | |
d7f078b8 | 220 | `git add` as usual: |
1be0659e JH |
221 | + |
222 | ------------ | |
223 | $ edit frotz | |
d7f078b8 | 224 | $ git add frotz |
1be0659e JH |
225 | ------------ |
226 | ||
4aaa7027 | 227 | |
7fc9d69f JH |
228 | Author |
229 | ------ | |
230 | Written by Linus Torvalds <torvalds@osdl.org> | |
231 | ||
232 | Documentation | |
233 | -------------- | |
234 | Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. | |
235 | ||
236 | GIT | |
237 | --- | |
9e1f0a85 | 238 | Part of the linkgit:git[1] suite |