]>
Commit | Line | Data |
---|---|---|
215a7ad1 JH |
1 | git-rebase(1) |
2 | ============= | |
7fc9d69f JH |
3 | |
4 | NAME | |
5 | ---- | |
b385085b | 6 | git-rebase - Reapply commits on top of another base tip |
7fc9d69f JH |
7 | |
8 | SYNOPSIS | |
9 | -------- | |
e448ff87 | 10 | [verse] |
de613050 | 11 | 'git rebase' [-i | --interactive] [<options>] [--exec <cmd>] [--onto <newbase>] |
95c68267 | 12 | [<upstream> [<branch>]] |
de613050 | 13 | 'git rebase' [-i | --interactive] [<options>] [--exec <cmd>] [--onto <newbase>] |
be496621 | 14 | --root [<branch>] |
66335298 | 15 | 'git rebase' --continue | --skip | --abort | --quit | --edit-todo | --show-current-patch |
031321c6 | 16 | |
7fc9d69f JH |
17 | DESCRIPTION |
18 | ----------- | |
0b444cdb | 19 | If <branch> is specified, 'git rebase' will perform an automatic |
5ca2db53 SP |
20 | `git checkout <branch>` before doing anything else. Otherwise |
21 | it remains on the current branch. | |
22 | ||
15a147e6 | 23 | If <upstream> is not specified, the upstream configured in |
f51a48ec SO |
24 | branch.<name>.remote and branch.<name>.merge options will be used (see |
25 | linkgit:git-config[1] for details) and the `--fork-point` option is | |
26 | assumed. If you are currently not on any branch or if the current | |
27 | branch does not have a configured upstream, the rebase will abort. | |
15a147e6 | 28 | |
5ca2db53 SP |
29 | All changes made by commits in the current branch but that are not |
30 | in <upstream> are saved to a temporary area. This is the same set | |
f51a48ec SO |
31 | of commits that would be shown by `git log <upstream>..HEAD`; or by |
32 | `git log 'fork_point'..HEAD`, if `--fork-point` is active (see the | |
33 | description on `--fork-point` below); or by `git log HEAD`, if the | |
34 | `--root` option is specified. | |
5ca2db53 SP |
35 | |
36 | The current branch is reset to <upstream>, or <newbase> if the | |
37 | --onto option was supplied. This has the exact same effect as | |
9869099b BG |
38 | `git reset --hard <upstream>` (or <newbase>). ORIG_HEAD is set |
39 | to point at the tip of the branch before the reset. | |
5ca2db53 SP |
40 | |
41 | The commits that were previously saved into the temporary area are | |
ff905462 JK |
42 | then reapplied to the current branch, one by one, in order. Note that |
43 | any commits in HEAD which introduce the same textual changes as a commit | |
44 | in HEAD..<upstream> are omitted (i.e., a patch already accepted upstream | |
45 | with a different commit message or timestamp will be skipped). | |
69a60af5 | 46 | |
031321c6 SE |
47 | It is possible that a merge failure will prevent this process from being |
48 | completely automatic. You will have to resolve any such merge failure | |
cc120056 | 49 | and run `git rebase --continue`. Another option is to bypass the commit |
5960bc9d | 50 | that caused the merge failure with `git rebase --skip`. To check out the |
51ef1daa JS |
51 | original <branch> and remove the .git/rebase-apply working files, use the |
52 | command `git rebase --abort` instead. | |
031321c6 | 53 | |
69a60af5 CW |
54 | Assume the following history exists and the current branch is "topic": |
55 | ||
031321c6 | 56 | ------------ |
69a60af5 CW |
57 | A---B---C topic |
58 | / | |
59 | D---E---F---G master | |
031321c6 | 60 | ------------ |
69a60af5 | 61 | |
228382ae | 62 | From this point, the result of either of the following commands: |
69a60af5 | 63 | |
031321c6 | 64 | |
b1889c36 JN |
65 | git rebase master |
66 | git rebase master topic | |
69a60af5 CW |
67 | |
68 | would be: | |
69 | ||
031321c6 | 70 | ------------ |
69a60af5 CW |
71 | A'--B'--C' topic |
72 | / | |
73 | D---E---F---G master | |
031321c6 | 74 | ------------ |
69a60af5 | 75 | |
ee55703b DN |
76 | *NOTE:* The latter form is just a short-hand of `git checkout topic` |
77 | followed by `git rebase master`. When rebase exits `topic` will | |
78 | remain the checked-out branch. | |
69a60af5 | 79 | |
ff905462 JK |
80 | If the upstream branch already contains a change you have made (e.g., |
81 | because you mailed a patch which was applied upstream), then that commit | |
b1889c36 | 82 | will be skipped. For example, running `git rebase master` on the |
e08bc7a9 | 83 | following history (in which `A'` and `A` introduce the same set of changes, |
ff905462 JK |
84 | but have different committer information): |
85 | ||
86 | ------------ | |
87 | A---B---C topic | |
88 | / | |
89 | D---E---A'---F master | |
90 | ------------ | |
91 | ||
92 | will result in: | |
93 | ||
94 | ------------ | |
95 | B'---C' topic | |
96 | / | |
97 | D---E---A'---F master | |
98 | ------------ | |
99 | ||
e52775f4 JN |
100 | Here is how you would transplant a topic branch based on one |
101 | branch to another, to pretend that you forked the topic branch | |
102 | from the latter branch, using `rebase --onto`. | |
69a60af5 | 103 | |
e52775f4 | 104 | First let's assume your 'topic' is based on branch 'next'. |
e2b850b2 | 105 | For example, a feature developed in 'topic' depends on some |
e52775f4 | 106 | functionality which is found in 'next'. |
69a60af5 | 107 | |
031321c6 | 108 | ------------ |
e52775f4 JN |
109 | o---o---o---o---o master |
110 | \ | |
111 | o---o---o---o---o next | |
112 | \ | |
113 | o---o---o topic | |
114 | ------------ | |
115 | ||
e2b850b2 GD |
116 | We want to make 'topic' forked from branch 'master'; for example, |
117 | because the functionality on which 'topic' depends was merged into the | |
118 | more stable 'master' branch. We want our tree to look like this: | |
e52775f4 JN |
119 | |
120 | ------------ | |
121 | o---o---o---o---o master | |
122 | | \ | |
123 | | o'--o'--o' topic | |
124 | \ | |
125 | o---o---o---o---o next | |
031321c6 | 126 | ------------ |
7fc9d69f | 127 | |
e52775f4 JN |
128 | We can get this using the following command: |
129 | ||
b1889c36 | 130 | git rebase --onto master next topic |
e52775f4 JN |
131 | |
132 | ||
133 | Another example of --onto option is to rebase part of a | |
134 | branch. If we have the following situation: | |
135 | ||
136 | ------------ | |
137 | H---I---J topicB | |
138 | / | |
139 | E---F---G topicA | |
140 | / | |
141 | A---B---C---D master | |
142 | ------------ | |
143 | ||
144 | then the command | |
145 | ||
b1889c36 | 146 | git rebase --onto master topicA topicB |
e52775f4 JN |
147 | |
148 | would result in: | |
149 | ||
150 | ------------ | |
151 | H'--I'--J' topicB | |
152 | / | |
153 | | E---F---G topicA | |
154 | |/ | |
155 | A---B---C---D master | |
156 | ------------ | |
157 | ||
158 | This is useful when topicB does not depend on topicA. | |
159 | ||
ea81fcc5 SP |
160 | A range of commits could also be removed with rebase. If we have |
161 | the following situation: | |
162 | ||
163 | ------------ | |
164 | E---F---G---H---I---J topicA | |
165 | ------------ | |
166 | ||
167 | then the command | |
168 | ||
b1889c36 | 169 | git rebase --onto topicA~5 topicA~3 topicA |
ea81fcc5 SP |
170 | |
171 | would result in the removal of commits F and G: | |
172 | ||
173 | ------------ | |
174 | E---H'---I'---J' topicA | |
175 | ------------ | |
176 | ||
177 | This is useful if F and G were flawed in some way, or should not be | |
178 | part of topicA. Note that the argument to --onto and the <upstream> | |
179 | parameter can be any valid commit-ish. | |
180 | ||
0b444cdb TR |
181 | In case of conflict, 'git rebase' will stop at the first problematic commit |
182 | and leave conflict markers in the tree. You can use 'git diff' to locate | |
031321c6 | 183 | the markers (<<<<<<) and make edits to resolve the conflict. For each |
2de9b711 | 184 | file you edit, you need to tell Git that the conflict has been resolved, |
031321c6 SE |
185 | typically this would be done with |
186 | ||
187 | ||
d7f078b8 | 188 | git add <filename> |
031321c6 SE |
189 | |
190 | ||
191 | After resolving the conflict manually and updating the index with the | |
192 | desired resolution, you can continue the rebasing process with | |
193 | ||
194 | ||
195 | git rebase --continue | |
8978d043 | 196 | |
8978d043 | 197 | |
0b444cdb | 198 | Alternatively, you can undo the 'git rebase' with |
8978d043 | 199 | |
031321c6 SE |
200 | |
201 | git rebase --abort | |
8978d043 | 202 | |
a9c3821c TAV |
203 | CONFIGURATION |
204 | ------------- | |
205 | ||
946a9f20 | 206 | include::rebase-config.txt[] |
16cf51c7 | 207 | |
7fc9d69f JH |
208 | OPTIONS |
209 | ------- | |
c2145384 | 210 | --onto <newbase>:: |
69a60af5 CW |
211 | Starting point at which to create the new commits. If the |
212 | --onto option is not specified, the starting point is | |
ea81fcc5 SP |
213 | <upstream>. May be any valid commit, and not just an |
214 | existing branch name. | |
873c3472 | 215 | + |
b9190e79 | 216 | As a special case, you may use "A\...B" as a shortcut for the |
873c3472 MG |
217 | merge base of A and B if there is exactly one merge base. You can |
218 | leave out at most one of A and B, in which case it defaults to HEAD. | |
69a60af5 | 219 | |
52a22d1e | 220 | <upstream>:: |
ea81fcc5 | 221 | Upstream branch to compare against. May be any valid commit, |
15a147e6 MZ |
222 | not just an existing branch name. Defaults to the configured |
223 | upstream for the current branch. | |
7fc9d69f | 224 | |
228382ae | 225 | <branch>:: |
52a22d1e | 226 | Working branch; defaults to HEAD. |
7fc9d69f | 227 | |
031321c6 SE |
228 | --continue:: |
229 | Restart the rebasing process after having resolved a merge conflict. | |
230 | ||
231 | --abort:: | |
5960bc9d MZ |
232 | Abort the rebase operation and reset HEAD to the original |
233 | branch. If <branch> was provided when the rebase operation was | |
234 | started, then HEAD will be reset to <branch>. Otherwise HEAD | |
235 | will be reset to where it was when the rebase operation was | |
236 | started. | |
031321c6 | 237 | |
9512177b NTND |
238 | --quit:: |
239 | Abort the rebase operation but HEAD is not reset back to the | |
240 | original branch. The index and working tree are also left | |
241 | unchanged as a result. | |
242 | ||
90e1818f NH |
243 | --keep-empty:: |
244 | Keep the commits that do not change anything from its | |
245 | parents in the result. | |
5dacd4ab EN |
246 | + |
247 | See also INCOMPATIBLE OPTIONS below. | |
90e1818f | 248 | |
a6c612b5 GS |
249 | --allow-empty-message:: |
250 | By default, rebasing commits with an empty message will fail. | |
251 | This option overrides that behavior, allowing commits with empty | |
252 | messages to be rebased. | |
5dacd4ab EN |
253 | + |
254 | See also INCOMPATIBLE OPTIONS below. | |
a6c612b5 | 255 | |
58634dbf EW |
256 | --skip:: |
257 | Restart the rebasing process by skipping the current patch. | |
58634dbf | 258 | |
eb9a7cb4 AW |
259 | --edit-todo:: |
260 | Edit the todo list during an interactive rebase. | |
261 | ||
66335298 NTND |
262 | --show-current-patch:: |
263 | Show the current patch in an interactive rebase or when rebase | |
fbd7a232 NTND |
264 | is stopped because of conflicts. This is the equivalent of |
265 | `git show REBASE_HEAD`. | |
66335298 | 266 | |
3240240f SB |
267 | -m:: |
268 | --merge:: | |
58634dbf EW |
269 | Use merging strategies to rebase. When the recursive (default) merge |
270 | strategy is used, this allows rebase to be aware of renames on the | |
271 | upstream side. | |
31ddd1ee TR |
272 | + |
273 | Note that a rebase merge works by replaying each commit from the working | |
274 | branch on top of the <upstream> branch. Because of this, when a merge | |
275 | conflict happens, the side reported as 'ours' is the so-far rebased | |
276 | series, starting with <upstream>, and 'theirs' is the working branch. In | |
277 | other words, the sides are swapped. | |
5dacd4ab EN |
278 | + |
279 | See also INCOMPATIBLE OPTIONS below. | |
58634dbf | 280 | |
3240240f SB |
281 | -s <strategy>:: |
282 | --strategy=<strategy>:: | |
06f39190 | 283 | Use the given merge strategy. |
0b444cdb | 284 | If there is no `-s` option 'git merge-recursive' is used |
31ddd1ee TR |
285 | instead. This implies --merge. |
286 | + | |
0b444cdb | 287 | Because 'git rebase' replays each commit from the working branch |
31ddd1ee | 288 | on top of the <upstream> branch using the given strategy, using |
5dacd4ab | 289 | the 'ours' strategy simply empties all patches from the <branch>, |
31ddd1ee | 290 | which makes little sense. |
5dacd4ab EN |
291 | + |
292 | See also INCOMPATIBLE OPTIONS below. | |
58634dbf | 293 | |
93ce190c ML |
294 | -X <strategy-option>:: |
295 | --strategy-option=<strategy-option>:: | |
296 | Pass the <strategy-option> through to the merge strategy. | |
6cf378f0 | 297 | This implies `--merge` and, if no strategy has been |
93ce190c | 298 | specified, `-s recursive`. Note the reversal of 'ours' and |
edfbbf7e | 299 | 'theirs' as noted above for the `-m` option. |
5dacd4ab EN |
300 | + |
301 | See also INCOMPATIBLE OPTIONS below. | |
93ce190c | 302 | |
3ee5e540 NV |
303 | -S[<keyid>]:: |
304 | --gpg-sign[=<keyid>]:: | |
2b594bf9 MM |
305 | GPG-sign commits. The `keyid` argument is optional and |
306 | defaults to the committer identity; if specified, it must be | |
307 | stuck to the option without a space. | |
3ee5e540 | 308 | |
0e987a12 SB |
309 | -q:: |
310 | --quiet:: | |
311 | Be quiet. Implies --no-stat. | |
312 | ||
3240240f SB |
313 | -v:: |
314 | --verbose:: | |
a9c3821c TAV |
315 | Be verbose. Implies --stat. |
316 | ||
317 | --stat:: | |
318 | Show a diffstat of what changed upstream since the last rebase. The | |
319 | diffstat is also controlled by the configuration option rebase.stat. | |
320 | ||
321 | -n:: | |
322 | --no-stat:: | |
323 | Do not show a diffstat as part of the rebase process. | |
b758789c | 324 | |
fd631d58 NS |
325 | --no-verify:: |
326 | This option bypasses the pre-rebase hook. See also linkgit:githooks[5]. | |
327 | ||
7baf9c4b MZ |
328 | --verify:: |
329 | Allows the pre-rebase hook to run, which is the default. This option can | |
330 | be used to override --no-verify. See also linkgit:githooks[5]. | |
331 | ||
67dad687 MT |
332 | -C<n>:: |
333 | Ensure at least <n> lines of surrounding context match before | |
334 | and after each change. When fewer lines of surrounding | |
335 | context exist they all must match. By default no context is | |
336 | ever ignored. | |
5dacd4ab EN |
337 | + |
338 | See also INCOMPATIBLE OPTIONS below. | |
67dad687 | 339 | |
983f464f | 340 | --no-ff:: |
5e75d56f | 341 | --force-rebase:: |
983f464f EN |
342 | -f:: |
343 | Individually replay all rebased commits instead of fast-forwarding | |
344 | over the unchanged ones. This ensures that the entire history of | |
345 | the rebased branch is composed of new commits. | |
b4995494 | 346 | + |
983f464f EN |
347 | You may find this helpful after reverting a topic branch merge, as this option |
348 | recreates the topic branch with fresh commits so it can be remerged | |
349 | successfully without needing to "revert the reversion" (see the | |
350 | link:howto/revert-a-faulty-merge.html[revert-a-faulty-merge How-To] for | |
351 | details). | |
5e75d56f | 352 | |
ad8261d2 JK |
353 | --fork-point:: |
354 | --no-fork-point:: | |
f51a48ec SO |
355 | Use reflog to find a better common ancestor between <upstream> |
356 | and <branch> when calculating which commits have been | |
357 | introduced by <branch>. | |
ad8261d2 | 358 | + |
f51a48ec SO |
359 | When --fork-point is active, 'fork_point' will be used instead of |
360 | <upstream> to calculate the set of commits to rebase, where | |
361 | 'fork_point' is the result of `git merge-base --fork-point <upstream> | |
362 | <branch>` command (see linkgit:git-merge-base[1]). If 'fork_point' | |
363 | ends up being empty, the <upstream> will be used as a fallback. | |
364 | + | |
365 | If either <upstream> or --root is given on the command line, then the | |
366 | default is `--no-fork-point`, otherwise the default is `--fork-point`. | |
ad8261d2 | 367 | |
86c91f91 | 368 | --ignore-whitespace:: |
749485f6 | 369 | --whitespace=<option>:: |
0b444cdb | 370 | These flag are passed to the 'git apply' program |
5162e697 | 371 | (see linkgit:git-apply[1]) that applies the patch. |
5dacd4ab EN |
372 | + |
373 | See also INCOMPATIBLE OPTIONS below. | |
059f446d | 374 | |
570ccad3 MB |
375 | --committer-date-is-author-date:: |
376 | --ignore-date:: | |
0b444cdb | 377 | These flags are passed to 'git am' to easily change the dates |
570ccad3 | 378 | of the rebased commits (see linkgit:git-am[1]). |
5dacd4ab EN |
379 | + |
380 | See also INCOMPATIBLE OPTIONS below. | |
570ccad3 | 381 | |
9f79524a | 382 | --signoff:: |
a852ec7f PW |
383 | Add a Signed-off-by: trailer to all the rebased commits. Note |
384 | that if `--interactive` is given then only commits marked to be | |
5dacd4ab EN |
385 | picked, edited or reworded will have the trailer added. |
386 | + | |
387 | See also INCOMPATIBLE OPTIONS below. | |
9f79524a | 388 | |
3240240f SB |
389 | -i:: |
390 | --interactive:: | |
1b1dce4b | 391 | Make a list of the commits which are about to be rebased. Let the |
f0fd889d JS |
392 | user edit that list before rebasing. This mode can also be used to |
393 | split commits (see SPLITTING COMMITS below). | |
16cf51c7 MR |
394 | + |
395 | The commit list format can be changed by setting the configuration option | |
396 | rebase.instructionFormat. A customized instruction format will automatically | |
397 | have the long commit hash prepended to the format. | |
5dacd4ab EN |
398 | + |
399 | See also INCOMPATIBLE OPTIONS below. | |
1b1dce4b | 400 | |
8f6aed71 | 401 | -r:: |
7543f6f4 | 402 | --rebase-merges[=(rebase-cousins|no-rebase-cousins)]:: |
8f6aed71 JS |
403 | By default, a rebase will simply drop merge commits from the todo |
404 | list, and put the rebased commits into a single, linear branch. | |
405 | With `--rebase-merges`, the rebase will instead try to preserve | |
406 | the branching structure within the commits that are to be rebased, | |
407 | by recreating the merge commits. Any resolved merge conflicts or | |
408 | manual amendments in these merge commits will have to be | |
409 | resolved/re-applied manually. | |
410 | + | |
7543f6f4 JS |
411 | By default, or when `no-rebase-cousins` was specified, commits which do not |
412 | have `<upstream>` as direct ancestor will keep their original branch point, | |
413 | i.e. commits that would be excluded by gitlink:git-log[1]'s | |
414 | `--ancestry-path` option will keep their original ancestry by default. If | |
415 | the `rebase-cousins` mode is turned on, such commits are instead rebased | |
416 | onto `<upstream>` (or `<onto>`, if specified). | |
417 | + | |
418 | The `--rebase-merges` mode is similar in spirit to `--preserve-merges`, but | |
419 | in contrast to that option works well in interactive rebases: commits can be | |
420 | reordered, inserted and dropped at will. | |
8f6aed71 JS |
421 | + |
422 | It is currently only possible to recreate the merge commits using the | |
423 | `recursive` merge strategy; Different merge strategies can be used only via | |
424 | explicit `exec git merge -s <strategy> [...]` commands. | |
25cff9f1 | 425 | + |
5dacd4ab | 426 | See also REBASING MERGES and INCOMPATIBLE OPTIONS below. |
8f6aed71 | 427 | |
3240240f SB |
428 | -p:: |
429 | --preserve-merges:: | |
d50d31e8 SS |
430 | Recreate merge commits instead of flattening the history by replaying |
431 | commits a merge commit introduces. Merge conflict resolutions or manual | |
432 | amendments to merge commits are not preserved. | |
cddb42d2 JN |
433 | + |
434 | This uses the `--interactive` machinery internally, but combining it | |
435 | with the `--interactive` option explicitly is generally not a good | |
436 | idea unless you know what you are doing (see BUGS below). | |
5dacd4ab EN |
437 | + |
438 | See also INCOMPATIBLE OPTIONS below. | |
cddb42d2 | 439 | |
c2145384 LK |
440 | -x <cmd>:: |
441 | --exec <cmd>:: | |
442 | Append "exec <cmd>" after each line creating a commit in the | |
443 | final history. <cmd> will be interpreted as one or more shell | |
444 | commands. | |
445 | + | |
c2145384 LK |
446 | You may execute several commands by either using one instance of `--exec` |
447 | with several commands: | |
448 | + | |
449 | git rebase -i --exec "cmd1 && cmd2 && ..." | |
450 | + | |
451 | or by giving more than one `--exec`: | |
452 | + | |
453 | git rebase -i --exec "cmd1" --exec "cmd2" --exec ... | |
454 | + | |
455 | If `--autosquash` is used, "exec" lines will not be appended for | |
456 | the intermediate commits, and will only appear at the end of each | |
457 | squash/fixup series. | |
78ec2400 SB |
458 | + |
459 | This uses the `--interactive` machinery internally, but it can be run | |
460 | without an explicit `--interactive`. | |
5dacd4ab EN |
461 | + |
462 | See also INCOMPATIBLE OPTIONS below. | |
f09c9b8c | 463 | |
be496621 TR |
464 | --root:: |
465 | Rebase all commits reachable from <branch>, instead of | |
466 | limiting them with an <upstream>. This allows you to rebase | |
df5df20c | 467 | the root commit(s) on a branch. When used with --onto, it |
be496621 | 468 | will skip changes already contained in <newbase> (instead of |
df5df20c CW |
469 | <upstream>) whereas without --onto it will operate on every change. |
470 | When used together with both --onto and --preserve-merges, | |
471 | 'all' root commits will be rewritten to have <newbase> as parent | |
be496621 | 472 | instead. |
5dacd4ab EN |
473 | + |
474 | See also INCOMPATIBLE OPTIONS below. | |
be496621 | 475 | |
f59baa50 | 476 | --autosquash:: |
dd1e5b31 | 477 | --no-autosquash:: |
f59baa50 | 478 | When the commit log message begins with "squash! ..." (or |
c44a4c65 JS |
479 | "fixup! ..."), and there is already a commit in the todo list that |
480 | matches the same `...`, automatically modify the todo list of rebase | |
481 | -i so that the commit marked for squashing comes right after the | |
482 | commit to be modified, and change the action of the moved commit | |
483 | from `pick` to `squash` (or `fixup`). A commit matches the `...` if | |
484 | the commit subject matches, or if the `...` refers to the commit's | |
485 | hash. As a fall-back, partial matches of the commit subject work, | |
486 | too. The recommended way to create fixup/squash commits is by using | |
487 | the `--fixup`/`--squash` options of linkgit:git-commit[1]. | |
f59baa50 | 488 | + |
bcf9626a | 489 | If the `--autosquash` option is enabled by default using the |
da0005b8 | 490 | configuration variable `rebase.autoSquash`, this option can be |
dd1e5b31 | 491 | used to override and disable this setting. |
5dacd4ab EN |
492 | + |
493 | See also INCOMPATIBLE OPTIONS below. | |
b4995494 | 494 | |
82e0668c JK |
495 | --autostash:: |
496 | --no-autostash:: | |
e01db917 | 497 | Automatically create a temporary stash entry before the operation |
58794775 RR |
498 | begins, and apply it after the operation ends. This means |
499 | that you can run rebase on a dirty worktree. However, use | |
500 | with care: the final stash application after a successful | |
501 | rebase might result in non-trivial conflicts. | |
502 | ||
5dacd4ab EN |
503 | INCOMPATIBLE OPTIONS |
504 | -------------------- | |
505 | ||
506 | git-rebase has many flags that are incompatible with each other, | |
507 | predominantly due to the fact that it has three different underlying | |
508 | implementations: | |
509 | ||
510 | * one based on linkgit:git-am[1] (the default) | |
511 | * one based on git-merge-recursive (merge backend) | |
512 | * one based on linkgit:git-cherry-pick[1] (interactive backend) | |
513 | ||
514 | Flags only understood by the am backend: | |
515 | ||
516 | * --committer-date-is-author-date | |
517 | * --ignore-date | |
518 | * --whitespace | |
519 | * --ignore-whitespace | |
520 | * -C | |
521 | ||
522 | Flags understood by both merge and interactive backends: | |
523 | ||
524 | * --merge | |
525 | * --strategy | |
526 | * --strategy-option | |
527 | * --allow-empty-message | |
528 | ||
529 | Flags only understood by the interactive backend: | |
530 | ||
531 | * --[no-]autosquash | |
532 | * --rebase-merges | |
533 | * --preserve-merges | |
534 | * --interactive | |
535 | * --exec | |
536 | * --keep-empty | |
537 | * --autosquash | |
538 | * --edit-todo | |
539 | * --root when used in combination with --onto | |
540 | ||
541 | Other incompatible flag pairs: | |
542 | ||
543 | * --preserve-merges and --interactive | |
544 | * --preserve-merges and --signoff | |
545 | * --preserve-merges and --rebase-merges | |
546 | * --rebase-merges and --strategy | |
547 | * --rebase-merges and --strategy-option | |
548 | ||
0661e49a EN |
549 | BEHAVIORAL DIFFERENCES |
550 | ----------------------- | |
551 | ||
552 | * empty commits: | |
553 | ||
554 | am-based rebase will drop any "empty" commits, whether the | |
555 | commit started empty (had no changes relative to its parent to | |
556 | start with) or ended empty (all changes were already applied | |
557 | upstream in other commits). | |
558 | ||
559 | merge-based rebase does the same. | |
560 | ||
561 | interactive-based rebase will by default drop commits that | |
562 | started empty and halt if it hits a commit that ended up empty. | |
563 | The `--keep-empty` option exists for interactive rebases to allow | |
564 | it to keep commits that started empty. | |
565 | ||
0661e49a EN |
566 | * directory rename detection: |
567 | ||
568 | merge-based and interactive-based rebases work fine with | |
569 | directory rename detection. am-based rebases sometimes do not. | |
f59baa50 | 570 | |
58634dbf EW |
571 | include::merge-strategies.txt[] |
572 | ||
031321c6 SE |
573 | NOTES |
574 | ----- | |
90d1c08e | 575 | |
0b444cdb | 576 | You should understand the implications of using 'git rebase' on a |
90d1c08e TR |
577 | repository that you share. See also RECOVERING FROM UPSTREAM REBASE |
578 | below. | |
031321c6 | 579 | |
467c0197 | 580 | When the git-rebase command is run, it will first execute a "pre-rebase" |
031321c6 SE |
581 | hook if one exists. You can use this hook to do sanity checks and |
582 | reject the rebase if it isn't appropriate. Please see the template | |
583 | pre-rebase hook script for an example. | |
584 | ||
702088af | 585 | Upon completion, <branch> will be the current branch. |
031321c6 | 586 | |
1b1dce4b JS |
587 | INTERACTIVE MODE |
588 | ---------------- | |
589 | ||
590 | Rebasing interactively means that you have a chance to edit the commits | |
591 | which are rebased. You can reorder the commits, and you can | |
592 | remove them (weeding out bad or otherwise unwanted patches). | |
593 | ||
594 | The interactive mode is meant for this type of workflow: | |
595 | ||
596 | 1. have a wonderful idea | |
597 | 2. hack on the code | |
598 | 3. prepare a series for submission | |
599 | 4. submit | |
600 | ||
601 | where point 2. consists of several instances of | |
602 | ||
d3f2475c NBL |
603 | a) regular use |
604 | ||
1b1dce4b JS |
605 | 1. finish something worthy of a commit |
606 | 2. commit | |
d3f2475c NBL |
607 | |
608 | b) independent fixup | |
609 | ||
1b1dce4b JS |
610 | 1. realize that something does not work |
611 | 2. fix that | |
612 | 3. commit it | |
613 | ||
614 | Sometimes the thing fixed in b.2. cannot be amended to the not-quite | |
615 | perfect commit it fixes, because that commit is buried deeply in a | |
616 | patch series. That is exactly what interactive rebase is for: use it | |
617 | after plenty of "a"s and "b"s, by rearranging and editing | |
618 | commits, and squashing multiple commits into one. | |
619 | ||
620 | Start it with the last commit you want to retain as-is: | |
621 | ||
622 | git rebase -i <after-this-commit> | |
623 | ||
624 | An editor will be fired up with all the commits in your current branch | |
625 | (ignoring merge commits), which come after the given commit. You can | |
626 | reorder the commits in this list to your heart's content, and you can | |
627 | remove them. The list looks more or less like this: | |
628 | ||
629 | ------------------------------------------- | |
630 | pick deadbee The oneline of this commit | |
631 | pick fa1afe1 The oneline of the next commit | |
632 | ... | |
633 | ------------------------------------------- | |
634 | ||
0b444cdb | 635 | The oneline descriptions are purely for your pleasure; 'git rebase' will |
1b1dce4b JS |
636 | not look at them but at the commit names ("deadbee" and "fa1afe1" in this |
637 | example), so do not delete or edit the names. | |
638 | ||
639 | By replacing the command "pick" with the command "edit", you can tell | |
0b444cdb | 640 | 'git rebase' to stop after applying that commit, so that you can edit |
1b1dce4b JS |
641 | the files and/or the commit message, amend the commit, and continue |
642 | rebasing. | |
643 | ||
6741aa6c BG |
644 | If you just want to edit the commit message for a commit, replace the |
645 | command "pick" with the command "reword". | |
646 | ||
c9266d58 GR |
647 | To drop a commit, replace the command "pick" with "drop", or just |
648 | delete the matching line. | |
649 | ||
1b1dce4b | 650 | If you want to fold two or more commits into one, replace the command |
0205e72f MH |
651 | "pick" for the second and subsequent commits with "squash" or "fixup". |
652 | If the commits had different authors, the folded commit will be | |
653 | attributed to the author of the first commit. The suggested commit | |
654 | message for the folded commit is the concatenation of the commit | |
655 | messages of the first commit and of those with the "squash" command, | |
656 | but omits the commit messages of commits with the "fixup" command. | |
1b1dce4b | 657 | |
0b444cdb | 658 | 'git rebase' will stop when "pick" has been replaced with "edit" or |
6741aa6c BG |
659 | when a command fails due to merge errors. When you are done editing |
660 | and/or resolving conflicts you can continue with `git rebase --continue`. | |
1b1dce4b JS |
661 | |
662 | For example, if you want to reorder the last 5 commits, such that what | |
663 | was HEAD~4 becomes the new HEAD. To achieve that, you would call | |
0b444cdb | 664 | 'git rebase' like this: |
1b1dce4b JS |
665 | |
666 | ---------------------- | |
667 | $ git rebase -i HEAD~5 | |
668 | ---------------------- | |
669 | ||
670 | And move the first patch to the end of the list. | |
671 | ||
f09c9b8c JS |
672 | You might want to preserve merges, if you have a history like this: |
673 | ||
674 | ------------------ | |
675 | X | |
676 | \ | |
677 | A---M---B | |
678 | / | |
679 | ---o---O---P---Q | |
680 | ------------------ | |
681 | ||
682 | Suppose you want to rebase the side branch starting at "A" to "Q". Make | |
683 | sure that the current HEAD is "B", and call | |
684 | ||
685 | ----------------------------- | |
686 | $ git rebase -i -p --onto Q O | |
687 | ----------------------------- | |
688 | ||
cd035b1c MM |
689 | Reordering and editing commits usually creates untested intermediate |
690 | steps. You may want to check that your history editing did not break | |
691 | anything by running a test, or at least recompiling at intermediate | |
692 | points in history by using the "exec" command (shortcut "x"). You may | |
693 | do so by creating a todo list like this one: | |
694 | ||
695 | ------------------------------------------- | |
696 | pick deadbee Implement feature XXX | |
697 | fixup f1a5c00 Fix to feature XXX | |
698 | exec make | |
699 | pick c0ffeee The oneline of the next commit | |
700 | edit deadbab The oneline of the commit after | |
701 | exec cd subdir; make test | |
702 | ... | |
703 | ------------------------------------------- | |
704 | ||
705 | The interactive rebase will stop when a command fails (i.e. exits with | |
706 | non-0 status) to give you an opportunity to fix the problem. You can | |
707 | continue with `git rebase --continue`. | |
708 | ||
709 | The "exec" command launches the command in a shell (the one specified | |
710 | in `$SHELL`, or the default shell if `$SHELL` is not set), so you can | |
711 | use shell features (like "cd", ">", ";" ...). The command is run from | |
712 | the root of the working tree. | |
f0fd889d | 713 | |
c2145384 LK |
714 | ---------------------------------- |
715 | $ git rebase -i --exec "make test" | |
716 | ---------------------------------- | |
717 | ||
718 | This command lets you check that intermediate commits are compilable. | |
719 | The todo list becomes like that: | |
720 | ||
721 | -------------------- | |
722 | pick 5928aea one | |
723 | exec make test | |
724 | pick 04d0fda two | |
725 | exec make test | |
726 | pick ba46169 three | |
727 | exec make test | |
728 | pick f4593f9 four | |
729 | exec make test | |
730 | -------------------- | |
731 | ||
f0fd889d JS |
732 | SPLITTING COMMITS |
733 | ----------------- | |
734 | ||
735 | In interactive mode, you can mark commits with the action "edit". However, | |
0b444cdb | 736 | this does not necessarily mean that 'git rebase' expects the result of this |
f0fd889d JS |
737 | edit to be exactly one commit. Indeed, you can undo the commit, or you can |
738 | add other commits. This can be used to split a commit into two: | |
739 | ||
483bc4f0 | 740 | - Start an interactive rebase with `git rebase -i <commit>^`, where |
f0fd889d JS |
741 | <commit> is the commit you want to split. In fact, any commit range |
742 | will do, as long as it contains that commit. | |
743 | ||
744 | - Mark the commit you want to split with the action "edit". | |
745 | ||
483bc4f0 | 746 | - When it comes to editing that commit, execute `git reset HEAD^`. The |
f0fd889d JS |
747 | effect is that the HEAD is rewound by one, and the index follows suit. |
748 | However, the working tree stays the same. | |
749 | ||
750 | - Now add the changes to the index that you want to have in the first | |
483bc4f0 | 751 | commit. You can use `git add` (possibly interactively) or |
0b444cdb | 752 | 'git gui' (or both) to do that. |
f0fd889d JS |
753 | |
754 | - Commit the now-current index with whatever commit message is appropriate | |
755 | now. | |
756 | ||
757 | - Repeat the last two steps until your working tree is clean. | |
758 | ||
483bc4f0 | 759 | - Continue the rebase with `git rebase --continue`. |
f0fd889d JS |
760 | |
761 | If you are not absolutely sure that the intermediate revisions are | |
762 | consistent (they compile, pass the testsuite, etc.) you should use | |
0b444cdb | 763 | 'git stash' to stash away the not-yet-committed changes |
f0fd889d JS |
764 | after each commit, test, and amend the commit if fixes are necessary. |
765 | ||
766 | ||
90d1c08e TR |
767 | RECOVERING FROM UPSTREAM REBASE |
768 | ------------------------------- | |
769 | ||
770 | Rebasing (or any other form of rewriting) a branch that others have | |
771 | based work on is a bad idea: anyone downstream of it is forced to | |
772 | manually fix their history. This section explains how to do the fix | |
773 | from the downstream's point of view. The real fix, however, would be | |
774 | to avoid rebasing the upstream in the first place. | |
775 | ||
776 | To illustrate, suppose you are in a situation where someone develops a | |
777 | 'subsystem' branch, and you are working on a 'topic' that is dependent | |
778 | on this 'subsystem'. You might end up with a history like the | |
779 | following: | |
780 | ||
781 | ------------ | |
01826066 | 782 | o---o---o---o---o---o---o---o master |
90d1c08e TR |
783 | \ |
784 | o---o---o---o---o subsystem | |
785 | \ | |
786 | *---*---* topic | |
787 | ------------ | |
788 | ||
789 | If 'subsystem' is rebased against 'master', the following happens: | |
790 | ||
791 | ------------ | |
792 | o---o---o---o---o---o---o---o master | |
793 | \ \ | |
794 | o---o---o---o---o o'--o'--o'--o'--o' subsystem | |
795 | \ | |
796 | *---*---* topic | |
797 | ------------ | |
798 | ||
799 | If you now continue development as usual, and eventually merge 'topic' | |
800 | to 'subsystem', the commits from 'subsystem' will remain duplicated forever: | |
801 | ||
802 | ------------ | |
803 | o---o---o---o---o---o---o---o master | |
804 | \ \ | |
805 | o---o---o---o---o o'--o'--o'--o'--o'--M subsystem | |
806 | \ / | |
807 | *---*---*-..........-*--* topic | |
808 | ------------ | |
809 | ||
810 | Such duplicates are generally frowned upon because they clutter up | |
811 | history, making it harder to follow. To clean things up, you need to | |
812 | transplant the commits on 'topic' to the new 'subsystem' tip, i.e., | |
813 | rebase 'topic'. This becomes a ripple effect: anyone downstream from | |
814 | 'topic' is forced to rebase too, and so on! | |
815 | ||
816 | There are two kinds of fixes, discussed in the following subsections: | |
817 | ||
818 | Easy case: The changes are literally the same.:: | |
819 | ||
820 | This happens if the 'subsystem' rebase was a simple rebase and | |
821 | had no conflicts. | |
822 | ||
823 | Hard case: The changes are not the same.:: | |
824 | ||
825 | This happens if the 'subsystem' rebase had conflicts, or used | |
6cf378f0 JK |
826 | `--interactive` to omit, edit, squash, or fixup commits; or |
827 | if the upstream used one of `commit --amend`, `reset`, or | |
90d1c08e TR |
828 | `filter-branch`. |
829 | ||
830 | ||
831 | The easy case | |
832 | ~~~~~~~~~~~~~ | |
833 | ||
834 | Only works if the changes (patch IDs based on the diff contents) on | |
835 | 'subsystem' are literally the same before and after the rebase | |
836 | 'subsystem' did. | |
837 | ||
0b444cdb | 838 | In that case, the fix is easy because 'git rebase' knows to skip |
90d1c08e TR |
839 | changes that are already present in the new upstream. So if you say |
840 | (assuming you're on 'topic') | |
841 | ------------ | |
842 | $ git rebase subsystem | |
843 | ------------ | |
844 | you will end up with the fixed history | |
845 | ------------ | |
846 | o---o---o---o---o---o---o---o master | |
847 | \ | |
848 | o'--o'--o'--o'--o' subsystem | |
849 | \ | |
850 | *---*---* topic | |
851 | ------------ | |
852 | ||
853 | ||
854 | The hard case | |
855 | ~~~~~~~~~~~~~ | |
856 | ||
857 | Things get more complicated if the 'subsystem' changes do not exactly | |
858 | correspond to the ones before the rebase. | |
859 | ||
860 | NOTE: While an "easy case recovery" sometimes appears to be successful | |
861 | even in the hard case, it may have unintended consequences. For | |
862 | example, a commit that was removed via `git rebase | |
6cf378f0 | 863 | --interactive` will be **resurrected**! |
90d1c08e | 864 | |
0b444cdb | 865 | The idea is to manually tell 'git rebase' "where the old 'subsystem' |
90d1c08e TR |
866 | ended and your 'topic' began", that is, what the old merge-base |
867 | between them was. You will have to find a way to name the last commit | |
868 | of the old 'subsystem', for example: | |
869 | ||
0b444cdb | 870 | * With the 'subsystem' reflog: after 'git fetch', the old tip of |
6cf378f0 | 871 | 'subsystem' is at `subsystem@{1}`. Subsequent fetches will |
90d1c08e TR |
872 | increase the number. (See linkgit:git-reflog[1].) |
873 | ||
874 | * Relative to the tip of 'topic': knowing that your 'topic' has three | |
875 | commits, the old tip of 'subsystem' must be `topic~3`. | |
876 | ||
877 | You can then transplant the old `subsystem..topic` to the new tip by | |
878 | saying (for the reflog case, and assuming you are on 'topic' already): | |
879 | ------------ | |
880 | $ git rebase --onto subsystem subsystem@{1} | |
881 | ------------ | |
882 | ||
883 | The ripple effect of a "hard case" recovery is especially bad: | |
884 | 'everyone' downstream from 'topic' will now have to perform a "hard | |
885 | case" recovery too! | |
886 | ||
25cff9f1 | 887 | REBASING MERGES |
81d395cc | 888 | --------------- |
25cff9f1 JS |
889 | |
890 | The interactive rebase command was originally designed to handle | |
891 | individual patch series. As such, it makes sense to exclude merge | |
892 | commits from the todo list, as the developer may have merged the | |
893 | then-current `master` while working on the branch, only to rebase | |
894 | all the commits onto `master` eventually (skipping the merge | |
895 | commits). | |
896 | ||
897 | However, there are legitimate reasons why a developer may want to | |
898 | recreate merge commits: to keep the branch structure (or "commit | |
899 | topology") when working on multiple, inter-related branches. | |
900 | ||
901 | In the following example, the developer works on a topic branch that | |
902 | refactors the way buttons are defined, and on another topic branch | |
903 | that uses that refactoring to implement a "Report a bug" button. The | |
904 | output of `git log --graph --format=%s -5` may look like this: | |
905 | ||
906 | ------------ | |
907 | * Merge branch 'report-a-bug' | |
908 | |\ | |
909 | | * Add the feedback button | |
910 | * | Merge branch 'refactor-button' | |
911 | |\ \ | |
912 | | |/ | |
913 | | * Use the Button class for all buttons | |
914 | | * Extract a generic Button class from the DownloadButton one | |
915 | ------------ | |
916 | ||
917 | The developer might want to rebase those commits to a newer `master` | |
918 | while keeping the branch topology, for example when the first topic | |
919 | branch is expected to be integrated into `master` much earlier than the | |
920 | second one, say, to resolve merge conflicts with changes to the | |
921 | DownloadButton class that made it into `master`. | |
922 | ||
923 | This rebase can be performed using the `--rebase-merges` option. | |
924 | It will generate a todo list looking like this: | |
925 | ||
926 | ------------ | |
927 | label onto | |
928 | ||
929 | # Branch: refactor-button | |
930 | reset onto | |
931 | pick 123456 Extract a generic Button class from the DownloadButton one | |
932 | pick 654321 Use the Button class for all buttons | |
933 | label refactor-button | |
934 | ||
935 | # Branch: report-a-bug | |
936 | reset refactor-button # Use the Button class for all buttons | |
937 | pick abcdef Add the feedback button | |
938 | label report-a-bug | |
939 | ||
940 | reset onto | |
941 | merge -C a1b2c3 refactor-button # Merge 'refactor-button' | |
942 | merge -C 6f5e4d report-a-bug # Merge 'report-a-bug' | |
943 | ------------ | |
944 | ||
945 | In contrast to a regular interactive rebase, there are `label`, `reset` | |
946 | and `merge` commands in addition to `pick` ones. | |
947 | ||
948 | The `label` command associates a label with the current HEAD when that | |
949 | command is executed. These labels are created as worktree-local refs | |
950 | (`refs/rewritten/<label>`) that will be deleted when the rebase | |
951 | finishes. That way, rebase operations in multiple worktrees linked to | |
952 | the same repository do not interfere with one another. If the `label` | |
953 | command fails, it is rescheduled immediately, with a helpful message how | |
954 | to proceed. | |
955 | ||
956 | The `reset` command resets the HEAD, index and worktree to the specified | |
957 | revision. It is isimilar to an `exec git reset --hard <label>`, but | |
958 | refuses to overwrite untracked files. If the `reset` command fails, it is | |
959 | rescheduled immediately, with a helpful message how to edit the todo list | |
960 | (this typically happens when a `reset` command was inserted into the todo | |
961 | list manually and contains a typo). | |
962 | ||
caafecfc JS |
963 | The `merge` command will merge the specified revision(s) into whatever |
964 | is HEAD at that time. With `-C <original-commit>`, the commit message of | |
25cff9f1 JS |
965 | the specified merge commit will be used. When the `-C` is changed to |
966 | a lower-case `-c`, the message will be opened in an editor after a | |
967 | successful merge so that the user can edit the message. | |
968 | ||
969 | If a `merge` command fails for any reason other than merge conflicts (i.e. | |
970 | when the merge operation did not even start), it is rescheduled immediately. | |
971 | ||
972 | At this time, the `merge` command will *always* use the `recursive` | |
caafecfc JS |
973 | merge strategy for regular merges, and `octopus` for octopus merges, |
974 | strategy, with no way to choose a different one. To work around | |
25cff9f1 JS |
975 | this, an `exec` command can be used to call `git merge` explicitly, |
976 | using the fact that the labels are worktree-local refs (the ref | |
977 | `refs/rewritten/onto` would correspond to the label `onto`, for example). | |
978 | ||
979 | Note: the first command (`label onto`) labels the revision onto which | |
980 | the commits are rebased; The name `onto` is just a convention, as a nod | |
981 | to the `--onto` option. | |
982 | ||
983 | It is also possible to introduce completely new merge commits from scratch | |
984 | by adding a command of the form `merge <merge-head>`. This form will | |
985 | generate a tentative commit message and always open an editor to let the | |
986 | user edit it. This can be useful e.g. when a topic branch turns out to | |
987 | address more than a single concern and wants to be split into two or | |
988 | even more topic branches. Consider this todo list: | |
989 | ||
990 | ------------ | |
991 | pick 192837 Switch from GNU Makefiles to CMake | |
992 | pick 5a6c7e Document the switch to CMake | |
993 | pick 918273 Fix detection of OpenSSL in CMake | |
994 | pick afbecd http: add support for TLS v1.3 | |
995 | pick fdbaec Fix detection of cURL in CMake on Windows | |
996 | ------------ | |
997 | ||
998 | The one commit in this list that is not related to CMake may very well | |
999 | have been motivated by working on fixing all those bugs introduced by | |
1000 | switching to CMake, but it addresses a different concern. To split this | |
1001 | branch into two topic branches, the todo list could be edited like this: | |
1002 | ||
1003 | ------------ | |
1004 | label onto | |
1005 | ||
1006 | pick afbecd http: add support for TLS v1.3 | |
1007 | label tlsv1.3 | |
1008 | ||
1009 | reset onto | |
1010 | pick 192837 Switch from GNU Makefiles to CMake | |
1011 | pick 918273 Fix detection of OpenSSL in CMake | |
1012 | pick fdbaec Fix detection of cURL in CMake on Windows | |
1013 | pick 5a6c7e Document the switch to CMake | |
1014 | label cmake | |
1015 | ||
1016 | reset onto | |
1017 | merge tlsv1.3 | |
1018 | merge cmake | |
1019 | ------------ | |
1020 | ||
cddb42d2 JN |
1021 | BUGS |
1022 | ---- | |
1023 | The todo list presented by `--preserve-merges --interactive` does not | |
1024 | represent the topology of the revision graph. Editing commits and | |
1025 | rewording their commit messages should work fine, but attempts to | |
8f6aed71 JS |
1026 | reorder commits tend to produce counterintuitive results. Use |
1027 | `--rebase-merges` in such scenarios instead. | |
cddb42d2 JN |
1028 | |
1029 | For example, an attempt to rearrange | |
1030 | ------------ | |
1031 | 1 --- 2 --- 3 --- 4 --- 5 | |
1032 | ------------ | |
1033 | to | |
1034 | ------------ | |
1035 | 1 --- 2 --- 4 --- 3 --- 5 | |
1036 | ------------ | |
1037 | by moving the "pick 4" line will result in the following history: | |
1038 | ------------ | |
1039 | 3 | |
1040 | / | |
1041 | 1 --- 2 --- 4 --- 5 | |
1042 | ------------ | |
1043 | ||
7fc9d69f JH |
1044 | GIT |
1045 | --- | |
9e1f0a85 | 1046 | Part of the linkgit:git[1] suite |