| blob | c1b4f7fec1fcc388c237a5232edcb7b5c767ba0b |
1 '\" t
2 .\" Title: git-rebase
3 .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: 2023-05-17
6 .\" Manual: Git Manual
7 .\" Source: Git 2.41.0.rc0.4.g004e0f790f
8 .\" Language: English
9 .\"
10 .TH "GIT\-REBASE" "1" "2023\-05\-17" "Git 2\&.41\&.0\&.rc0\&.4\&.g00" "Git Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 git-rebase \- Reapply commits on top of another base tip
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 \fIgit rebase\fR [\-i | \-\-interactive] [<options>] [\-\-exec <cmd>]
36 [\-\-onto <newbase> | \-\-keep\-base] [<upstream> [<branch>]]
37 \fIgit rebase\fR [\-i | \-\-interactive] [<options>] [\-\-exec <cmd>] [\-\-onto <newbase>]
38 \-\-root [<branch>]
39 \fIgit rebase\fR (\-\-continue | \-\-skip | \-\-abort | \-\-quit | \-\-edit\-todo | \-\-show\-current\-patch)
40 .fi
41 .sp
42 .SH "DESCRIPTION"
43 .sp
44 If \fB<branch>\fR is specified, \fBgit rebase\fR will perform an automatic \fBgit switch <branch>\fR before doing anything else\&. Otherwise it remains on the current branch\&.
45 .sp
46 If \fB<upstream>\fR is not specified, the upstream configured in \fBbranch\&.<name>\&.remote\fR and \fBbranch\&.<name>\&.merge\fR options will be used (see \fBgit-config\fR(1) for details) and the \fB\-\-fork\-point\fR option is assumed\&. If you are currently not on any branch or if the current branch does not have a configured upstream, the rebase will abort\&.
47 .sp
48 All changes made by commits in the current branch but that are not in \fB<upstream>\fR are saved to a temporary area\&. This is the same set of commits that would be shown by \fBgit log <upstream>\&.\&.HEAD\fR; or by \fBgit log \*(Aqfork_point\*(Aq\&.\&.HEAD\fR, if \fB\-\-fork\-point\fR is active (see the description on \fB\-\-fork\-point\fR below); or by \fBgit log HEAD\fR, if the \fB\-\-root\fR option is specified\&.
49 .sp
50 The current branch is reset to \fB<upstream>\fR or \fB<newbase>\fR if the \fB\-\-onto\fR option was supplied\&. This has the exact same effect as \fBgit reset \-\-hard <upstream>\fR (or \fB<newbase>\fR)\&. \fBORIG_HEAD\fR is set to point at the tip of the branch before the reset\&.
51 .if n \{\
52 .sp
53 .\}
54 .RS 4
55 .it 1 an-trap
56 .nr an-no-space-flag 1
57 .nr an-break-flag 1
58 .br
59 .ps +1
60 \fBNote\fR
61 .ps -1
62 .br
63 .sp
64 \fBORIG_HEAD\fR is not guaranteed to still point to the previous branch tip at the end of the rebase if other commands that write that pseudo\-ref (e\&.g\&. \fBgit reset\fR) are used during the rebase\&. The previous branch tip, however, is accessible using the reflog of the current branch (i\&.e\&. \fB@{1}\fR, see \fBgitrevisions\fR(7))\&.
65 .sp .5v
66 .RE
67 .sp
68 The commits that were previously saved into the temporary area are then reapplied to the current branch, one by one, in order\&. Note that any commits in \fBHEAD\fR which introduce the same textual changes as a commit in \fBHEAD\&.\&.<upstream>\fR are omitted (i\&.e\&., a patch already accepted upstream with a different commit message or timestamp will be skipped)\&.
69 .sp
70 It is possible that a merge failure will prevent this process from being completely automatic\&. You will have to resolve any such merge failure and run \fBgit rebase \-\-continue\fR\&. Another option is to bypass the commit that caused the merge failure with \fBgit rebase \-\-skip\fR\&. To check out the original \fB<branch>\fR and remove the \fB\&.git/rebase\-apply\fR working files, use the command \fBgit rebase \-\-abort\fR instead\&.
71 .sp
72 Assume the following history exists and the current branch is "topic":
73 .sp
74 .if n \{\
75 .RS 4
76 .\}
77 .nf
78 A\-\-\-B\-\-\-C topic
79 /
80 D\-\-\-E\-\-\-F\-\-\-G master
81 .fi
82 .if n \{\
83 .RE
84 .\}
85 .sp
86 .sp
87 From this point, the result of either of the following commands:
88 .sp
89 .if n \{\
90 .RS 4
91 .\}
92 .nf
93 git rebase master
94 git rebase master topic
95 .fi
96 .if n \{\
97 .RE
98 .\}
99 .sp
100 would be:
101 .sp
102 .if n \{\
103 .RS 4
104 .\}
105 .nf
106 A\*(Aq\-\-B\*(Aq\-\-C\*(Aq topic
107 /
108 D\-\-\-E\-\-\-F\-\-\-G master
109 .fi
110 .if n \{\
111 .RE
112 .\}
113 .sp
114 .sp
115 \fBNOTE:\fR The latter form is just a short\-hand of \fBgit checkout topic\fR followed by \fBgit rebase master\fR\&. When rebase exits \fBtopic\fR will remain the checked\-out branch\&.
116 .sp
117 If the upstream branch already contains a change you have made (e\&.g\&., because you mailed a patch which was applied upstream), then that commit will be skipped and warnings will be issued (if the \fImerge\fR backend is used)\&. For example, running \fBgit rebase master\fR on the following history (in which \fBA\*(Aq\fR and \fBA\fR introduce the same set of changes, but have different committer information):
118 .sp
119 .if n \{\
120 .RS 4
121 .\}
122 .nf
123 A\-\-\-B\-\-\-C topic
124 /
125 D\-\-\-E\-\-\-A\*(Aq\-\-\-F master
126 .fi
127 .if n \{\
128 .RE
129 .\}
130 .sp
131 .sp
132 will result in:
133 .sp
134 .if n \{\
135 .RS 4
136 .\}
137 .nf
138 B\*(Aq\-\-\-C\*(Aq topic
139 /
140 D\-\-\-E\-\-\-A\*(Aq\-\-\-F master
141 .fi
142 .if n \{\
143 .RE
144 .\}
145 .sp
146 .sp
147 Here is how you would transplant a topic branch based on one branch to another, to pretend that you forked the topic branch from the latter branch, using \fBrebase \-\-onto\fR\&.
148 .sp
149 First let\(cqs assume your \fItopic\fR is based on branch \fInext\fR\&. For example, a feature developed in \fItopic\fR depends on some functionality which is found in \fInext\fR\&.
150 .sp
151 .if n \{\
152 .RS 4
153 .\}
154 .nf
155 o\-\-\-o\-\-\-o\-\-\-o\-\-\-o master
156 \e
157 o\-\-\-o\-\-\-o\-\-\-o\-\-\-o next
158 \e
159 o\-\-\-o\-\-\-o topic
160 .fi
161 .if n \{\
162 .RE
163 .\}
164 .sp
165 .sp
166 We want to make \fItopic\fR forked from branch \fImaster\fR; for example, because the functionality on which \fItopic\fR depends was merged into the more stable \fImaster\fR branch\&. We want our tree to look like this:
167 .sp
168 .if n \{\
169 .RS 4
170 .\}
171 .nf
172 o\-\-\-o\-\-\-o\-\-\-o\-\-\-o master
173 | \e
174 | o\*(Aq\-\-o\*(Aq\-\-o\*(Aq topic
175 \e
176 o\-\-\-o\-\-\-o\-\-\-o\-\-\-o next
177 .fi
178 .if n \{\
179 .RE
180 .\}
181 .sp
182 .sp
183 We can get this using the following command:
184 .sp
185 .if n \{\
186 .RS 4
187 .\}
188 .nf
189 git rebase \-\-onto master next topic
190 .fi
191 .if n \{\
192 .RE
193 .\}
194 .sp
195 Another example of \-\-onto option is to rebase part of a branch\&. If we have the following situation:
196 .sp
197 .if n \{\
198 .RS 4
199 .\}
200 .nf
201 H\-\-\-I\-\-\-J topicB
202 /
203 E\-\-\-F\-\-\-G topicA
204 /
205 A\-\-\-B\-\-\-C\-\-\-D master
206 .fi
207 .if n \{\
208 .RE
209 .\}
210 .sp
211 .sp
212 then the command
213 .sp
214 .if n \{\
215 .RS 4
216 .\}
217 .nf
218 git rebase \-\-onto master topicA topicB
219 .fi
220 .if n \{\
221 .RE
222 .\}
223 .sp
224 would result in:
225 .sp
226 .if n \{\
227 .RS 4
228 .\}
229 .nf
230 H\*(Aq\-\-I\*(Aq\-\-J\*(Aq topicB
231 /
232 | E\-\-\-F\-\-\-G topicA
233 |/
234 A\-\-\-B\-\-\-C\-\-\-D master
235 .fi
236 .if n \{\
237 .RE
238 .\}
239 .sp
240 .sp
241 This is useful when topicB does not depend on topicA\&.
242 .sp
243 A range of commits could also be removed with rebase\&. If we have the following situation:
244 .sp
245 .if n \{\
246 .RS 4
247 .\}
248 .nf
249 E\-\-\-F\-\-\-G\-\-\-H\-\-\-I\-\-\-J topicA
250 .fi
251 .if n \{\
252 .RE
253 .\}
254 .sp
255 .sp
256 then the command
257 .sp
258 .if n \{\
259 .RS 4
260 .\}
261 .nf
262 git rebase \-\-onto topicA~5 topicA~3 topicA
263 .fi
264 .if n \{\
265 .RE
266 .\}
267 .sp
268 would result in the removal of commits F and G:
269 .sp
270 .if n \{\
271 .RS 4
272 .\}
273 .nf
274 E\-\-\-H\*(Aq\-\-\-I\*(Aq\-\-\-J\*(Aq topicA
275 .fi
276 .if n \{\
277 .RE
278 .\}
279 .sp
280 .sp
281 This is useful if F and G were flawed in some way, or should not be part of topicA\&. Note that the argument to \fB\-\-onto\fR and the \fB<upstream>\fR parameter can be any valid commit\-ish\&.
282 .sp
283 In case of conflict, \fBgit rebase\fR will stop at the first problematic commit and leave conflict markers in the tree\&. You can use \fBgit diff\fR to locate the markers (<<<<<<) and make edits to resolve the conflict\&. For each file you edit, you need to tell Git that the conflict has been resolved, typically this would be done with
284 .sp
285 .if n \{\
286 .RS 4
287 .\}
288 .nf
289 git add <filename>
290 .fi
291 .if n \{\
292 .RE
293 .\}
294 .sp
295 After resolving the conflict manually and updating the index with the desired resolution, you can continue the rebasing process with
296 .sp
297 .if n \{\
298 .RS 4
299 .\}
300 .nf
301 git rebase \-\-continue
302 .fi
303 .if n \{\
304 .RE
305 .\}
306 .sp
307 Alternatively, you can undo the \fIgit rebase\fR with
308 .sp
309 .if n \{\
310 .RS 4
311 .\}
312 .nf
313 git rebase \-\-abort
314 .fi
315 .if n \{\
316 .RE
317 .\}
318 .SH "MODE OPTIONS"
319 .sp
320 The options in this section cannot be used with any other option, including not with each other:
321 .PP
322 \-\-continue
323 .RS 4
324 Restart the rebasing process after having resolved a merge conflict\&.
325 .RE
326 .PP
327 \-\-skip
328 .RS 4
329 Restart the rebasing process by skipping the current patch\&.
330 .RE
331 .PP
332 \-\-abort
333 .RS 4
334 Abort the rebase operation and reset HEAD to the original branch\&. If
335 \fB<branch>\fR
336 was provided when the rebase operation was started, then
337 \fBHEAD\fR
338 will be reset to
339 \fB<branch>\fR\&. Otherwise
340 \fBHEAD\fR
341 will be reset to where it was when the rebase operation was started\&.
342 .RE
343 .PP
344 \-\-quit
345 .RS 4
346 Abort the rebase operation but
347 \fBHEAD\fR
348 is not reset back to the original branch\&. The index and working tree are also left unchanged as a result\&. If a temporary stash entry was created using
349 \fB\-\-autostash\fR, it will be saved to the stash list\&.
350 .RE
351 .PP
352 \-\-edit\-todo
353 .RS 4
354 Edit the todo list during an interactive rebase\&.
355 .RE
356 .PP
357 \-\-show\-current\-patch
358 .RS 4
359 Show the current patch in an interactive rebase or when rebase is stopped because of conflicts\&. This is the equivalent of
360 \fBgit show REBASE_HEAD\fR\&.
361 .RE
362 .SH "OPTIONS"
363 .PP
364 \-\-onto <newbase>
365 .RS 4
366 Starting point at which to create the new commits\&. If the
367 \fB\-\-onto\fR
368 option is not specified, the starting point is
369 \fB<upstream>\fR\&. May be any valid commit, and not just an existing branch name\&.
370 .sp
371 As a special case, you may use "A\&.\&.\&.B" as a shortcut for the merge base of A and B if there is exactly one merge base\&. You can leave out at most one of A and B, in which case it defaults to HEAD\&.
372 .RE
373 .PP
374 \-\-keep\-base
375 .RS 4
376 Set the starting point at which to create the new commits to the merge base of
377 \fB<upstream>\fR
378 and
379 \fB<branch>\fR\&. Running
380 \fBgit rebase \-\-keep\-base <upstream> <branch>\fR
381 is equivalent to running
382 \fBgit rebase \-\-reapply\-cherry\-picks \-\-no\-fork\-point \-\-onto <upstream>\&.\&.\&.<branch> <upstream> <branch>\fR\&.
383 .sp
384 This option is useful in the case where one is developing a feature on top of an upstream branch\&. While the feature is being worked on, the upstream branch may advance and it may not be the best idea to keep rebasing on top of the upstream but to keep the base commit as\-is\&. As the base commit is unchanged this option implies
385 \fB\-\-reapply\-cherry\-picks\fR
386 to avoid losing commits\&.
387 .sp
388 Although both this option and
389 \fB\-\-fork\-point\fR
390 find the merge base between
391 \fB<upstream>\fR
392 and
393 \fB<branch>\fR, this option uses the merge base as the
394 \fIstarting point\fR
395 on which new commits will be created, whereas
396 \fB\-\-fork\-point\fR
397 uses the merge base to determine the
398 \fIset of commits\fR
399 which will be rebased\&.
400 .sp
401 See also INCOMPATIBLE OPTIONS below\&.
402 .RE
403 .PP
404 <upstream>
405 .RS 4
406 Upstream branch to compare against\&. May be any valid commit, not just an existing branch name\&. Defaults to the configured upstream for the current branch\&.
407 .RE
408 .PP
409 <branch>
410 .RS 4
411 Working branch; defaults to
412 \fBHEAD\fR\&.
413 .RE
414 .PP
415 \-\-apply
416 .RS 4
417 Use applying strategies to rebase (calling
418 \fBgit\-am\fR
419 internally)\&. This option may become a no\-op in the future once the merge backend handles everything the apply one does\&.
420 .sp
421 See also INCOMPATIBLE OPTIONS below\&.
422 .RE
423 .PP
424 \-\-empty={drop,keep,ask}
425 .RS 4
426 How to handle commits that are not empty to start and are not clean cherry\-picks of any upstream commit, but which become empty after rebasing (because they contain a subset of already upstream changes)\&. With drop (the default), commits that become empty are dropped\&. With keep, such commits are kept\&. With ask (implied by
427 \fB\-\-interactive\fR), the rebase will halt when an empty commit is applied allowing you to choose whether to drop it, edit files more, or just commit the empty changes\&. Other options, like
428 \fB\-\-exec\fR, will use the default of drop unless
429 \fB\-i\fR/\fB\-\-interactive\fR
430 is explicitly specified\&.
431 .sp
432 Note that commits which start empty are kept (unless
433 \fB\-\-no\-keep\-empty\fR
434 is specified), and commits which are clean cherry\-picks (as determined by
435 \fBgit log \-\-cherry\-mark \&.\&.\&.\fR) are detected and dropped as a preliminary step (unless
436 \fB\-\-reapply\-cherry\-picks\fR
437 or
438 \fB\-\-keep\-base\fR
439 is passed)\&.
440 .sp
441 See also INCOMPATIBLE OPTIONS below\&.
442 .RE
443 .PP
444 \-\-no\-keep\-empty, \-\-keep\-empty
445 .RS 4
446 Do not keep commits that start empty before the rebase (i\&.e\&. that do not change anything from its parent) in the result\&. The default is to keep commits which start empty, since creating such commits requires passing the
447 \fB\-\-allow\-empty\fR
448 override flag to
449 \fBgit commit\fR, signifying that a user is very intentionally creating such a commit and thus wants to keep it\&.
450 .sp
451 Usage of this flag will probably be rare, since you can get rid of commits that start empty by just firing up an interactive rebase and removing the lines corresponding to the commits you don\(cqt want\&. This flag exists as a convenient shortcut, such as for cases where external tools generate many empty commits and you want them all removed\&.
452 .sp
453 For commits which do not start empty but become empty after rebasing, see the
454 \fB\-\-empty\fR
455 flag\&.
456 .sp
457 See also INCOMPATIBLE OPTIONS below\&.
458 .RE
459 .PP
460 \-\-reapply\-cherry\-picks, \-\-no\-reapply\-cherry\-picks
461 .RS 4
462 Reapply all clean cherry\-picks of any upstream commit instead of preemptively dropping them\&. (If these commits then become empty after rebasing, because they contain a subset of already upstream changes, the behavior towards them is controlled by the
463 \fB\-\-empty\fR
464 flag\&.)
465 .sp
466 In the absence of
467 \fB\-\-keep\-base\fR
468 (or if
469 \fB\-\-no\-reapply\-cherry\-picks\fR
470 is given), these commits will be automatically dropped\&. Because this necessitates reading all upstream commits, this can be expensive in repositories with a large number of upstream commits that need to be read\&. When using the
471 \fImerge\fR
472 backend, warnings will be issued for each dropped commit (unless
473 \fB\-\-quiet\fR
474 is given)\&. Advice will also be issued unless
475 \fBadvice\&.skippedCherryPicks\fR
476 is set to false (see
477 \fBgit-config\fR(1))\&.
478 .sp
479 \fB\-\-reapply\-cherry\-picks\fR
480 allows rebase to forgo reading all upstream commits, potentially improving performance\&.
481 .sp
482 See also INCOMPATIBLE OPTIONS below\&.
483 .RE
484 .PP
485 \-\-allow\-empty\-message
486 .RS 4
487 No\-op\&. Rebasing commits with an empty message used to fail and this option would override that behavior, allowing commits with empty messages to be rebased\&. Now commits with an empty message do not cause rebasing to halt\&.
488 .sp
489 See also INCOMPATIBLE OPTIONS below\&.
490 .RE
491 .PP
492 \-m, \-\-merge
493 .RS 4
494 Using merging strategies to rebase (default)\&.
495 .sp
496 Note that a rebase merge works by replaying each commit from the working branch on top of the
497 \fB<upstream>\fR
498 branch\&. Because of this, when a merge conflict happens, the side reported as
499 \fIours\fR
500 is the so\-far rebased series, starting with
501 \fB<upstream>\fR, and
502 \fItheirs\fR
503 is the working branch\&. In other words, the sides are swapped\&.
504 .sp
505 See also INCOMPATIBLE OPTIONS below\&.
506 .RE
507 .PP
508 \-s <strategy>, \-\-strategy=<strategy>
509 .RS 4
510 Use the given merge strategy, instead of the default
511 \fBort\fR\&. This implies
512 \fB\-\-merge\fR\&.
513 .sp
514 Because
515 \fBgit rebase\fR
516 replays each commit from the working branch on top of the
517 \fB<upstream>\fR
518 branch using the given strategy, using the
519 \fBours\fR
520 strategy simply empties all patches from the
521 \fB<branch>\fR, which makes little sense\&.
522 .sp
523 See also INCOMPATIBLE OPTIONS below\&.
524 .RE
525 .PP
526 \-X <strategy\-option>, \-\-strategy\-option=<strategy\-option>
527 .RS 4
528 Pass the <strategy\-option> through to the merge strategy\&. This implies
529 \fB\-\-merge\fR
530 and, if no strategy has been specified,
531 \fB\-s ort\fR\&. Note the reversal of
532 \fIours\fR
533 and
534 \fItheirs\fR
535 as noted above for the
536 \fB\-m\fR
537 option\&.
538 .sp
539 See also INCOMPATIBLE OPTIONS below\&.
540 .RE
541 .PP
542 \-\-rerere\-autoupdate, \-\-no\-rerere\-autoupdate
543 .RS 4
544 After the rerere mechanism reuses a recorded resolution on the current conflict to update the files in the working tree, allow it to also update the index with the result of resolution\&.
545 \fB\-\-no\-rerere\-autoupdate\fR
546 is a good way to double\-check what
547 \fBrerere\fR
548 did and catch potential mismerges, before committing the result to the index with a separate
549 \fBgit add\fR\&.
550 .RE
551 .PP
552 \-S[<keyid>], \-\-gpg\-sign[=<keyid>], \-\-no\-gpg\-sign
553 .RS 4
554 GPG\-sign commits\&. The
555 \fBkeyid\fR
556 argument is optional and defaults to the committer identity; if specified, it must be stuck to the option without a space\&.
557 \fB\-\-no\-gpg\-sign\fR
558 is useful to countermand both
559 \fBcommit\&.gpgSign\fR
560 configuration variable, and earlier
561 \fB\-\-gpg\-sign\fR\&.
562 .RE
563 .PP
564 \-q, \-\-quiet
565 .RS 4
566 Be quiet\&. Implies
567 \fB\-\-no\-stat\fR\&.
568 .RE
569 .PP
570 \-v, \-\-verbose
571 .RS 4
572 Be verbose\&. Implies
573 \fB\-\-stat\fR\&.
574 .RE
575 .PP
576 \-\-stat
577 .RS 4
578 Show a diffstat of what changed upstream since the last rebase\&. The diffstat is also controlled by the configuration option rebase\&.stat\&.
579 .RE
580 .PP
581 \-n, \-\-no\-stat
582 .RS 4
583 Do not show a diffstat as part of the rebase process\&.
584 .RE
585 .PP
586 \-\-no\-verify
587 .RS 4
588 This option bypasses the pre\-rebase hook\&. See also
589 \fBgithooks\fR(5)\&.
590 .RE
591 .PP
592 \-\-verify
593 .RS 4
594 Allows the pre\-rebase hook to run, which is the default\&. This option can be used to override
595 \fB\-\-no\-verify\fR\&. See also
596 \fBgithooks\fR(5)\&.
597 .RE
598 .PP
599 \-C<n>
600 .RS 4
601 Ensure at least
602 \fB<n>\fR
603 lines of surrounding context match before and after each change\&. When fewer lines of surrounding context exist they all must match\&. By default no context is ever ignored\&. Implies
604 \fB\-\-apply\fR\&.
605 .sp
606 See also INCOMPATIBLE OPTIONS below\&.
607 .RE
608 .PP
609 \-\-no\-ff, \-\-force\-rebase, \-f
610 .RS 4
611 Individually replay all rebased commits instead of fast\-forwarding over the unchanged ones\&. This ensures that the entire history of the rebased branch is composed of new commits\&.
612 .sp
613 You may find this helpful after reverting a topic branch merge, as this option recreates the topic branch with fresh commits so it can be remerged successfully without needing to "revert the reversion" (see the
614 \m[blue]\fBrevert\-a\-faulty\-merge How\-To\fR\m[]\&\s-2\u[1]\d\s+2
615 for details)\&.
616 .RE
617 .PP
618 \-\-fork\-point, \-\-no\-fork\-point
619 .RS 4
620 Use reflog to find a better common ancestor between
621 \fB<upstream>\fR
622 and
623 \fB<branch>\fR
624 when calculating which commits have been introduced by
625 \fB<branch>\fR\&.
626 .sp
627 When
628 \fB\-\-fork\-point\fR
629 is active,
630 \fIfork_point\fR
631 will be used instead of
632 \fB<upstream>\fR
633 to calculate the set of commits to rebase, where
634 \fIfork_point\fR
635 is the result of
636 \fBgit merge\-base \-\-fork\-point <upstream> <branch>\fR
637 command (see
638 \fBgit-merge-base\fR(1))\&. If
639 \fIfork_point\fR
640 ends up being empty, the
641 \fB<upstream>\fR
642 will be used as a fallback\&.
643 .sp
644 If
645 \fB<upstream>\fR
646 or
647 \fB\-\-keep\-base\fR
648 is given on the command line, then the default is
649 \fB\-\-no\-fork\-point\fR, otherwise the default is
650 \fB\-\-fork\-point\fR\&. See also
651 \fBrebase\&.forkpoint\fR
652 in
653 \fBgit-config\fR(1)\&.
654 .sp
655 If your branch was based on
656 \fB<upstream>\fR
657 but
658 \fB<upstream>\fR
659 was rewound and your branch contains commits which were dropped, this option can be used with
660 \fB\-\-keep\-base\fR
661 in order to drop those commits from your branch\&.
662 .sp
663 See also INCOMPATIBLE OPTIONS below\&.
664 .RE
665 .PP
666 \-\-ignore\-whitespace
667 .RS 4
668 Ignore whitespace differences when trying to reconcile differences\&. Currently, each backend implements an approximation of this behavior:
669 .PP
670 apply backend
671 .RS 4
672 When applying a patch, ignore changes in whitespace in context lines\&. Unfortunately, this means that if the "old" lines being replaced by the patch differ only in whitespace from the existing file, you will get a merge conflict instead of a successful patch application\&.
673 .RE
674 .PP
675 merge backend
676 .RS 4
677 Treat lines with only whitespace changes as unchanged when merging\&. Unfortunately, this means that any patch hunks that were intended to modify whitespace and nothing else will be dropped, even if the other side had no changes that conflicted\&.
678 .RE
679 .RE
680 .PP
681 \-\-whitespace=<option>
682 .RS 4
683 This flag is passed to the
684 \fBgit apply\fR
685 program (see
686 \fBgit-apply\fR(1)) that applies the patch\&. Implies
687 \fB\-\-apply\fR\&.
688 .sp
689 See also INCOMPATIBLE OPTIONS below\&.
690 .RE
691 .PP
692 \-\-committer\-date\-is\-author\-date
693 .RS 4
694 Instead of using the current time as the committer date, use the author date of the commit being rebased as the committer date\&. This option implies
695 \fB\-\-force\-rebase\fR\&.
696 .RE
697 .PP
698 \-\-ignore\-date, \-\-reset\-author\-date
699 .RS 4
700 Instead of using the author date of the original commit, use the current time as the author date of the rebased commit\&. This option implies
701 \fB\-\-force\-rebase\fR\&.
702 .sp
703 See also INCOMPATIBLE OPTIONS below\&.
704 .RE
705 .PP
706 \-\-signoff
707 .RS 4
708 Add a
709 \fBSigned\-off\-by\fR
710 trailer to all the rebased commits\&. Note that if
711 \fB\-\-interactive\fR
712 is given then only commits marked to be picked, edited or reworded will have the trailer added\&.
713 .sp
714 See also INCOMPATIBLE OPTIONS below\&.
715 .RE
716 .PP
717 \-i, \-\-interactive
718 .RS 4
719 Make a list of the commits which are about to be rebased\&. Let the user edit that list before rebasing\&. This mode can also be used to split commits (see SPLITTING COMMITS below)\&.
720 .sp
721 The commit list format can be changed by setting the configuration option rebase\&.instructionFormat\&. A customized instruction format will automatically have the long commit hash prepended to the format\&.
722 .sp
723 See also INCOMPATIBLE OPTIONS below\&.
724 .RE
725 .PP
726 \-r, \-\-rebase\-merges[=(rebase\-cousins|no\-rebase\-cousins)], \-\-no\-rebase\-merges
727 .RS 4
728 By default, a rebase will simply drop merge commits from the todo list, and put the rebased commits into a single, linear branch\&. With
729 \fB\-\-rebase\-merges\fR, the rebase will instead try to preserve the branching structure within the commits that are to be rebased, by recreating the merge commits\&. Any resolved merge conflicts or manual amendments in these merge commits will have to be resolved/re\-applied manually\&.
730 \fB\-\-no\-rebase\-merges\fR
731 can be used to countermand both the
732 \fBrebase\&.rebaseMerges\fR
733 config option and a previous
734 \fB\-\-rebase\-merges\fR\&.
735 .sp
736 When rebasing merges, there are two modes:
737 \fBrebase\-cousins\fR
738 and
739 \fBno\-rebase\-cousins\fR\&. If the mode is not specified, it defaults to
740 \fBno\-rebase\-cousins\fR\&. In
741 \fBno\-rebase\-cousins\fR
742 mode, commits which do not have
743 \fB<upstream>\fR
744 as direct ancestor will keep their original branch point, i\&.e\&. commits that would be excluded by
745 \fBgit-log\fR(1)\*(Aqs
746 \fB\-\-ancestry\-path\fR
747 option will keep their original ancestry by default\&. In
748 \fBrebase\-cousins\fR
749 mode, such commits are instead rebased onto
750 \fB<upstream>\fR
751 (or
752 \fB<onto>\fR, if specified)\&.
753 .sp
754 It is currently only possible to recreate the merge commits using the
755 \fBort\fR
756 merge strategy; different merge strategies can be used only via explicit
757 \fBexec git merge \-s <strategy> [\&.\&.\&.]\fR
758 commands\&.
759 .sp
760 See also REBASING MERGES and INCOMPATIBLE OPTIONS below\&.
761 .RE
762 .PP
763 \-x <cmd>, \-\-exec <cmd>
764 .RS 4
765 Append "exec <cmd>" after each line creating a commit in the final history\&.
766 \fB<cmd>\fR
767 will be interpreted as one or more shell commands\&. Any command that fails will interrupt the rebase, with exit code 1\&.
768 .sp
769 You may execute several commands by either using one instance of
770 \fB\-\-exec\fR
771 with several commands:
772 .sp
773 .if n \{\
774 .RS 4
775 .\}
776 .nf
777 git rebase \-i \-\-exec "cmd1 && cmd2 && \&.\&.\&."
778 .fi
779 .if n \{\
780 .RE
781 .\}
782 .sp
783 or by giving more than one
784 \fB\-\-exec\fR:
785 .sp
786 .if n \{\
787 .RS 4
788 .\}
789 .nf
790 git rebase \-i \-\-exec "cmd1" \-\-exec "cmd2" \-\-exec \&.\&.\&.
791 .fi
792 .if n \{\
793 .RE
794 .\}
795 .sp
796 If
797 \fB\-\-autosquash\fR
798 is used,
799 \fBexec\fR
800 lines will not be appended for the intermediate commits, and will only appear at the end of each squash/fixup series\&.
801 .sp
802 This uses the
803 \fB\-\-interactive\fR
804 machinery internally, but it can be run without an explicit
805 \fB\-\-interactive\fR\&.
806 .sp
807 See also INCOMPATIBLE OPTIONS below\&.
808 .RE
809 .PP
810 \-\-root
811 .RS 4
812 Rebase all commits reachable from
813 \fB<branch>\fR, instead of limiting them with an
814 \fB<upstream>\fR\&. This allows you to rebase the root commit(s) on a branch\&.
815 .sp
816 See also INCOMPATIBLE OPTIONS below\&.
817 .RE
818 .PP
819 \-\-autosquash, \-\-no\-autosquash
820 .RS 4
821 When the commit log message begins with "squash! \&..." or "fixup! \&..." or "amend! \&...", and there is already a commit in the todo list that matches the same
822 \fB\&.\&.\&.\fR, automatically modify the todo list of
823 \fBrebase \-i\fR, so that the commit marked for squashing comes right after the commit to be modified, and change the action of the moved commit from
824 \fBpick\fR
825 to
826 \fBsquash\fR
827 or
828 \fBfixup\fR
829 or
830 \fBfixup \-C\fR
831 respectively\&. A commit matches the
832 \fB\&.\&.\&.\fR
833 if the commit subject matches, or if the
834 \fB\&.\&.\&.\fR
835 refers to the commit\(cqs hash\&. As a fall\-back, partial matches of the commit subject work, too\&. The recommended way to create fixup/amend/squash commits is by using the
836 \fB\-\-fixup\fR,
837 \fB\-\-fixup=amend:\fR
838 or
839 \fB\-\-fixup=reword:\fR
840 and
841 \fB\-\-squash\fR
842 options respectively of
843 \fBgit-commit\fR(1)\&.
844 .sp
845 If the
846 \fB\-\-autosquash\fR
847 option is enabled by default using the configuration variable
848 \fBrebase\&.autoSquash\fR, this option can be used to override and disable this setting\&.
849 .sp
850 See also INCOMPATIBLE OPTIONS below\&.
851 .RE
852 .PP
853 \-\-autostash, \-\-no\-autostash
854 .RS 4
855 Automatically create a temporary stash entry before the operation begins, and apply it after the operation ends\&. This means that you can run rebase on a dirty worktree\&. However, use with care: the final stash application after a successful rebase might result in non\-trivial conflicts\&.
856 .RE
857 .PP
858 \-\-reschedule\-failed\-exec, \-\-no\-reschedule\-failed\-exec
859 .RS 4
860 Automatically reschedule
861 \fBexec\fR
862 commands that failed\&. This only makes sense in interactive mode (or when an
863 \fB\-\-exec\fR
864 option was provided)\&.
865 .sp
866 Even though this option applies once a rebase is started, it\(cqs set for the whole rebase at the start based on either the
867 \fBrebase\&.rescheduleFailedExec\fR
868 configuration (see
869 \fBgit-config\fR(1)
870 or "CONFIGURATION" below) or whether this option is provided\&. Otherwise an explicit
871 \fB\-\-no\-reschedule\-failed\-exec\fR
872 at the start would be overridden by the presence of
873 \fBrebase\&.rescheduleFailedExec=true\fR
874 configuration\&.
875 .RE
876 .PP
877 \-\-update\-refs, \-\-no\-update\-refs
878 .RS 4
879 Automatically force\-update any branches that point to commits that are being rebased\&. Any branches that are checked out in a worktree are not updated in this way\&.
880 .sp
881 If the configuration variable
882 \fBrebase\&.updateRefs\fR
883 is set, then this option can be used to override and disable this setting\&.
884 .sp
885 See also INCOMPATIBLE OPTIONS below\&.
886 .RE
887 .SH "INCOMPATIBLE OPTIONS"
888 .sp
889 The following options:
890 .sp
891 .RS 4
892 .ie n \{\
893 \h'-04'\(bu\h'+03'\c
894 .\}
895 .el \{\
896 .sp -1
897 .IP \(bu 2.3
898 .\}
899 \-\-apply
900 .RE
901 .sp
902 .RS 4
903 .ie n \{\
904 \h'-04'\(bu\h'+03'\c
905 .\}
906 .el \{\
907 .sp -1
908 .IP \(bu 2.3
909 .\}
910 \-\-whitespace
911 .RE
912 .sp
913 .RS 4
914 .ie n \{\
915 \h'-04'\(bu\h'+03'\c
916 .\}
917 .el \{\
918 .sp -1
919 .IP \(bu 2.3
920 .\}
921 \-C
922 .RE
923 .sp
924 are incompatible with the following options:
925 .sp
926 .RS 4
927 .ie n \{\
928 \h'-04'\(bu\h'+03'\c
929 .\}
930 .el \{\
931 .sp -1
932 .IP \(bu 2.3
933 .\}
934 \-\-merge
935 .RE
936 .sp
937 .RS 4
938 .ie n \{\
939 \h'-04'\(bu\h'+03'\c
940 .\}
941 .el \{\
942 .sp -1
943 .IP \(bu 2.3
944 .\}
945 \-\-strategy
946 .RE
947 .sp
948 .RS 4
949 .ie n \{\
950 \h'-04'\(bu\h'+03'\c
951 .\}
952 .el \{\
953 .sp -1
954 .IP \(bu 2.3
955 .\}
956 \-\-strategy\-option
957 .RE
958 .sp
959 .RS 4
960 .ie n \{\
961 \h'-04'\(bu\h'+03'\c
962 .\}
963 .el \{\
964 .sp -1
965 .IP \(bu 2.3
966 .\}
967 \-\-autosquash
968 .RE
969 .sp
970 .RS 4
971 .ie n \{\
972 \h'-04'\(bu\h'+03'\c
973 .\}
974 .el \{\
975 .sp -1
976 .IP \(bu 2.3
977 .\}
978 \-\-rebase\-merges
979 .RE
980 .sp
981 .RS 4
982 .ie n \{\
983 \h'-04'\(bu\h'+03'\c
984 .\}
985 .el \{\
986 .sp -1
987 .IP \(bu 2.3
988 .\}
989 \-\-interactive
990 .RE
991 .sp
992 .RS 4
993 .ie n \{\
994 \h'-04'\(bu\h'+03'\c
995 .\}
996 .el \{\
997 .sp -1
998 .IP \(bu 2.3
999 .\}
1000 \-\-exec
1001 .RE
1002 .sp
1003 .RS 4
1004 .ie n \{\
1005 \h'-04'\(bu\h'+03'\c
1006 .\}
1007 .el \{\
1008 .sp -1
1009 .IP \(bu 2.3
1010 .\}
1011 \-\-no\-keep\-empty
1012 .RE
1013 .sp
1014 .RS 4
1015 .ie n \{\
1016 \h'-04'\(bu\h'+03'\c
1017 .\}
1018 .el \{\
1019 .sp -1
1020 .IP \(bu 2.3
1021 .\}
1022 \-\-empty=
1023 .RE
1024 .sp
1025 .RS 4
1026 .ie n \{\
1027 \h'-04'\(bu\h'+03'\c
1028 .\}
1029 .el \{\
1030 .sp -1
1031 .IP \(bu 2.3
1032 .\}
1033 \-\-[no\-]reapply\-cherry\-picks when used without \-\-keep\-base
1034 .RE
1035 .sp
1036 .RS 4
1037 .ie n \{\
1038 \h'-04'\(bu\h'+03'\c
1039 .\}
1040 .el \{\
1041 .sp -1
1042 .IP \(bu 2.3
1043 .\}
1044 \-\-update\-refs
1045 .RE
1046 .sp
1047 .RS 4
1048 .ie n \{\
1049 \h'-04'\(bu\h'+03'\c
1050 .\}
1051 .el \{\
1052 .sp -1
1053 .IP \(bu 2.3
1054 .\}
1055 \-\-root when used without \-\-onto
1056 .RE
1057 .sp
1058 In addition, the following pairs of options are incompatible:
1059 .sp
1060 .RS 4
1061 .ie n \{\
1062 \h'-04'\(bu\h'+03'\c
1063 .\}
1064 .el \{\
1065 .sp -1
1066 .IP \(bu 2.3
1067 .\}
1068 \-\-keep\-base and \-\-onto
1069 .RE
1070 .sp
1071 .RS 4
1072 .ie n \{\
1073 \h'-04'\(bu\h'+03'\c
1074 .\}
1075 .el \{\
1076 .sp -1
1077 .IP \(bu 2.3
1078 .\}
1079 \-\-keep\-base and \-\-root
1080 .RE
1081 .sp
1082 .RS 4
1083 .ie n \{\
1084 \h'-04'\(bu\h'+03'\c
1085 .\}
1086 .el \{\
1087 .sp -1
1088 .IP \(bu 2.3
1089 .\}
1090 \-\-fork\-point and \-\-root
1091 .RE
1092 .SH "BEHAVIORAL DIFFERENCES"
1093 .sp
1094 \fBgit rebase\fR has two primary backends: \fIapply\fR and \fImerge\fR\&. (The \fIapply\fR backend used to be known as the \fIam\fR backend, but the name led to confusion as it looks like a verb instead of a noun\&. Also, the \fImerge\fR backend used to be known as the interactive backend, but it is now used for non\-interactive cases as well\&. Both were renamed based on lower\-level functionality that underpinned each\&.) There are some subtle differences in how these two backends behave:
1095 .SS "Empty commits"
1096 .sp
1097 The \fIapply\fR backend unfortunately drops intentionally empty commits, i\&.e\&. commits that started empty, though these are rare in practice\&. It also drops commits that become empty and has no option for controlling this behavior\&.
1098 .sp
1099 The \fImerge\fR backend keeps intentionally empty commits by default (though with \fB\-i\fR they are marked as empty in the todo list editor, or they can be dropped automatically with \fB\-\-no\-keep\-empty\fR)\&.
1100 .sp
1101 Similar to the apply backend, by default the merge backend drops commits that become empty unless \fB\-i\fR/\fB\-\-interactive\fR is specified (in which case it stops and asks the user what to do)\&. The merge backend also has an \fB\-\-empty={drop,keep,ask}\fR option for changing the behavior of handling commits that become empty\&.
1102 .SS "Directory rename detection"
1103 .sp
1104 Due to the lack of accurate tree information (arising from constructing fake ancestors with the limited information available in patches), directory rename detection is disabled in the \fIapply\fR backend\&. Disabled directory rename detection means that if one side of history renames a directory and the other adds new files to the old directory, then the new files will be left behind in the old directory without any warning at the time of rebasing that you may want to move these files into the new directory\&.
1105 .sp
1106 Directory rename detection works with the \fImerge\fR backend to provide you warnings in such cases\&.
1107 .SS "Context"
1108 .sp
1109 The \fIapply\fR backend works by creating a sequence of patches (by calling \fBformat\-patch\fR internally), and then applying the patches in sequence (calling \fBam\fR internally)\&. Patches are composed of multiple hunks, each with line numbers, a context region, and the actual changes\&. The line numbers have to be taken with some fuzz, since the other side will likely have inserted or deleted lines earlier in the file\&. The context region is meant to help find how to adjust the line numbers in order to apply the changes to the right lines\&. However, if multiple areas of the code have the same surrounding lines of context, the wrong one can be picked\&. There are real\-world cases where this has caused commits to be reapplied incorrectly with no conflicts reported\&. Setting \fBdiff\&.context\fR to a larger value may prevent such types of problems, but increases the chance of spurious conflicts (since it will require more lines of matching context to apply)\&.
1110 .sp
1111 The \fImerge\fR backend works with a full copy of each relevant file, insulating it from these types of problems\&.
1112 .SS "Labelling of conflicts markers"
1113 .sp
1114 When there are content conflicts, the merge machinery tries to annotate each side\(cqs conflict markers with the commits where the content came from\&. Since the \fIapply\fR backend drops the original information about the rebased commits and their parents (and instead generates new fake commits based off limited information in the generated patches), those commits cannot be identified; instead it has to fall back to a commit summary\&. Also, when \fBmerge\&.conflictStyle\fR is set to \fBdiff3\fR or \fBzdiff3\fR, the \fIapply\fR backend will use "constructed merge base" to label the content from the merge base, and thus provide no information about the merge base commit whatsoever\&.
1115 .sp
1116 The \fImerge\fR backend works with the full commits on both sides of history and thus has no such limitations\&.
1117 .SS "Hooks"
1118 .sp
1119 The \fIapply\fR backend has not traditionally called the post\-commit hook, while the \fImerge\fR backend has\&. Both have called the post\-checkout hook, though the \fImerge\fR backend has squelched its output\&. Further, both backends only call the post\-checkout hook with the starting point commit of the rebase, not the intermediate commits nor the final commit\&. In each case, the calling of these hooks was by accident of implementation rather than by design (both backends were originally implemented as shell scripts and happened to invoke other commands like \fBgit checkout\fR or \fBgit commit\fR that would call the hooks)\&. Both backends should have the same behavior, though it is not entirely clear which, if any, is correct\&. We will likely make rebase stop calling either of these hooks in the future\&.
1120 .SS "Interruptability"
1121 .sp
1122 The \fIapply\fR backend has safety problems with an ill\-timed interrupt; if the user presses Ctrl\-C at the wrong time to try to abort the rebase, the rebase can enter a state where it cannot be aborted with a subsequent \fBgit rebase \-\-abort\fR\&. The \fImerge\fR backend does not appear to suffer from the same shortcoming\&. (See \m[blue]\fBhttps://lore\&.kernel\&.org/git/20200207132152\&.GC2868@szeder\&.dev/\fR\m[] for details\&.)
1123 .SS "Commit Rewording"
1124 .sp
1125 When a conflict occurs while rebasing, rebase stops and asks the user to resolve\&. Since the user may need to make notable changes while resolving conflicts, after conflicts are resolved and the user has run \fBgit rebase \-\-continue\fR, the rebase should open an editor and ask the user to update the commit message\&. The \fImerge\fR backend does this, while the \fIapply\fR backend blindly applies the original commit message\&.
1126 .SS "Miscellaneous differences"
1127 .sp
1128 There are a few more behavioral differences that most folks would probably consider inconsequential but which are mentioned for completeness:
1129 .sp
1130 .RS 4
1131 .ie n \{\
1132 \h'-04'\(bu\h'+03'\c
1133 .\}
1134 .el \{\
1135 .sp -1
1136 .IP \(bu 2.3
1137 .\}
1138 Reflog: The two backends will use different wording when describing the changes made in the reflog, though both will make use of the word "rebase"\&.
1139 .RE
1140 .sp
1141 .RS 4
1142 .ie n \{\
1143 \h'-04'\(bu\h'+03'\c
1144 .\}
1145 .el \{\
1146 .sp -1
1147 .IP \(bu 2.3
1148 .\}
1149 Progress, informational, and error messages: The two backends provide slightly different progress and informational messages\&. Also, the apply backend writes error messages (such as "Your files would be overwritten\&...") to stdout, while the merge backend writes them to stderr\&.
1150 .RE
1151 .sp
1152 .RS 4
1153 .ie n \{\
1154 \h'-04'\(bu\h'+03'\c
1155 .\}
1156 .el \{\
1157 .sp -1
1158 .IP \(bu 2.3
1159 .\}
1160 State directories: The two backends keep their state in different directories under
1161 \fB\&.git/\fR
1162 .RE
1163 .SH "MERGE STRATEGIES"
1164 .sp
1165 The merge mechanism (\fBgit merge\fR and \fBgit pull\fR commands) allows the backend \fImerge strategies\fR to be chosen with \fB\-s\fR option\&. Some strategies can also take their own options, which can be passed by giving \fB\-X<option>\fR arguments to \fBgit merge\fR and/or \fBgit pull\fR\&.
1166 .PP
1167 ort
1168 .RS 4
1169 This is the default merge strategy when pulling or merging one branch\&. This strategy can only resolve two heads using a 3\-way merge algorithm\&. When there is more than one common ancestor that can be used for 3\-way merge, it creates a merged tree of the common ancestors and uses that as the reference tree for the 3\-way merge\&. This has been reported to result in fewer merge conflicts without causing mismerges by tests done on actual merge commits taken from Linux 2\&.6 kernel development history\&. Additionally this strategy can detect and handle merges involving renames\&. It does not make use of detected copies\&. The name for this algorithm is an acronym ("Ostensibly Recursive\(cqs Twin") and came from the fact that it was written as a replacement for the previous default algorithm,
1170 \fBrecursive\fR\&.
1171 .sp
1172 The
1173 \fIort\fR
1174 strategy can take the following options:
1175 .PP
1176 ours
1177 .RS 4
1178 This option forces conflicting hunks to be auto\-resolved cleanly by favoring
1179 \fIour\fR
1180 version\&. Changes from the other tree that do not conflict with our side are reflected in the merge result\&. For a binary file, the entire contents are taken from our side\&.
1181 .sp
1182 This should not be confused with the
1183 \fIours\fR
1184 merge strategy, which does not even look at what the other tree contains at all\&. It discards everything the other tree did, declaring
1185 \fIour\fR
1186 history contains all that happened in it\&.
1187 .RE
1188 .PP
1189 theirs
1190 .RS 4
1191 This is the opposite of
1192 \fIours\fR; note that, unlike
1193 \fIours\fR, there is no
1194 \fItheirs\fR
1195 merge strategy to confuse this merge option with\&.
1196 .RE
1197 .PP
1198 ignore\-space\-change, ignore\-all\-space, ignore\-space\-at\-eol, ignore\-cr\-at\-eol
1199 .RS 4
1200 Treats lines with the indicated type of whitespace change as unchanged for the sake of a three\-way merge\&. Whitespace changes mixed with other changes to a line are not ignored\&. See also
1201 \fBgit-diff\fR(1)
1202 \fB\-b\fR,
1203 \fB\-w\fR,
1204 \fB\-\-ignore\-space\-at\-eol\fR, and
1205 \fB\-\-ignore\-cr\-at\-eol\fR\&.
1206 .sp
1207 .RS 4
1208 .ie n \{\
1209 \h'-04'\(bu\h'+03'\c
1210 .\}
1211 .el \{\
1212 .sp -1
1213 .IP \(bu 2.3
1214 .\}
1215 If
1216 \fItheir\fR
1217 version only introduces whitespace changes to a line,
1218 \fIour\fR
1219 version is used;
1220 .RE
1221 .sp
1222 .RS 4
1223 .ie n \{\
1224 \h'-04'\(bu\h'+03'\c
1225 .\}
1226 .el \{\
1227 .sp -1
1228 .IP \(bu 2.3
1229 .\}
1230 If
1231 \fIour\fR
1232 version introduces whitespace changes but
1233 \fItheir\fR
1234 version includes a substantial change,
1235 \fItheir\fR
1236 version is used;
1237 .RE
1238 .sp
1239 .RS 4
1240 .ie n \{\
1241 \h'-04'\(bu\h'+03'\c
1242 .\}
1243 .el \{\
1244 .sp -1
1245 .IP \(bu 2.3
1246 .\}
1247 Otherwise, the merge proceeds in the usual way\&.
1248 .RE
1249 .RE
1250 .PP
1251 renormalize
1252 .RS 4
1253 This runs a virtual check\-out and check\-in of all three stages of a file when resolving a three\-way merge\&. This option is meant to be used when merging branches with different clean filters or end\-of\-line normalization rules\&. See "Merging branches with differing checkin/checkout attributes" in
1254 \fBgitattributes\fR(5)
1255 for details\&.
1256 .RE
1257 .PP
1258 no\-renormalize
1259 .RS 4
1260 Disables the
1261 \fBrenormalize\fR
1262 option\&. This overrides the
1263 \fBmerge\&.renormalize\fR
1264 configuration variable\&.
1265 .RE
1266 .PP
1267 find\-renames[=<n>]
1268 .RS 4
1269 Turn on rename detection, optionally setting the similarity threshold\&. This is the default\&. This overrides the
1270 \fImerge\&.renames\fR
1271 configuration variable\&. See also
1272 \fBgit-diff\fR(1)
1273 \fB\-\-find\-renames\fR\&.
1274 .RE
1275 .PP
1276 rename\-threshold=<n>
1277 .RS 4
1278 Deprecated synonym for
1279 \fBfind\-renames=<n>\fR\&.
1280 .RE
1281 .PP
1282 subtree[=<path>]
1283 .RS 4
1284 This option is a more advanced form of
1285 \fIsubtree\fR
1286 strategy, where the strategy makes a guess on how two trees must be shifted to match with each other when merging\&. Instead, the specified path is prefixed (or stripped from the beginning) to make the shape of two trees to match\&.
1287 .RE
1288 .RE
1289 .PP
1290 recursive
1291 .RS 4
1292 This can only resolve two heads using a 3\-way merge algorithm\&. When there is more than one common ancestor that can be used for 3\-way merge, it creates a merged tree of the common ancestors and uses that as the reference tree for the 3\-way merge\&. This has been reported to result in fewer merge conflicts without causing mismerges by tests done on actual merge commits taken from Linux 2\&.6 kernel development history\&. Additionally this can detect and handle merges involving renames\&. It does not make use of detected copies\&. This was the default strategy for resolving two heads from Git v0\&.99\&.9k until v2\&.33\&.0\&.
1293 .sp
1294 The
1295 \fIrecursive\fR
1296 strategy takes the same options as
1297 \fIort\fR\&. However, there are three additional options that
1298 \fIort\fR
1299 ignores (not documented above) that are potentially useful with the
1300 \fIrecursive\fR
1301 strategy:
1302 .PP
1303 patience
1304 .RS 4
1305 Deprecated synonym for
1306 \fBdiff\-algorithm=patience\fR\&.
1307 .RE
1308 .PP
1309 diff\-algorithm=[patience|minimal|histogram|myers]
1310 .RS 4
1311 Use a different diff algorithm while merging, which can help avoid mismerges that occur due to unimportant matching lines (such as braces from distinct functions)\&. See also
1312 \fBgit-diff\fR(1)
1313 \fB\-\-diff\-algorithm\fR\&. Note that
1314 \fBort\fR
1315 specifically uses
1316 \fBdiff\-algorithm=histogram\fR, while
1317 \fBrecursive\fR
1318 defaults to the
1319 \fBdiff\&.algorithm\fR
1320 config setting\&.
1321 .RE
1322 .PP
1323 no\-renames
1324 .RS 4
1325 Turn off rename detection\&. This overrides the
1326 \fBmerge\&.renames\fR
1327 configuration variable\&. See also
1328 \fBgit-diff\fR(1)
1329 \fB\-\-no\-renames\fR\&.
1330 .RE
1331 .RE
1332 .PP
1333 resolve
1334 .RS 4
1335 This can only resolve two heads (i\&.e\&. the current branch and another branch you pulled from) using a 3\-way merge algorithm\&. It tries to carefully detect criss\-cross merge ambiguities\&. It does not handle renames\&.
1336 .RE
1337 .PP
1338 octopus
1339 .RS 4
1340 This resolves cases with more than two heads, but refuses to do a complex merge that needs manual resolution\&. It is primarily meant to be used for bundling topic branch heads together\&. This is the default merge strategy when pulling or merging more than one branch\&.
1341 .RE
1342 .PP
1343 ours
1344 .RS 4
1345 This resolves any number of heads, but the resulting tree of the merge is always that of the current branch head, effectively ignoring all changes from all other branches\&. It is meant to be used to supersede old development history of side branches\&. Note that this is different from the \-Xours option to the
1346 \fIrecursive\fR
1347 merge strategy\&.
1348 .RE
1349 .PP
1350 subtree
1351 .RS 4
1352 This is a modified
1353 \fBort\fR
1354 strategy\&. When merging trees A and B, if B corresponds to a subtree of A, B is first adjusted to match the tree structure of A, instead of reading the trees at the same level\&. This adjustment is also done to the common ancestor tree\&.
1355 .RE
1356 .sp
1357 With the strategies that use 3\-way merge (including the default, \fIort\fR), if a change is made on both branches, but later reverted on one of the branches, that change will be present in the merged result; some people find this behavior confusing\&. It occurs because only the heads and the merge base are considered when performing a merge, not the individual commits\&. The merge algorithm therefore considers the reverted change as no change at all, and substitutes the changed version instead\&.
1358 .SH "NOTES"
1359 .sp
1360 You should understand the implications of using \fBgit rebase\fR on a repository that you share\&. See also RECOVERING FROM UPSTREAM REBASE below\&.
1361 .sp
1362 When the rebase is run, it will first execute a \fBpre\-rebase\fR hook if one exists\&. You can use this hook to do sanity checks and reject the rebase if it isn\(cqt appropriate\&. Please see the template \fBpre\-rebase\fR hook script for an example\&.
1363 .sp
1364 Upon completion, \fB<branch>\fR will be the current branch\&.
1365 .SH "INTERACTIVE MODE"
1366 .sp
1367 Rebasing interactively means that you have a chance to edit the commits which are rebased\&. You can reorder the commits, and you can remove them (weeding out bad or otherwise unwanted patches)\&.
1368 .sp
1369 The interactive mode is meant for this type of workflow:
1370 .sp
1371 .RS 4
1372 .ie n \{\
1373 \h'-04' 1.\h'+01'\c
1374 .\}
1375 .el \{\
1376 .sp -1
1377 .IP " 1." 4.2
1378 .\}
1379 have a wonderful idea
1380 .RE
1381 .sp
1382 .RS 4
1383 .ie n \{\
1384 \h'-04' 2.\h'+01'\c
1385 .\}
1386 .el \{\
1387 .sp -1
1388 .IP " 2." 4.2
1389 .\}
1390 hack on the code
1391 .RE
1392 .sp
1393 .RS 4
1394 .ie n \{\
1395 \h'-04' 3.\h'+01'\c
1396 .\}
1397 .el \{\
1398 .sp -1
1399 .IP " 3." 4.2
1400 .\}
1401 prepare a series for submission
1402 .RE
1403 .sp
1404 .RS 4
1405 .ie n \{\
1406 \h'-04' 4.\h'+01'\c
1407 .\}
1408 .el \{\
1409 .sp -1
1410 .IP " 4." 4.2
1411 .\}
1412 submit
1413 .RE
1414 .sp
1415 where point 2\&. consists of several instances of
1416 .sp
1417 a) regular use
1418 .sp
1419 .RS 4
1420 .ie n \{\
1421 \h'-04' 1.\h'+01'\c
1422 .\}
1423 .el \{\
1424 .sp -1
1425 .IP " 1." 4.2
1426 .\}
1427 finish something worthy of a commit
1428 .RE
1429 .sp
1430 .RS 4
1431 .ie n \{\
1432 \h'-04' 2.\h'+01'\c
1433 .\}
1434 .el \{\
1435 .sp -1
1436 .IP " 2." 4.2
1437 .\}
1438 commit
1439 .RE
1440 .sp
1441 b) independent fixup
1442 .sp
1443 .RS 4
1444 .ie n \{\
1445 \h'-04' 1.\h'+01'\c
1446 .\}
1447 .el \{\
1448 .sp -1
1449 .IP " 1." 4.2
1450 .\}
1451 realize that something does not work
1452 .RE
1453 .sp
1454 .RS 4
1455 .ie n \{\
1456 \h'-04' 2.\h'+01'\c
1457 .\}
1458 .el \{\
1459 .sp -1
1460 .IP " 2." 4.2
1461 .\}
1462 fix that
1463 .RE
1464 .sp
1465 .RS 4
1466 .ie n \{\
1467 \h'-04' 3.\h'+01'\c
1468 .\}
1469 .el \{\
1470 .sp -1
1471 .IP " 3." 4.2
1472 .\}
1473 commit it
1474 .RE
1475 .sp
1476 Sometimes the thing fixed in b\&.2\&. cannot be amended to the not\-quite perfect commit it fixes, because that commit is buried deeply in a patch series\&. That is exactly what interactive rebase is for: use it after plenty of "a"s and "b"s, by rearranging and editing commits, and squashing multiple commits into one\&.
1477 .sp
1478 Start it with the last commit you want to retain as\-is:
1479 .sp
1480 .if n \{\
1481 .RS 4
1482 .\}
1483 .nf
1484 git rebase \-i <after\-this\-commit>
1485 .fi
1486 .if n \{\
1487 .RE
1488 .\}
1489 .sp
1490 An editor will be fired up with all the commits in your current branch (ignoring merge commits), which come after the given commit\&. You can reorder the commits in this list to your heart\(cqs content, and you can remove them\&. The list looks more or less like this:
1491 .sp
1492 .if n \{\
1493 .RS 4
1494 .\}
1495 .nf
1496 pick deadbee The oneline of this commit
1497 pick fa1afe1 The oneline of the next commit
1498 \&.\&.\&.
1499 .fi
1500 .if n \{\
1501 .RE
1502 .\}
1503 .sp
1504 .sp
1505 The oneline descriptions are purely for your pleasure; \fIgit rebase\fR will not look at them but at the commit names ("deadbee" and "fa1afe1" in this example), so do not delete or edit the names\&.
1506 .sp
1507 By replacing the command "pick" with the command "edit", you can tell \fBgit rebase\fR to stop after applying that commit, so that you can edit the files and/or the commit message, amend the commit, and continue rebasing\&.
1508 .sp
1509 To interrupt the rebase (just like an "edit" command would do, but without cherry\-picking any commit first), use the "break" command\&.
1510 .sp
1511 If you just want to edit the commit message for a commit, replace the command "pick" with the command "reword"\&.
1512 .sp
1513 To drop a commit, replace the command "pick" with "drop", or just delete the matching line\&.
1514 .sp
1515 If you want to fold two or more commits into one, replace the command "pick" for the second and subsequent commits with "squash" or "fixup"\&. If the commits had different authors, the folded commit will be attributed to the author of the first commit\&. The suggested commit message for the folded commit is the concatenation of the first commit\(cqs message with those identified by "squash" commands, omitting the messages of commits identified by "fixup" commands, unless "fixup \-c" is used\&. In that case the suggested commit message is only the message of the "fixup \-c" commit, and an editor is opened allowing you to edit the message\&. The contents (patch) of the "fixup \-c" commit are still incorporated into the folded commit\&. If there is more than one "fixup \-c" commit, the message from the final one is used\&. You can also use "fixup \-C" to get the same behavior as "fixup \-c" except without opening an editor\&.
1516 .sp
1517 \fBgit rebase\fR will stop when "pick" has been replaced with "edit" or when a command fails due to merge errors\&. When you are done editing and/or resolving conflicts you can continue with \fBgit rebase \-\-continue\fR\&.
1518 .sp
1519 For example, if you want to reorder the last 5 commits, such that what was \fBHEAD~4\fR becomes the new \fBHEAD\fR\&. To achieve that, you would call \fBgit rebase\fR like this:
1520 .sp
1521 .if n \{\
1522 .RS 4
1523 .\}
1524 .nf
1525 $ git rebase \-i HEAD~5
1526 .fi
1527 .if n \{\
1528 .RE
1529 .\}
1530 .sp
1531 .sp
1532 And move the first patch to the end of the list\&.
1533 .sp
1534 You might want to recreate merge commits, e\&.g\&. if you have a history like this:
1535 .sp
1536 .if n \{\
1537 .RS 4
1538 .\}
1539 .nf
1540 X
1541 \e
1542 A\-\-\-M\-\-\-B
1543 /
1544 \-\-\-o\-\-\-O\-\-\-P\-\-\-Q
1545 .fi
1546 .if n \{\
1547 .RE
1548 .\}
1549 .sp
1550 .sp
1551 Suppose you want to rebase the side branch starting at "A" to "Q"\&. Make sure that the current \fBHEAD\fR is "B", and call
1552 .sp
1553 .if n \{\
1554 .RS 4
1555 .\}
1556 .nf
1557 $ git rebase \-i \-r \-\-onto Q O
1558 .fi
1559 .if n \{\
1560 .RE
1561 .\}
1562 .sp
1563 .sp
1564 Reordering and editing commits usually creates untested intermediate steps\&. You may want to check that your history editing did not break anything by running a test, or at least recompiling at intermediate points in history by using the "exec" command (shortcut "x")\&. You may do so by creating a todo list like this one:
1565 .sp
1566 .if n \{\
1567 .RS 4
1568 .\}
1569 .nf
1570 pick deadbee Implement feature XXX
1571 fixup f1a5c00 Fix to feature XXX
1572 exec make
1573 pick c0ffeee The oneline of the next commit
1574 edit deadbab The oneline of the commit after
1575 exec cd subdir; make test
1576 \&.\&.\&.
1577 .fi
1578 .if n \{\
1579 .RE
1580 .\}
1581 .sp
1582 .sp
1583 The interactive rebase will stop when a command fails (i\&.e\&. exits with non\-0 status) to give you an opportunity to fix the problem\&. You can continue with \fBgit rebase \-\-continue\fR\&.
1584 .sp
1585 The "exec" command launches the command in a shell (the one specified in \fB$SHELL\fR, or the default shell if \fB$SHELL\fR is not set), so you can use shell features (like "cd", ">", ";" \&...)\&. The command is run from the root of the working tree\&.
1586 .sp
1587 .if n \{\
1588 .RS 4
1589 .\}
1590 .nf
1591 $ git rebase \-i \-\-exec "make test"
1592 .fi
1593 .if n \{\
1594 .RE
1595 .\}
1596 .sp
1597 .sp
1598 This command lets you check that intermediate commits are compilable\&. The todo list becomes like that:
1599 .sp
1600 .if n \{\
1601 .RS 4
1602 .\}
1603 .nf
1604 pick 5928aea one
1605 exec make test
1606 pick 04d0fda two
1607 exec make test
1608 pick ba46169 three
1609 exec make test
1610 pick f4593f9 four
1611 exec make test
1612 .fi
1613 .if n \{\
1614 .RE
1615 .\}
1616 .sp
1617 .SH "SPLITTING COMMITS"
1618 .sp
1619 In interactive mode, you can mark commits with the action "edit"\&. However, this does not necessarily mean that \fBgit rebase\fR expects the result of this edit to be exactly one commit\&. Indeed, you can undo the commit, or you can add other commits\&. This can be used to split a commit into two:
1620 .sp
1621 .RS 4
1622 .ie n \{\
1623 \h'-04'\(bu\h'+03'\c
1624 .\}
1625 .el \{\
1626 .sp -1
1627 .IP \(bu 2.3
1628 .\}
1629 Start an interactive rebase with
1630 \fBgit rebase \-i <commit>^\fR, where
1631 \fB<commit>\fR
1632 is the commit you want to split\&. In fact, any commit range will do, as long as it contains that commit\&.
1633 .RE
1634 .sp
1635 .RS 4
1636 .ie n \{\
1637 \h'-04'\(bu\h'+03'\c
1638 .\}
1639 .el \{\
1640 .sp -1
1641 .IP \(bu 2.3
1642 .\}
1643 Mark the commit you want to split with the action "edit"\&.
1644 .RE
1645 .sp
1646 .RS 4
1647 .ie n \{\
1648 \h'-04'\(bu\h'+03'\c
1649 .\}
1650 .el \{\
1651 .sp -1
1652 .IP \(bu 2.3
1653 .\}
1654 When it comes to editing that commit, execute
1655 \fBgit reset HEAD^\fR\&. The effect is that the
1656 \fBHEAD\fR
1657 is rewound by one, and the index follows suit\&. However, the working tree stays the same\&.
1658 .RE
1659 .sp
1660 .RS 4
1661 .ie n \{\
1662 \h'-04'\(bu\h'+03'\c
1663 .\}
1664 .el \{\
1665 .sp -1
1666 .IP \(bu 2.3
1667 .\}
1668 Now add the changes to the index that you want to have in the first commit\&. You can use
1669 \fBgit add\fR
1670 (possibly interactively) or
1671 \fBgit gui\fR
1672 (or both) to do that\&.
1673 .RE
1674 .sp
1675 .RS 4
1676 .ie n \{\
1677 \h'-04'\(bu\h'+03'\c
1678 .\}
1679 .el \{\
1680 .sp -1
1681 .IP \(bu 2.3
1682 .\}
1683 Commit the now\-current index with whatever commit message is appropriate now\&.
1684 .RE
1685 .sp
1686 .RS 4
1687 .ie n \{\
1688 \h'-04'\(bu\h'+03'\c
1689 .\}
1690 .el \{\
1691 .sp -1
1692 .IP \(bu 2.3
1693 .\}
1694 Repeat the last two steps until your working tree is clean\&.
1695 .RE
1696 .sp
1697 .RS 4
1698 .ie n \{\
1699 \h'-04'\(bu\h'+03'\c
1700 .\}
1701 .el \{\
1702 .sp -1
1703 .IP \(bu 2.3
1704 .\}
1705 Continue the rebase with
1706 \fBgit rebase \-\-continue\fR\&.
1707 .RE
1708 .sp
1709 If you are not absolutely sure that the intermediate revisions are consistent (they compile, pass the testsuite, etc\&.) you should use \fBgit stash\fR to stash away the not\-yet\-committed changes after each commit, test, and amend the commit if fixes are necessary\&.
1710 .SH "RECOVERING FROM UPSTREAM REBASE"
1711 .sp
1712 Rebasing (or any other form of rewriting) a branch that others have based work on is a bad idea: anyone downstream of it is forced to manually fix their history\&. This section explains how to do the fix from the downstream\(cqs point of view\&. The real fix, however, would be to avoid rebasing the upstream in the first place\&.
1713 .sp
1714 To illustrate, suppose you are in a situation where someone develops a \fIsubsystem\fR branch, and you are working on a \fItopic\fR that is dependent on this \fIsubsystem\fR\&. You might end up with a history like the following:
1715 .sp
1716 .if n \{\
1717 .RS 4
1718 .\}
1719 .nf
1720 o\-\-\-o\-\-\-o\-\-\-o\-\-\-o\-\-\-o\-\-\-o\-\-\-o master
1721 \e
1722 o\-\-\-o\-\-\-o\-\-\-o\-\-\-o subsystem
1723 \e
1724 *\-\-\-*\-\-\-* topic
1725 .fi
1726 .if n \{\
1727 .RE
1728 .\}
1729 .sp
1730 .sp
1731 If \fIsubsystem\fR is rebased against \fImaster\fR, the following happens:
1732 .sp
1733 .if n \{\
1734 .RS 4
1735 .\}
1736 .nf
1737 o\-\-\-o\-\-\-o\-\-\-o\-\-\-o\-\-\-o\-\-\-o\-\-\-o master
1738 \e \e
1739 o\-\-\-o\-\-\-o\-\-\-o\-\-\-o o\*(Aq\-\-o\*(Aq\-\-o\*(Aq\-\-o\*(Aq\-\-o\*(Aq subsystem
1740 \e
1741 *\-\-\-*\-\-\-* topic
1742 .fi
1743 .if n \{\
1744 .RE
1745 .\}
1746 .sp
1747 .sp
1748 If you now continue development as usual, and eventually merge \fItopic\fR to \fIsubsystem\fR, the commits from \fIsubsystem\fR will remain duplicated forever:
1749 .sp
1750 .if n \{\
1751 .RS 4
1752 .\}
1753 .nf
1754 o\-\-\-o\-\-\-o\-\-\-o\-\-\-o\-\-\-o\-\-\-o\-\-\-o master
1755 \e \e
1756 o\-\-\-o\-\-\-o\-\-\-o\-\-\-o o\*(Aq\-\-o\*(Aq\-\-o\*(Aq\-\-o\*(Aq\-\-o\*(Aq\-\-M subsystem
1757 \e /
1758 *\-\-\-*\-\-\-*\-\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\-*\-\-* topic
1759 .fi
1760 .if n \{\
1761 .RE
1762 .\}
1763 .sp
1764 .sp
1765 Such duplicates are generally frowned upon because they clutter up history, making it harder to follow\&. To clean things up, you need to transplant the commits on \fItopic\fR to the new \fIsubsystem\fR tip, i\&.e\&., rebase \fItopic\fR\&. This becomes a ripple effect: anyone downstream from \fItopic\fR is forced to rebase too, and so on!
1766 .sp
1767 There are two kinds of fixes, discussed in the following subsections:
1768 .PP
1769 Easy case: The changes are literally the same\&.
1770 .RS 4
1771 This happens if the
1772 \fIsubsystem\fR
1773 rebase was a simple rebase and had no conflicts\&.
1774 .RE
1775 .PP
1776 Hard case: The changes are not the same\&.
1777 .RS 4
1778 This happens if the
1779 \fIsubsystem\fR
1780 rebase had conflicts, or used
1781 \fB\-\-interactive\fR
1782 to omit, edit, squash, or fixup commits; or if the upstream used one of
1783 \fBcommit \-\-amend\fR,
1784 \fBreset\fR, or a full history rewriting command like
1785 \m[blue]\fB\fBfilter\-repo\fR\fR\m[]\&\s-2\u[2]\d\s+2\&.
1786 .RE
1787 .SS "The easy case"
1788 .sp
1789 Only works if the changes (patch IDs based on the diff contents) on \fIsubsystem\fR are literally the same before and after the rebase \fIsubsystem\fR did\&.
1790 .sp
1791 In that case, the fix is easy because \fIgit rebase\fR knows to skip changes that are already present in the new upstream (unless \fB\-\-reapply\-cherry\-picks\fR is given)\&. So if you say (assuming you\(cqre on \fItopic\fR)
1792 .sp
1793 .if n \{\
1794 .RS 4
1795 .\}
1796 .nf
1797 $ git rebase subsystem
1798 .fi
1799 .if n \{\
1800 .RE
1801 .\}
1802 .sp
1803 .sp
1804 you will end up with the fixed history
1805 .sp
1806 .if n \{\
1807 .RS 4
1808 .\}
1809 .nf
1810 o\-\-\-o\-\-\-o\-\-\-o\-\-\-o\-\-\-o\-\-\-o\-\-\-o master
1811 \e
1812 o\*(Aq\-\-o\*(Aq\-\-o\*(Aq\-\-o\*(Aq\-\-o\*(Aq subsystem
1813 \e
1814 *\-\-\-*\-\-\-* topic
1815 .fi
1816 .if n \{\
1817 .RE
1818 .\}
1819 .sp
1820 .SS "The hard case"
1821 .sp
1822 Things get more complicated if the \fIsubsystem\fR changes do not exactly correspond to the ones before the rebase\&.
1823 .if n \{\
1824 .sp
1825 .\}
1826 .RS 4
1827 .it 1 an-trap
1828 .nr an-no-space-flag 1
1829 .nr an-break-flag 1
1830 .br
1831 .ps +1
1832 \fBNote\fR
1833 .ps -1
1834 .br
1835 .sp
1836 While an "easy case recovery" sometimes appears to be successful even in the hard case, it may have unintended consequences\&. For example, a commit that was removed via \fBgit rebase \-\-interactive\fR will be \fBresurrected\fR!
1837 .sp .5v
1838 .RE
1839 .sp
1840 The idea is to manually tell \fBgit rebase\fR "where the old \fIsubsystem\fR ended and your \fItopic\fR began", that is, what the old merge base between them was\&. You will have to find a way to name the last commit of the old \fIsubsystem\fR, for example:
1841 .sp
1842 .RS 4
1843 .ie n \{\
1844 \h'-04'\(bu\h'+03'\c
1845 .\}
1846 .el \{\
1847 .sp -1
1848 .IP \(bu 2.3
1849 .\}
1850 With the
1851 \fIsubsystem\fR
1852 reflog: after
1853 \fBgit fetch\fR, the old tip of
1854 \fIsubsystem\fR
1855 is at
1856 \fBsubsystem@{1}\fR\&. Subsequent fetches will increase the number\&. (See
1857 \fBgit-reflog\fR(1)\&.)
1858 .RE
1859 .sp
1860 .RS 4
1861 .ie n \{\
1862 \h'-04'\(bu\h'+03'\c
1863 .\}
1864 .el \{\
1865 .sp -1
1866 .IP \(bu 2.3
1867 .\}
1868 Relative to the tip of
1869 \fItopic\fR: knowing that your
1870 \fItopic\fR
1871 has three commits, the old tip of
1872 \fIsubsystem\fR
1873 must be
1874 \fBtopic~3\fR\&.
1875 .RE
1876 .sp
1877 You can then transplant the old \fBsubsystem\&.\&.topic\fR to the new tip by saying (for the reflog case, and assuming you are on \fItopic\fR already):
1878 .sp
1879 .if n \{\
1880 .RS 4
1881 .\}
1882 .nf
1883 $ git rebase \-\-onto subsystem subsystem@{1}
1884 .fi
1885 .if n \{\
1886 .RE
1887 .\}
1888 .sp
1889 .sp
1890 The ripple effect of a "hard case" recovery is especially bad: \fIeveryone\fR downstream from \fItopic\fR will now have to perform a "hard case" recovery too!
1891 .SH "REBASING MERGES"
1892 .sp
1893 The interactive rebase command was originally designed to handle individual patch series\&. As such, it makes sense to exclude merge commits from the todo list, as the developer may have merged the then\-current \fBmaster\fR while working on the branch, only to rebase all the commits onto \fBmaster\fR eventually (skipping the merge commits)\&.
1894 .sp
1895 However, there are legitimate reasons why a developer may want to recreate merge commits: to keep the branch structure (or "commit topology") when working on multiple, inter\-related branches\&.
1896 .sp
1897 In the following example, the developer works on a topic branch that refactors the way buttons are defined, and on another topic branch that uses that refactoring to implement a "Report a bug" button\&. The output of \fBgit log \-\-graph \-\-format=%s \-5\fR may look like this:
1898 .sp
1899 .if n \{\
1900 .RS 4
1901 .\}
1902 .nf
1903 * Merge branch \*(Aqreport\-a\-bug\*(Aq
1904 |\e
1905 | * Add the feedback button
1906 * | Merge branch \*(Aqrefactor\-button\*(Aq
1907 |\e \e
1908 | |/
1909 | * Use the Button class for all buttons
1910 | * Extract a generic Button class from the DownloadButton one
1911 .fi
1912 .if n \{\
1913 .RE
1914 .\}
1915 .sp
1916 .sp
1917 The developer might want to rebase those commits to a newer \fBmaster\fR while keeping the branch topology, for example when the first topic branch is expected to be integrated into \fBmaster\fR much earlier than the second one, say, to resolve merge conflicts with changes to the DownloadButton class that made it into \fBmaster\fR\&.
1918 .sp
1919 This rebase can be performed using the \fB\-\-rebase\-merges\fR option\&. It will generate a todo list looking like this:
1920 .sp
1921 .if n \{\
1922 .RS 4
1923 .\}
1924 .nf
1925 label onto
1927 # Branch: refactor\-button
1928 reset onto
1929 pick 123456 Extract a generic Button class from the DownloadButton one
1930 pick 654321 Use the Button class for all buttons
1931 label refactor\-button
1933 # Branch: report\-a\-bug
1934 reset refactor\-button # Use the Button class for all buttons
1935 pick abcdef Add the feedback button
1936 label report\-a\-bug
1938 reset onto
1939 merge \-C a1b2c3 refactor\-button # Merge \*(Aqrefactor\-button\*(Aq
1940 merge \-C 6f5e4d report\-a\-bug # Merge \*(Aqreport\-a\-bug\*(Aq
1941 .fi
1942 .if n \{\
1943 .RE
1944 .\}
1945 .sp
1946 .sp
1947 In contrast to a regular interactive rebase, there are \fBlabel\fR, \fBreset\fR and \fBmerge\fR commands in addition to \fBpick\fR ones\&.
1948 .sp
1949 The \fBlabel\fR command associates a label with the current HEAD when that command is executed\&. These labels are created as worktree\-local refs (\fBrefs/rewritten/<label>\fR) that will be deleted when the rebase finishes\&. That way, rebase operations in multiple worktrees linked to the same repository do not interfere with one another\&. If the \fBlabel\fR command fails, it is rescheduled immediately, with a helpful message how to proceed\&.
1950 .sp
1951 The \fBreset\fR command resets the HEAD, index and worktree to the specified revision\&. It is similar to an \fBexec git reset \-\-hard <label>\fR, but refuses to overwrite untracked files\&. If the \fBreset\fR command fails, it is rescheduled immediately, with a helpful message how to edit the todo list (this typically happens when a \fBreset\fR command was inserted into the todo list manually and contains a typo)\&.
1952 .sp
1953 The \fBmerge\fR command will merge the specified revision(s) into whatever is HEAD at that time\&. With \fB\-C <original\-commit>\fR, the commit message of the specified merge commit will be used\&. When the \fB\-C\fR is changed to a lower\-case \fB\-c\fR, the message will be opened in an editor after a successful merge so that the user can edit the message\&.
1954 .sp
1955 If a \fBmerge\fR command fails for any reason other than merge conflicts (i\&.e\&. when the merge operation did not even start), it is rescheduled immediately\&.
1956 .sp
1957 By default, the \fBmerge\fR command will use the \fBort\fR merge strategy for regular merges, and \fBoctopus\fR for octopus merges\&. One can specify a default strategy for all merges using the \fB\-\-strategy\fR argument when invoking rebase, or can override specific merges in the interactive list of commands by using an \fBexec\fR command to call \fBgit merge\fR explicitly with a \fB\-\-strategy\fR argument\&. Note that when calling \fBgit merge\fR explicitly like this, you can make use of the fact that the labels are worktree\-local refs (the ref \fBrefs/rewritten/onto\fR would correspond to the label \fBonto\fR, for example) in order to refer to the branches you want to merge\&.
1958 .sp
1959 Note: the first command (\fBlabel onto\fR) labels the revision onto which the commits are rebased; The name \fBonto\fR is just a convention, as a nod to the \fB\-\-onto\fR option\&.
1960 .sp
1961 It is also possible to introduce completely new merge commits from scratch by adding a command of the form \fBmerge <merge\-head>\fR\&. This form will generate a tentative commit message and always open an editor to let the user edit it\&. This can be useful e\&.g\&. when a topic branch turns out to address more than a single concern and wants to be split into two or even more topic branches\&. Consider this todo list:
1962 .sp
1963 .if n \{\
1964 .RS 4
1965 .\}
1966 .nf
1967 pick 192837 Switch from GNU Makefiles to CMake
1968 pick 5a6c7e Document the switch to CMake
1969 pick 918273 Fix detection of OpenSSL in CMake
1970 pick afbecd http: add support for TLS v1\&.3
1971 pick fdbaec Fix detection of cURL in CMake on Windows
1972 .fi
1973 .if n \{\
1974 .RE
1975 .\}
1976 .sp
1977 .sp
1978 The one commit in this list that is not related to CMake may very well have been motivated by working on fixing all those bugs introduced by switching to CMake, but it addresses a different concern\&. To split this branch into two topic branches, the todo list could be edited like this:
1979 .sp
1980 .if n \{\
1981 .RS 4
1982 .\}
1983 .nf
1984 label onto
1986 pick afbecd http: add support for TLS v1\&.3
1987 label tlsv1\&.3
1989 reset onto
1990 pick 192837 Switch from GNU Makefiles to CMake
1991 pick 918273 Fix detection of OpenSSL in CMake
1992 pick fdbaec Fix detection of cURL in CMake on Windows
1993 pick 5a6c7e Document the switch to CMake
1994 label cmake
1996 reset onto
1997 merge tlsv1\&.3
1998 merge cmake
1999 .fi
2000 .if n \{\
2001 .RE
2002 .\}
2003 .sp
2004 .SH "CONFIGURATION"
2005 .sp
2006 Everything below this line in this section is selectively included from the \fBgit-config\fR(1) documentation\&. The content is the same as what\(cqs found there:
2007 .PP
2008 rebase\&.backend
2009 .RS 4
2010 Default backend to use for rebasing\&. Possible choices are
2011 \fIapply\fR
2012 or
2013 \fImerge\fR\&. In the future, if the merge backend gains all remaining capabilities of the apply backend, this setting may become unused\&.
2014 .RE
2015 .PP
2016 rebase\&.stat
2017 .RS 4
2018 Whether to show a diffstat of what changed upstream since the last rebase\&. False by default\&.
2019 .RE
2020 .PP
2021 rebase\&.autoSquash
2022 .RS 4
2023 If set to true enable
2024 \fB\-\-autosquash\fR
2025 option by default\&.
2026 .RE
2027 .PP
2028 rebase\&.autoStash
2029 .RS 4
2030 When set to true, automatically create a temporary stash entry before the operation begins, and apply it after the operation ends\&. This means that you can run rebase on a dirty worktree\&. However, use with care: the final stash application after a successful rebase might result in non\-trivial conflicts\&. This option can be overridden by the
2031 \fB\-\-no\-autostash\fR
2032 and
2033 \fB\-\-autostash\fR
2034 options of
2035 \fBgit-rebase\fR(1)\&. Defaults to false\&.
2036 .RE
2037 .PP
2038 rebase\&.updateRefs
2039 .RS 4
2040 If set to true enable
2041 \fB\-\-update\-refs\fR
2042 option by default\&.
2043 .RE
2044 .PP
2045 rebase\&.missingCommitsCheck
2046 .RS 4
2047 If set to "warn", git rebase \-i will print a warning if some commits are removed (e\&.g\&. a line was deleted), however the rebase will still proceed\&. If set to "error", it will print the previous warning and stop the rebase,
2048 \fIgit rebase \-\-edit\-todo\fR
2049 can then be used to correct the error\&. If set to "ignore", no checking is done\&. To drop a commit without warning or error, use the
2050 \fBdrop\fR
2051 command in the todo list\&. Defaults to "ignore"\&.
2052 .RE
2053 .PP
2054 rebase\&.instructionFormat
2055 .RS 4
2056 A format string, as specified in
2057 \fBgit-log\fR(1), to be used for the todo list during an interactive rebase\&. The format will automatically have the long commit hash prepended to the format\&.
2058 .RE
2059 .PP
2060 rebase\&.abbreviateCommands
2061 .RS 4
2062 If set to true,
2063 \fBgit rebase\fR
2064 will use abbreviated command names in the todo list resulting in something like this:
2065 .sp
2066 .if n \{\
2067 .RS 4
2068 .\}
2069 .nf
2070 p deadbee The oneline of the commit
2071 p fa1afe1 The oneline of the next commit
2072 \&.\&.\&.
2073 .fi
2074 .if n \{\
2075 .RE
2076 .\}
2077 .sp
2078 instead of:
2079 .sp
2080 .if n \{\
2081 .RS 4
2082 .\}
2083 .nf
2084 pick deadbee The oneline of the commit
2085 pick fa1afe1 The oneline of the next commit
2086 \&.\&.\&.
2087 .fi
2088 .if n \{\
2089 .RE
2090 .\}
2091 .sp
2092 Defaults to false\&.
2093 .RE
2094 .PP
2095 rebase\&.rescheduleFailedExec
2096 .RS 4
2097 Automatically reschedule
2098 \fBexec\fR
2099 commands that failed\&. This only makes sense in interactive mode (or when an
2100 \fB\-\-exec\fR
2101 option was provided)\&. This is the same as specifying the
2102 \fB\-\-reschedule\-failed\-exec\fR
2103 option\&.
2104 .RE
2105 .PP
2106 rebase\&.forkPoint
2107 .RS 4
2108 If set to false set
2109 \fB\-\-no\-fork\-point\fR
2110 option by default\&.
2111 .RE
2112 .PP
2113 rebase\&.rebaseMerges
2114 .RS 4
2115 Whether and how to set the
2116 \fB\-\-rebase\-merges\fR
2117 option by default\&. Can be
2118 \fBrebase\-cousins\fR,
2119 \fBno\-rebase\-cousins\fR, or a boolean\&. Setting to true or to
2120 \fBno\-rebase\-cousins\fR
2121 is equivalent to
2122 \fB\-\-rebase\-merges=no\-rebase\-cousins\fR, setting to
2123 \fBrebase\-cousins\fR
2124 is equivalent to
2125 \fB\-\-rebase\-merges=rebase\-cousins\fR, and setting to false is equivalent to
2126 \fB\-\-no\-rebase\-merges\fR\&. Passing
2127 \fB\-\-rebase\-merges\fR
2128 on the command line, with or without an argument, overrides any
2129 \fBrebase\&.rebaseMerges\fR
2130 configuration\&.
2131 .RE
2132 .PP
2133 sequence\&.editor
2134 .RS 4
2135 Text editor used by
2136 \fBgit rebase \-i\fR
2137 for editing the rebase instruction file\&. The value is meant to be interpreted by the shell when it is used\&. It can be overridden by the
2138 \fBGIT_SEQUENCE_EDITOR\fR
2139 environment variable\&. When not configured the default commit message editor is used instead\&.
2140 .RE
2141 .SH "GIT"
2142 .sp
2143 Part of the \fBgit\fR(1) suite
2144 .SH "NOTES"
2145 .IP " 1." 4
2146 revert-a-faulty-merge How-To
2147 .RS 4
2148 \%git-htmldocs/howto/revert-a-faulty-merge.html
2149 .RE
2150 .IP " 2." 4
2151 \fBfilter-repo\fR
2152 .RS 4
2153 \%https://github.com/newren/git-filter-repo
2154 .RE