]>
Commit | Line | Data |
---|---|---|
215a7ad1 JH |
1 | git-rebase(1) |
2 | ============= | |
7fc9d69f JH |
3 | |
4 | NAME | |
5 | ---- | |
c3f0baac | 6 | git-rebase - Forward-port local commits to the updated upstream head |
7fc9d69f JH |
7 | |
8 | SYNOPSIS | |
9 | -------- | |
e448ff87 | 10 | [verse] |
059f446d BF |
11 | 'git-rebase' [-i | --interactive] [-v | --verbose] [-m | --merge] |
12 | [-C<n>] [ --whitespace=<option>] [-p | --preserve-merges] | |
13 | [--onto <newbase>] <upstream> [<branch>] | |
cc120056 | 14 | 'git-rebase' --continue | --skip | --abort |
031321c6 | 15 | |
7fc9d69f JH |
16 | DESCRIPTION |
17 | ----------- | |
5ca2db53 SP |
18 | If <branch> is specified, git-rebase will perform an automatic |
19 | `git checkout <branch>` before doing anything else. Otherwise | |
20 | it remains on the current branch. | |
21 | ||
22 | All changes made by commits in the current branch but that are not | |
23 | in <upstream> are saved to a temporary area. This is the same set | |
24 | of commits that would be shown by `git log <upstream>..HEAD`. | |
25 | ||
26 | The current branch is reset to <upstream>, or <newbase> if the | |
27 | --onto option was supplied. This has the exact same effect as | |
28 | `git reset --hard <upstream>` (or <newbase>). | |
29 | ||
30 | The commits that were previously saved into the temporary area are | |
ff905462 JK |
31 | then reapplied to the current branch, one by one, in order. Note that |
32 | any commits in HEAD which introduce the same textual changes as a commit | |
33 | in HEAD..<upstream> are omitted (i.e., a patch already accepted upstream | |
34 | with a different commit message or timestamp will be skipped). | |
69a60af5 | 35 | |
031321c6 SE |
36 | It is possible that a merge failure will prevent this process from being |
37 | completely automatic. You will have to resolve any such merge failure | |
cc120056 SE |
38 | and run `git rebase --continue`. Another option is to bypass the commit |
39 | that caused the merge failure with `git rebase --skip`. To restore the | |
40 | original <branch> and remove the .dotest working files, use the command | |
41 | `git rebase --abort` instead. | |
031321c6 | 42 | |
69a60af5 CW |
43 | Assume the following history exists and the current branch is "topic": |
44 | ||
031321c6 | 45 | ------------ |
69a60af5 CW |
46 | A---B---C topic |
47 | / | |
48 | D---E---F---G master | |
031321c6 | 49 | ------------ |
69a60af5 | 50 | |
228382ae | 51 | From this point, the result of either of the following commands: |
69a60af5 | 52 | |
031321c6 | 53 | |
69a60af5 CW |
54 | git-rebase master |
55 | git-rebase master topic | |
56 | ||
57 | would be: | |
58 | ||
031321c6 | 59 | ------------ |
69a60af5 CW |
60 | A'--B'--C' topic |
61 | / | |
62 | D---E---F---G master | |
031321c6 | 63 | ------------ |
69a60af5 | 64 | |
e52775f4 JN |
65 | The latter form is just a short-hand of `git checkout topic` |
66 | followed by `git rebase master`. | |
69a60af5 | 67 | |
ff905462 JK |
68 | If the upstream branch already contains a change you have made (e.g., |
69 | because you mailed a patch which was applied upstream), then that commit | |
70 | will be skipped. For example, running `git-rebase master` on the | |
71 | following history (in which A' and A introduce the same set of changes, | |
72 | but have different committer information): | |
73 | ||
74 | ------------ | |
75 | A---B---C topic | |
76 | / | |
77 | D---E---A'---F master | |
78 | ------------ | |
79 | ||
80 | will result in: | |
81 | ||
82 | ------------ | |
83 | B'---C' topic | |
84 | / | |
85 | D---E---A'---F master | |
86 | ------------ | |
87 | ||
e52775f4 JN |
88 | Here is how you would transplant a topic branch based on one |
89 | branch to another, to pretend that you forked the topic branch | |
90 | from the latter branch, using `rebase --onto`. | |
69a60af5 | 91 | |
e52775f4 JN |
92 | First let's assume your 'topic' is based on branch 'next'. |
93 | For example feature developed in 'topic' depends on some | |
94 | functionality which is found in 'next'. | |
69a60af5 | 95 | |
031321c6 | 96 | ------------ |
e52775f4 JN |
97 | o---o---o---o---o master |
98 | \ | |
99 | o---o---o---o---o next | |
100 | \ | |
101 | o---o---o topic | |
102 | ------------ | |
103 | ||
104 | We would want to make 'topic' forked from branch 'master', | |
105 | for example because the functionality 'topic' branch depend on | |
106 | got merged into more stable 'master' branch, like this: | |
107 | ||
108 | ------------ | |
109 | o---o---o---o---o master | |
110 | | \ | |
111 | | o'--o'--o' topic | |
112 | \ | |
113 | o---o---o---o---o next | |
031321c6 | 114 | ------------ |
7fc9d69f | 115 | |
e52775f4 JN |
116 | We can get this using the following command: |
117 | ||
118 | git-rebase --onto master next topic | |
119 | ||
120 | ||
121 | Another example of --onto option is to rebase part of a | |
122 | branch. If we have the following situation: | |
123 | ||
124 | ------------ | |
125 | H---I---J topicB | |
126 | / | |
127 | E---F---G topicA | |
128 | / | |
129 | A---B---C---D master | |
130 | ------------ | |
131 | ||
132 | then the command | |
133 | ||
134 | git-rebase --onto master topicA topicB | |
135 | ||
136 | would result in: | |
137 | ||
138 | ------------ | |
139 | H'--I'--J' topicB | |
140 | / | |
141 | | E---F---G topicA | |
142 | |/ | |
143 | A---B---C---D master | |
144 | ------------ | |
145 | ||
146 | This is useful when topicB does not depend on topicA. | |
147 | ||
ea81fcc5 SP |
148 | A range of commits could also be removed with rebase. If we have |
149 | the following situation: | |
150 | ||
151 | ------------ | |
152 | E---F---G---H---I---J topicA | |
153 | ------------ | |
154 | ||
155 | then the command | |
156 | ||
13cc4c81 | 157 | git-rebase --onto topicA~5 topicA~3 topicA |
ea81fcc5 SP |
158 | |
159 | would result in the removal of commits F and G: | |
160 | ||
161 | ------------ | |
162 | E---H'---I'---J' topicA | |
163 | ------------ | |
164 | ||
165 | This is useful if F and G were flawed in some way, or should not be | |
166 | part of topicA. Note that the argument to --onto and the <upstream> | |
167 | parameter can be any valid commit-ish. | |
168 | ||
8978d043 | 169 | In case of conflict, git-rebase will stop at the first problematic commit |
031321c6 SE |
170 | and leave conflict markers in the tree. You can use git diff to locate |
171 | the markers (<<<<<<) and make edits to resolve the conflict. For each | |
172 | file you edit, you need to tell git that the conflict has been resolved, | |
173 | typically this would be done with | |
174 | ||
175 | ||
d7f078b8 | 176 | git add <filename> |
031321c6 SE |
177 | |
178 | ||
179 | After resolving the conflict manually and updating the index with the | |
180 | desired resolution, you can continue the rebasing process with | |
181 | ||
182 | ||
183 | git rebase --continue | |
8978d043 | 184 | |
8978d043 BF |
185 | |
186 | Alternatively, you can undo the git-rebase with | |
187 | ||
031321c6 SE |
188 | |
189 | git rebase --abort | |
8978d043 | 190 | |
7fc9d69f JH |
191 | OPTIONS |
192 | ------- | |
69a60af5 CW |
193 | <newbase>:: |
194 | Starting point at which to create the new commits. If the | |
195 | --onto option is not specified, the starting point is | |
ea81fcc5 SP |
196 | <upstream>. May be any valid commit, and not just an |
197 | existing branch name. | |
69a60af5 | 198 | |
52a22d1e | 199 | <upstream>:: |
ea81fcc5 SP |
200 | Upstream branch to compare against. May be any valid commit, |
201 | not just an existing branch name. | |
7fc9d69f | 202 | |
228382ae | 203 | <branch>:: |
52a22d1e | 204 | Working branch; defaults to HEAD. |
7fc9d69f | 205 | |
031321c6 SE |
206 | --continue:: |
207 | Restart the rebasing process after having resolved a merge conflict. | |
208 | ||
209 | --abort:: | |
210 | Restore the original branch and abort the rebase operation. | |
211 | ||
58634dbf EW |
212 | --skip:: |
213 | Restart the rebasing process by skipping the current patch. | |
58634dbf | 214 | |
a94eda65 | 215 | -m, \--merge:: |
58634dbf EW |
216 | Use merging strategies to rebase. When the recursive (default) merge |
217 | strategy is used, this allows rebase to be aware of renames on the | |
218 | upstream side. | |
219 | ||
220 | -s <strategy>, \--strategy=<strategy>:: | |
221 | Use the given merge strategy; can be supplied more than | |
222 | once to specify them in the order they should be tried. | |
223 | If there is no `-s` option, a built-in list of strategies | |
224 | is used instead (`git-merge-recursive` when merging a single | |
225 | head, `git-merge-octopus` otherwise). This implies --merge. | |
226 | ||
b758789c RS |
227 | -v, \--verbose:: |
228 | Display a diffstat of what changed upstream since the last rebase. | |
229 | ||
67dad687 MT |
230 | -C<n>:: |
231 | Ensure at least <n> lines of surrounding context match before | |
232 | and after each change. When fewer lines of surrounding | |
233 | context exist they all must match. By default no context is | |
234 | ever ignored. | |
235 | ||
059f446d BF |
236 | --whitespace=<nowarn|warn|error|error-all|strip>:: |
237 | This flag is passed to the `git-apply` program | |
238 | (see gitlink:git-apply[1]) that applies the patch. | |
239 | ||
1b1dce4b JS |
240 | -i, \--interactive:: |
241 | Make a list of the commits which are about to be rebased. Let the | |
f0fd889d JS |
242 | user edit that list before rebasing. This mode can also be used to |
243 | split commits (see SPLITTING COMMITS below). | |
1b1dce4b | 244 | |
f09c9b8c JS |
245 | -p, \--preserve-merges:: |
246 | Instead of ignoring merges, try to recreate them. This option | |
247 | only works in interactive mode. | |
248 | ||
58634dbf EW |
249 | include::merge-strategies.txt[] |
250 | ||
031321c6 SE |
251 | NOTES |
252 | ----- | |
253 | When you rebase a branch, you are changing its history in a way that | |
254 | will cause problems for anyone who already has a copy of the branch | |
255 | in their repository and tries to pull updates from you. You should | |
256 | understand the implications of using 'git rebase' on a repository that | |
257 | you share. | |
258 | ||
259 | When the git rebase command is run, it will first execute a "pre-rebase" | |
260 | hook if one exists. You can use this hook to do sanity checks and | |
261 | reject the rebase if it isn't appropriate. Please see the template | |
262 | pre-rebase hook script for an example. | |
263 | ||
264 | You must be in the top directory of your project to start (or continue) | |
265 | a rebase. Upon completion, <branch> will be the current branch. | |
266 | ||
1b1dce4b JS |
267 | INTERACTIVE MODE |
268 | ---------------- | |
269 | ||
270 | Rebasing interactively means that you have a chance to edit the commits | |
271 | which are rebased. You can reorder the commits, and you can | |
272 | remove them (weeding out bad or otherwise unwanted patches). | |
273 | ||
274 | The interactive mode is meant for this type of workflow: | |
275 | ||
276 | 1. have a wonderful idea | |
277 | 2. hack on the code | |
278 | 3. prepare a series for submission | |
279 | 4. submit | |
280 | ||
281 | where point 2. consists of several instances of | |
282 | ||
283 | a. regular use | |
284 | 1. finish something worthy of a commit | |
285 | 2. commit | |
286 | b. independent fixup | |
287 | 1. realize that something does not work | |
288 | 2. fix that | |
289 | 3. commit it | |
290 | ||
291 | Sometimes the thing fixed in b.2. cannot be amended to the not-quite | |
292 | perfect commit it fixes, because that commit is buried deeply in a | |
293 | patch series. That is exactly what interactive rebase is for: use it | |
294 | after plenty of "a"s and "b"s, by rearranging and editing | |
295 | commits, and squashing multiple commits into one. | |
296 | ||
297 | Start it with the last commit you want to retain as-is: | |
298 | ||
299 | git rebase -i <after-this-commit> | |
300 | ||
301 | An editor will be fired up with all the commits in your current branch | |
302 | (ignoring merge commits), which come after the given commit. You can | |
303 | reorder the commits in this list to your heart's content, and you can | |
304 | remove them. The list looks more or less like this: | |
305 | ||
306 | ------------------------------------------- | |
307 | pick deadbee The oneline of this commit | |
308 | pick fa1afe1 The oneline of the next commit | |
309 | ... | |
310 | ------------------------------------------- | |
311 | ||
312 | The oneline descriptions are purely for your pleasure; `git-rebase` will | |
313 | not look at them but at the commit names ("deadbee" and "fa1afe1" in this | |
314 | example), so do not delete or edit the names. | |
315 | ||
316 | By replacing the command "pick" with the command "edit", you can tell | |
317 | `git-rebase` to stop after applying that commit, so that you can edit | |
318 | the files and/or the commit message, amend the commit, and continue | |
319 | rebasing. | |
320 | ||
321 | If you want to fold two or more commits into one, replace the command | |
322 | "pick" with "squash" for the second and subsequent commit. If the | |
323 | commits had different authors, it will attribute the squashed commit to | |
81ab1cb4 | 324 | the author of the first commit. |
1b1dce4b JS |
325 | |
326 | In both cases, or when a "pick" does not succeed (because of merge | |
327 | errors), the loop will stop to let you fix things, and you can continue | |
328 | the loop with `git rebase --continue`. | |
329 | ||
330 | For example, if you want to reorder the last 5 commits, such that what | |
331 | was HEAD~4 becomes the new HEAD. To achieve that, you would call | |
332 | `git-rebase` like this: | |
333 | ||
334 | ---------------------- | |
335 | $ git rebase -i HEAD~5 | |
336 | ---------------------- | |
337 | ||
338 | And move the first patch to the end of the list. | |
339 | ||
f09c9b8c JS |
340 | You might want to preserve merges, if you have a history like this: |
341 | ||
342 | ------------------ | |
343 | X | |
344 | \ | |
345 | A---M---B | |
346 | / | |
347 | ---o---O---P---Q | |
348 | ------------------ | |
349 | ||
350 | Suppose you want to rebase the side branch starting at "A" to "Q". Make | |
351 | sure that the current HEAD is "B", and call | |
352 | ||
353 | ----------------------------- | |
354 | $ git rebase -i -p --onto Q O | |
355 | ----------------------------- | |
356 | ||
f0fd889d JS |
357 | |
358 | SPLITTING COMMITS | |
359 | ----------------- | |
360 | ||
361 | In interactive mode, you can mark commits with the action "edit". However, | |
362 | this does not necessarily mean that 'git rebase' expects the result of this | |
363 | edit to be exactly one commit. Indeed, you can undo the commit, or you can | |
364 | add other commits. This can be used to split a commit into two: | |
365 | ||
366 | - Start an interactive rebase with 'git rebase -i <commit>^', where | |
367 | <commit> is the commit you want to split. In fact, any commit range | |
368 | will do, as long as it contains that commit. | |
369 | ||
370 | - Mark the commit you want to split with the action "edit". | |
371 | ||
372 | - When it comes to editing that commit, execute 'git reset HEAD^'. The | |
373 | effect is that the HEAD is rewound by one, and the index follows suit. | |
374 | However, the working tree stays the same. | |
375 | ||
376 | - Now add the changes to the index that you want to have in the first | |
377 | commit. You can use gitlink:git-add[1] (possibly interactively) and/or | |
378 | gitlink:git-gui[1] to do that. | |
379 | ||
380 | - Commit the now-current index with whatever commit message is appropriate | |
381 | now. | |
382 | ||
383 | - Repeat the last two steps until your working tree is clean. | |
384 | ||
385 | - Continue the rebase with 'git rebase --continue'. | |
386 | ||
387 | If you are not absolutely sure that the intermediate revisions are | |
388 | consistent (they compile, pass the testsuite, etc.) you should use | |
389 | gitlink:git-stash[1] to stash away the not-yet-committed changes | |
390 | after each commit, test, and amend the commit if fixes are necessary. | |
391 | ||
392 | ||
1b1dce4b | 393 | Authors |
7fc9d69f | 394 | ------ |
1b1dce4b JS |
395 | Written by Junio C Hamano <junkio@cox.net> and |
396 | Johannes E. Schindelin <johannes.schindelin@gmx.de> | |
7fc9d69f JH |
397 | |
398 | Documentation | |
399 | -------------- | |
400 | Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. | |
401 | ||
402 | GIT | |
403 | --- | |
a7154e91 | 404 | Part of the gitlink:git[7] suite |