]>
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] |
be496621 TR |
11 | 'git rebase' [-i | --interactive] [options] [--onto <newbase>] |
12 | <upstream> [<branch>] | |
13 | 'git rebase' [-i | --interactive] [options] --onto <newbase> | |
14 | --root [<branch>] | |
15 | ||
b1889c36 | 16 | 'git rebase' --continue | --skip | --abort |
031321c6 | 17 | |
7fc9d69f JH |
18 | DESCRIPTION |
19 | ----------- | |
ba020ef5 | 20 | If <branch> is specified, 'git-rebase' will perform an automatic |
5ca2db53 SP |
21 | `git checkout <branch>` before doing anything else. Otherwise |
22 | it remains on the current branch. | |
23 | ||
24 | All changes made by commits in the current branch but that are not | |
25 | in <upstream> are saved to a temporary area. This is the same set | |
be496621 TR |
26 | of commits that would be shown by `git log <upstream>..HEAD` (or |
27 | `git log HEAD`, if --root is specified). | |
5ca2db53 SP |
28 | |
29 | The current branch is reset to <upstream>, or <newbase> if the | |
30 | --onto option was supplied. This has the exact same effect as | |
9869099b BG |
31 | `git reset --hard <upstream>` (or <newbase>). ORIG_HEAD is set |
32 | to point at the tip of the branch before the reset. | |
5ca2db53 SP |
33 | |
34 | The commits that were previously saved into the temporary area are | |
ff905462 JK |
35 | then reapplied to the current branch, one by one, in order. Note that |
36 | any commits in HEAD which introduce the same textual changes as a commit | |
37 | in HEAD..<upstream> are omitted (i.e., a patch already accepted upstream | |
38 | with a different commit message or timestamp will be skipped). | |
69a60af5 | 39 | |
031321c6 SE |
40 | It is possible that a merge failure will prevent this process from being |
41 | completely automatic. You will have to resolve any such merge failure | |
cc120056 SE |
42 | and run `git rebase --continue`. Another option is to bypass the commit |
43 | that caused the merge failure with `git rebase --skip`. To restore the | |
51ef1daa JS |
44 | original <branch> and remove the .git/rebase-apply working files, use the |
45 | command `git rebase --abort` instead. | |
031321c6 | 46 | |
69a60af5 CW |
47 | Assume the following history exists and the current branch is "topic": |
48 | ||
031321c6 | 49 | ------------ |
69a60af5 CW |
50 | A---B---C topic |
51 | / | |
52 | D---E---F---G master | |
031321c6 | 53 | ------------ |
69a60af5 | 54 | |
228382ae | 55 | From this point, the result of either of the following commands: |
69a60af5 | 56 | |
031321c6 | 57 | |
b1889c36 JN |
58 | git rebase master |
59 | git rebase master topic | |
69a60af5 CW |
60 | |
61 | would be: | |
62 | ||
031321c6 | 63 | ------------ |
69a60af5 CW |
64 | A'--B'--C' topic |
65 | / | |
66 | D---E---F---G master | |
031321c6 | 67 | ------------ |
69a60af5 | 68 | |
e52775f4 JN |
69 | The latter form is just a short-hand of `git checkout topic` |
70 | followed by `git rebase master`. | |
69a60af5 | 71 | |
ff905462 JK |
72 | If the upstream branch already contains a change you have made (e.g., |
73 | because you mailed a patch which was applied upstream), then that commit | |
b1889c36 | 74 | will be skipped. For example, running `git rebase master` on the |
ff905462 JK |
75 | following history (in which A' and A introduce the same set of changes, |
76 | but have different committer information): | |
77 | ||
78 | ------------ | |
79 | A---B---C topic | |
80 | / | |
81 | D---E---A'---F master | |
82 | ------------ | |
83 | ||
84 | will result in: | |
85 | ||
86 | ------------ | |
87 | B'---C' topic | |
88 | / | |
89 | D---E---A'---F master | |
90 | ------------ | |
91 | ||
e52775f4 JN |
92 | Here is how you would transplant a topic branch based on one |
93 | branch to another, to pretend that you forked the topic branch | |
94 | from the latter branch, using `rebase --onto`. | |
69a60af5 | 95 | |
e52775f4 | 96 | First let's assume your 'topic' is based on branch 'next'. |
e2b850b2 | 97 | For example, a feature developed in 'topic' depends on some |
e52775f4 | 98 | functionality which is found in 'next'. |
69a60af5 | 99 | |
031321c6 | 100 | ------------ |
e52775f4 JN |
101 | o---o---o---o---o master |
102 | \ | |
103 | o---o---o---o---o next | |
104 | \ | |
105 | o---o---o topic | |
106 | ------------ | |
107 | ||
e2b850b2 GD |
108 | We want to make 'topic' forked from branch 'master'; for example, |
109 | because the functionality on which 'topic' depends was merged into the | |
110 | more stable 'master' branch. We want our tree to look like this: | |
e52775f4 JN |
111 | |
112 | ------------ | |
113 | o---o---o---o---o master | |
114 | | \ | |
115 | | o'--o'--o' topic | |
116 | \ | |
117 | o---o---o---o---o next | |
031321c6 | 118 | ------------ |
7fc9d69f | 119 | |
e52775f4 JN |
120 | We can get this using the following command: |
121 | ||
b1889c36 | 122 | git rebase --onto master next topic |
e52775f4 JN |
123 | |
124 | ||
125 | Another example of --onto option is to rebase part of a | |
126 | branch. If we have the following situation: | |
127 | ||
128 | ------------ | |
129 | H---I---J topicB | |
130 | / | |
131 | E---F---G topicA | |
132 | / | |
133 | A---B---C---D master | |
134 | ------------ | |
135 | ||
136 | then the command | |
137 | ||
b1889c36 | 138 | git rebase --onto master topicA topicB |
e52775f4 JN |
139 | |
140 | would result in: | |
141 | ||
142 | ------------ | |
143 | H'--I'--J' topicB | |
144 | / | |
145 | | E---F---G topicA | |
146 | |/ | |
147 | A---B---C---D master | |
148 | ------------ | |
149 | ||
150 | This is useful when topicB does not depend on topicA. | |
151 | ||
ea81fcc5 SP |
152 | A range of commits could also be removed with rebase. If we have |
153 | the following situation: | |
154 | ||
155 | ------------ | |
156 | E---F---G---H---I---J topicA | |
157 | ------------ | |
158 | ||
159 | then the command | |
160 | ||
b1889c36 | 161 | git rebase --onto topicA~5 topicA~3 topicA |
ea81fcc5 SP |
162 | |
163 | would result in the removal of commits F and G: | |
164 | ||
165 | ------------ | |
166 | E---H'---I'---J' topicA | |
167 | ------------ | |
168 | ||
169 | This is useful if F and G were flawed in some way, or should not be | |
170 | part of topicA. Note that the argument to --onto and the <upstream> | |
171 | parameter can be any valid commit-ish. | |
172 | ||
ba020ef5 JN |
173 | In case of conflict, 'git-rebase' will stop at the first problematic commit |
174 | and leave conflict markers in the tree. You can use 'git-diff' to locate | |
031321c6 SE |
175 | the markers (<<<<<<) and make edits to resolve the conflict. For each |
176 | file you edit, you need to tell git that the conflict has been resolved, | |
177 | typically this would be done with | |
178 | ||
179 | ||
d7f078b8 | 180 | git add <filename> |
031321c6 SE |
181 | |
182 | ||
183 | After resolving the conflict manually and updating the index with the | |
184 | desired resolution, you can continue the rebasing process with | |
185 | ||
186 | ||
187 | git rebase --continue | |
8978d043 | 188 | |
8978d043 | 189 | |
ba020ef5 | 190 | Alternatively, you can undo the 'git-rebase' with |
8978d043 | 191 | |
031321c6 SE |
192 | |
193 | git rebase --abort | |
8978d043 | 194 | |
a9c3821c TAV |
195 | CONFIGURATION |
196 | ------------- | |
197 | ||
198 | rebase.stat:: | |
199 | Whether to show a diffstat of what changed upstream since the last | |
200 | rebase. False by default. | |
201 | ||
7fc9d69f JH |
202 | OPTIONS |
203 | ------- | |
69a60af5 CW |
204 | <newbase>:: |
205 | Starting point at which to create the new commits. If the | |
206 | --onto option is not specified, the starting point is | |
ea81fcc5 SP |
207 | <upstream>. May be any valid commit, and not just an |
208 | existing branch name. | |
69a60af5 | 209 | |
52a22d1e | 210 | <upstream>:: |
ea81fcc5 SP |
211 | Upstream branch to compare against. May be any valid commit, |
212 | not just an existing branch name. | |
7fc9d69f | 213 | |
228382ae | 214 | <branch>:: |
52a22d1e | 215 | Working branch; defaults to HEAD. |
7fc9d69f | 216 | |
031321c6 SE |
217 | --continue:: |
218 | Restart the rebasing process after having resolved a merge conflict. | |
219 | ||
220 | --abort:: | |
221 | Restore the original branch and abort the rebase operation. | |
222 | ||
58634dbf EW |
223 | --skip:: |
224 | Restart the rebasing process by skipping the current patch. | |
58634dbf | 225 | |
3240240f SB |
226 | -m:: |
227 | --merge:: | |
58634dbf EW |
228 | Use merging strategies to rebase. When the recursive (default) merge |
229 | strategy is used, this allows rebase to be aware of renames on the | |
230 | upstream side. | |
231 | ||
3240240f SB |
232 | -s <strategy>:: |
233 | --strategy=<strategy>:: | |
58634dbf EW |
234 | Use the given merge strategy; can be supplied more than |
235 | once to specify them in the order they should be tried. | |
236 | If there is no `-s` option, a built-in list of strategies | |
ba020ef5 JN |
237 | is used instead ('git-merge-recursive' when merging a single |
238 | head, 'git-merge-octopus' otherwise). This implies --merge. | |
58634dbf | 239 | |
3240240f SB |
240 | -v:: |
241 | --verbose:: | |
a9c3821c TAV |
242 | Be verbose. Implies --stat. |
243 | ||
244 | --stat:: | |
245 | Show a diffstat of what changed upstream since the last rebase. The | |
246 | diffstat is also controlled by the configuration option rebase.stat. | |
247 | ||
248 | -n:: | |
249 | --no-stat:: | |
250 | Do not show a diffstat as part of the rebase process. | |
b758789c | 251 | |
fd631d58 NS |
252 | --no-verify:: |
253 | This option bypasses the pre-rebase hook. See also linkgit:githooks[5]. | |
254 | ||
67dad687 MT |
255 | -C<n>:: |
256 | Ensure at least <n> lines of surrounding context match before | |
257 | and after each change. When fewer lines of surrounding | |
258 | context exist they all must match. By default no context is | |
259 | ever ignored. | |
260 | ||
5e75d56f MB |
261 | -f:: |
262 | --force-rebase:: | |
263 | Force the rebase even if the current branch is a descendant | |
264 | of the commit you are rebasing onto. Normally the command will | |
265 | exit with the message "Current branch is up to date" in such a | |
266 | situation. | |
267 | ||
749485f6 | 268 | --whitespace=<option>:: |
ba020ef5 | 269 | This flag is passed to the 'git-apply' program |
5162e697 | 270 | (see linkgit:git-apply[1]) that applies the patch. |
7fe54385 | 271 | Incompatible with the --interactive option. |
059f446d | 272 | |
3240240f SB |
273 | -i:: |
274 | --interactive:: | |
1b1dce4b | 275 | Make a list of the commits which are about to be rebased. Let the |
f0fd889d JS |
276 | user edit that list before rebasing. This mode can also be used to |
277 | split commits (see SPLITTING COMMITS below). | |
1b1dce4b | 278 | |
3240240f SB |
279 | -p:: |
280 | --preserve-merges:: | |
f8cca019 | 281 | Instead of ignoring merges, try to recreate them. |
f09c9b8c | 282 | |
be496621 TR |
283 | --root:: |
284 | Rebase all commits reachable from <branch>, instead of | |
285 | limiting them with an <upstream>. This allows you to rebase | |
286 | the root commit(s) on a branch. Must be used with --onto, and | |
287 | will skip changes already contained in <newbase> (instead of | |
288 | <upstream>). When used together with --preserve-merges, 'all' | |
289 | root commits will be rewritten to have <newbase> as parent | |
290 | instead. | |
291 | ||
58634dbf EW |
292 | include::merge-strategies.txt[] |
293 | ||
031321c6 SE |
294 | NOTES |
295 | ----- | |
90d1c08e TR |
296 | |
297 | You should understand the implications of using 'git-rebase' on a | |
298 | repository that you share. See also RECOVERING FROM UPSTREAM REBASE | |
299 | below. | |
031321c6 | 300 | |
467c0197 | 301 | When the git-rebase command is run, it will first execute a "pre-rebase" |
031321c6 SE |
302 | hook if one exists. You can use this hook to do sanity checks and |
303 | reject the rebase if it isn't appropriate. Please see the template | |
304 | pre-rebase hook script for an example. | |
305 | ||
702088af | 306 | Upon completion, <branch> will be the current branch. |
031321c6 | 307 | |
1b1dce4b JS |
308 | INTERACTIVE MODE |
309 | ---------------- | |
310 | ||
311 | Rebasing interactively means that you have a chance to edit the commits | |
312 | which are rebased. You can reorder the commits, and you can | |
313 | remove them (weeding out bad or otherwise unwanted patches). | |
314 | ||
315 | The interactive mode is meant for this type of workflow: | |
316 | ||
317 | 1. have a wonderful idea | |
318 | 2. hack on the code | |
319 | 3. prepare a series for submission | |
320 | 4. submit | |
321 | ||
322 | where point 2. consists of several instances of | |
323 | ||
324 | a. regular use | |
325 | 1. finish something worthy of a commit | |
326 | 2. commit | |
327 | b. independent fixup | |
328 | 1. realize that something does not work | |
329 | 2. fix that | |
330 | 3. commit it | |
331 | ||
332 | Sometimes the thing fixed in b.2. cannot be amended to the not-quite | |
333 | perfect commit it fixes, because that commit is buried deeply in a | |
334 | patch series. That is exactly what interactive rebase is for: use it | |
335 | after plenty of "a"s and "b"s, by rearranging and editing | |
336 | commits, and squashing multiple commits into one. | |
337 | ||
338 | Start it with the last commit you want to retain as-is: | |
339 | ||
340 | git rebase -i <after-this-commit> | |
341 | ||
342 | An editor will be fired up with all the commits in your current branch | |
343 | (ignoring merge commits), which come after the given commit. You can | |
344 | reorder the commits in this list to your heart's content, and you can | |
345 | remove them. The list looks more or less like this: | |
346 | ||
347 | ------------------------------------------- | |
348 | pick deadbee The oneline of this commit | |
349 | pick fa1afe1 The oneline of the next commit | |
350 | ... | |
351 | ------------------------------------------- | |
352 | ||
ba020ef5 | 353 | The oneline descriptions are purely for your pleasure; 'git-rebase' will |
1b1dce4b JS |
354 | not look at them but at the commit names ("deadbee" and "fa1afe1" in this |
355 | example), so do not delete or edit the names. | |
356 | ||
357 | By replacing the command "pick" with the command "edit", you can tell | |
ba020ef5 | 358 | 'git-rebase' to stop after applying that commit, so that you can edit |
1b1dce4b JS |
359 | the files and/or the commit message, amend the commit, and continue |
360 | rebasing. | |
361 | ||
362 | If you want to fold two or more commits into one, replace the command | |
363 | "pick" with "squash" for the second and subsequent commit. If the | |
364 | commits had different authors, it will attribute the squashed commit to | |
81ab1cb4 | 365 | the author of the first commit. |
1b1dce4b JS |
366 | |
367 | In both cases, or when a "pick" does not succeed (because of merge | |
368 | errors), the loop will stop to let you fix things, and you can continue | |
369 | the loop with `git rebase --continue`. | |
370 | ||
371 | For example, if you want to reorder the last 5 commits, such that what | |
372 | was HEAD~4 becomes the new HEAD. To achieve that, you would call | |
ba020ef5 | 373 | 'git-rebase' like this: |
1b1dce4b JS |
374 | |
375 | ---------------------- | |
376 | $ git rebase -i HEAD~5 | |
377 | ---------------------- | |
378 | ||
379 | And move the first patch to the end of the list. | |
380 | ||
f09c9b8c JS |
381 | You might want to preserve merges, if you have a history like this: |
382 | ||
383 | ------------------ | |
384 | X | |
385 | \ | |
386 | A---M---B | |
387 | / | |
388 | ---o---O---P---Q | |
389 | ------------------ | |
390 | ||
391 | Suppose you want to rebase the side branch starting at "A" to "Q". Make | |
392 | sure that the current HEAD is "B", and call | |
393 | ||
394 | ----------------------------- | |
395 | $ git rebase -i -p --onto Q O | |
396 | ----------------------------- | |
397 | ||
f0fd889d JS |
398 | |
399 | SPLITTING COMMITS | |
400 | ----------------- | |
401 | ||
402 | In interactive mode, you can mark commits with the action "edit". However, | |
ba020ef5 | 403 | this does not necessarily mean that 'git-rebase' expects the result of this |
f0fd889d JS |
404 | edit to be exactly one commit. Indeed, you can undo the commit, or you can |
405 | add other commits. This can be used to split a commit into two: | |
406 | ||
483bc4f0 | 407 | - Start an interactive rebase with `git rebase -i <commit>^`, where |
f0fd889d JS |
408 | <commit> is the commit you want to split. In fact, any commit range |
409 | will do, as long as it contains that commit. | |
410 | ||
411 | - Mark the commit you want to split with the action "edit". | |
412 | ||
483bc4f0 | 413 | - When it comes to editing that commit, execute `git reset HEAD^`. The |
f0fd889d JS |
414 | effect is that the HEAD is rewound by one, and the index follows suit. |
415 | However, the working tree stays the same. | |
416 | ||
417 | - Now add the changes to the index that you want to have in the first | |
483bc4f0 | 418 | commit. You can use `git add` (possibly interactively) or |
ba020ef5 | 419 | 'git-gui' (or both) to do that. |
f0fd889d JS |
420 | |
421 | - Commit the now-current index with whatever commit message is appropriate | |
422 | now. | |
423 | ||
424 | - Repeat the last two steps until your working tree is clean. | |
425 | ||
483bc4f0 | 426 | - Continue the rebase with `git rebase --continue`. |
f0fd889d JS |
427 | |
428 | If you are not absolutely sure that the intermediate revisions are | |
429 | consistent (they compile, pass the testsuite, etc.) you should use | |
ba020ef5 | 430 | 'git-stash' to stash away the not-yet-committed changes |
f0fd889d JS |
431 | after each commit, test, and amend the commit if fixes are necessary. |
432 | ||
433 | ||
90d1c08e TR |
434 | RECOVERING FROM UPSTREAM REBASE |
435 | ------------------------------- | |
436 | ||
437 | Rebasing (or any other form of rewriting) a branch that others have | |
438 | based work on is a bad idea: anyone downstream of it is forced to | |
439 | manually fix their history. This section explains how to do the fix | |
440 | from the downstream's point of view. The real fix, however, would be | |
441 | to avoid rebasing the upstream in the first place. | |
442 | ||
443 | To illustrate, suppose you are in a situation where someone develops a | |
444 | 'subsystem' branch, and you are working on a 'topic' that is dependent | |
445 | on this 'subsystem'. You might end up with a history like the | |
446 | following: | |
447 | ||
448 | ------------ | |
449 | o---o---o---o---o---o---o---o---o master | |
450 | \ | |
451 | o---o---o---o---o subsystem | |
452 | \ | |
453 | *---*---* topic | |
454 | ------------ | |
455 | ||
456 | If 'subsystem' is rebased against 'master', the following happens: | |
457 | ||
458 | ------------ | |
459 | o---o---o---o---o---o---o---o master | |
460 | \ \ | |
461 | o---o---o---o---o o'--o'--o'--o'--o' subsystem | |
462 | \ | |
463 | *---*---* topic | |
464 | ------------ | |
465 | ||
466 | If you now continue development as usual, and eventually merge 'topic' | |
467 | to 'subsystem', the commits from 'subsystem' will remain duplicated forever: | |
468 | ||
469 | ------------ | |
470 | o---o---o---o---o---o---o---o master | |
471 | \ \ | |
472 | o---o---o---o---o o'--o'--o'--o'--o'--M subsystem | |
473 | \ / | |
474 | *---*---*-..........-*--* topic | |
475 | ------------ | |
476 | ||
477 | Such duplicates are generally frowned upon because they clutter up | |
478 | history, making it harder to follow. To clean things up, you need to | |
479 | transplant the commits on 'topic' to the new 'subsystem' tip, i.e., | |
480 | rebase 'topic'. This becomes a ripple effect: anyone downstream from | |
481 | 'topic' is forced to rebase too, and so on! | |
482 | ||
483 | There are two kinds of fixes, discussed in the following subsections: | |
484 | ||
485 | Easy case: The changes are literally the same.:: | |
486 | ||
487 | This happens if the 'subsystem' rebase was a simple rebase and | |
488 | had no conflicts. | |
489 | ||
490 | Hard case: The changes are not the same.:: | |
491 | ||
492 | This happens if the 'subsystem' rebase had conflicts, or used | |
493 | `\--interactive` to omit, edit, or squash commits; or if the | |
494 | upstream used one of `commit \--amend`, `reset`, or | |
495 | `filter-branch`. | |
496 | ||
497 | ||
498 | The easy case | |
499 | ~~~~~~~~~~~~~ | |
500 | ||
501 | Only works if the changes (patch IDs based on the diff contents) on | |
502 | 'subsystem' are literally the same before and after the rebase | |
503 | 'subsystem' did. | |
504 | ||
505 | In that case, the fix is easy because 'git-rebase' knows to skip | |
506 | changes that are already present in the new upstream. So if you say | |
507 | (assuming you're on 'topic') | |
508 | ------------ | |
509 | $ git rebase subsystem | |
510 | ------------ | |
511 | you will end up with the fixed history | |
512 | ------------ | |
513 | o---o---o---o---o---o---o---o master | |
514 | \ | |
515 | o'--o'--o'--o'--o' subsystem | |
516 | \ | |
517 | *---*---* topic | |
518 | ------------ | |
519 | ||
520 | ||
521 | The hard case | |
522 | ~~~~~~~~~~~~~ | |
523 | ||
524 | Things get more complicated if the 'subsystem' changes do not exactly | |
525 | correspond to the ones before the rebase. | |
526 | ||
527 | NOTE: While an "easy case recovery" sometimes appears to be successful | |
528 | even in the hard case, it may have unintended consequences. For | |
529 | example, a commit that was removed via `git rebase | |
530 | \--interactive` will be **resurrected**! | |
531 | ||
532 | The idea is to manually tell 'git-rebase' "where the old 'subsystem' | |
533 | ended and your 'topic' began", that is, what the old merge-base | |
534 | between them was. You will have to find a way to name the last commit | |
535 | of the old 'subsystem', for example: | |
536 | ||
537 | * With the 'subsystem' reflog: after 'git-fetch', the old tip of | |
538 | 'subsystem' is at `subsystem@\{1}`. Subsequent fetches will | |
539 | increase the number. (See linkgit:git-reflog[1].) | |
540 | ||
541 | * Relative to the tip of 'topic': knowing that your 'topic' has three | |
542 | commits, the old tip of 'subsystem' must be `topic~3`. | |
543 | ||
544 | You can then transplant the old `subsystem..topic` to the new tip by | |
545 | saying (for the reflog case, and assuming you are on 'topic' already): | |
546 | ------------ | |
547 | $ git rebase --onto subsystem subsystem@{1} | |
548 | ------------ | |
549 | ||
550 | The ripple effect of a "hard case" recovery is especially bad: | |
551 | 'everyone' downstream from 'topic' will now have to perform a "hard | |
552 | case" recovery too! | |
553 | ||
554 | ||
1b1dce4b | 555 | Authors |
7fc9d69f | 556 | ------ |
59eb68aa | 557 | Written by Junio C Hamano <gitster@pobox.com> and |
1b1dce4b | 558 | Johannes E. Schindelin <johannes.schindelin@gmx.de> |
7fc9d69f JH |
559 | |
560 | Documentation | |
561 | -------------- | |
562 | Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. | |
563 | ||
564 | GIT | |
565 | --- | |
9e1f0a85 | 566 | Part of the linkgit:git[1] suite |