| blob | 602eee4a490fd8b30ebf74fe12f89c00bc3bdf7a |
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: 07/22/2022
6 .\" Manual: Git Manual
7 .\" Source: Git 2.37.1.223.g6a475b71f8
8 .\" Language: English
9 .\"
10 .TH "GIT\-REBASE" "1" "07/22/2022" "Git 2\&.37\&.1\&.223\&.g6a475b" "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 .sp
52 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)\&.
53 .sp
54 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\&.
55 .sp
56 Assume the following history exists and the current branch is "topic":
57 .sp
58 .if n \{\
59 .RS 4
60 .\}
61 .nf
62 A\-\-\-B\-\-\-C topic
63 /
64 D\-\-\-E\-\-\-F\-\-\-G master
65 .fi
66 .if n \{\
67 .RE
68 .\}
69 .sp
70 .sp
71 From this point, the result of either of the following commands:
72 .sp
73 .if n \{\
74 .RS 4
75 .\}
76 .nf
77 git rebase master
78 git rebase master topic
79 .fi
80 .if n \{\
81 .RE
82 .\}
83 .sp
84 would be:
85 .sp
86 .if n \{\
87 .RS 4
88 .\}
89 .nf
90 A\(aq\-\-B\(aq\-\-C\(aq topic
91 /
92 D\-\-\-E\-\-\-F\-\-\-G master
93 .fi
94 .if n \{\
95 .RE
96 .\}
97 .sp
98 .sp
99 \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\&.
100 .sp
101 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):
102 .sp
103 .if n \{\
104 .RS 4
105 .\}
106 .nf
107 A\-\-\-B\-\-\-C topic
108 /
109 D\-\-\-E\-\-\-A\(aq\-\-\-F master
110 .fi
111 .if n \{\
112 .RE
113 .\}
114 .sp
115 .sp
116 will result in:
117 .sp
118 .if n \{\
119 .RS 4
120 .\}
121 .nf
122 B\(aq\-\-\-C\(aq topic
123 /
124 D\-\-\-E\-\-\-A\(aq\-\-\-F master
125 .fi
126 .if n \{\
127 .RE
128 .\}
129 .sp
130 .sp
131 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\&.
132 .sp
133 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\&.
134 .sp
135 .if n \{\
136 .RS 4
137 .\}
138 .nf
139 o\-\-\-o\-\-\-o\-\-\-o\-\-\-o master
140 \e
141 o\-\-\-o\-\-\-o\-\-\-o\-\-\-o next
142 \e
143 o\-\-\-o\-\-\-o topic
144 .fi
145 .if n \{\
146 .RE
147 .\}
148 .sp
149 .sp
150 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:
151 .sp
152 .if n \{\
153 .RS 4
154 .\}
155 .nf
156 o\-\-\-o\-\-\-o\-\-\-o\-\-\-o master
157 | \e
158 | o\(aq\-\-o\(aq\-\-o\(aq topic
159 \e
160 o\-\-\-o\-\-\-o\-\-\-o\-\-\-o next
161 .fi
162 .if n \{\
163 .RE
164 .\}
165 .sp
166 .sp
167 We can get this using the following command:
168 .sp
169 .if n \{\
170 .RS 4
171 .\}
172 .nf
173 git rebase \-\-onto master next topic
174 .fi
175 .if n \{\
176 .RE
177 .\}
178 .sp
179 Another example of \-\-onto option is to rebase part of a branch\&. If we have the following situation:
180 .sp
181 .if n \{\
182 .RS 4
183 .\}
184 .nf
185 H\-\-\-I\-\-\-J topicB
186 /
187 E\-\-\-F\-\-\-G topicA
188 /
189 A\-\-\-B\-\-\-C\-\-\-D master
190 .fi
191 .if n \{\
192 .RE
193 .\}
194 .sp
195 .sp
196 then the command
197 .sp
198 .if n \{\
199 .RS 4
200 .\}
201 .nf
202 git rebase \-\-onto master topicA topicB
203 .fi
204 .if n \{\
205 .RE
206 .\}
207 .sp
208 would result in:
209 .sp
210 .if n \{\
211 .RS 4
212 .\}
213 .nf
214 H\(aq\-\-I\(aq\-\-J\(aq topicB
215 /
216 | E\-\-\-F\-\-\-G topicA
217 |/
218 A\-\-\-B\-\-\-C\-\-\-D master
219 .fi
220 .if n \{\
221 .RE
222 .\}
223 .sp
224 .sp
225 This is useful when topicB does not depend on topicA\&.
226 .sp
227 A range of commits could also be removed with rebase\&. If we have the following situation:
228 .sp
229 .if n \{\
230 .RS 4
231 .\}
232 .nf
233 E\-\-\-F\-\-\-G\-\-\-H\-\-\-I\-\-\-J topicA
234 .fi
235 .if n \{\
236 .RE
237 .\}
238 .sp
239 .sp
240 then the command
241 .sp
242 .if n \{\
243 .RS 4
244 .\}
245 .nf
246 git rebase \-\-onto topicA~5 topicA~3 topicA
247 .fi
248 .if n \{\
249 .RE
250 .\}
251 .sp
252 would result in the removal of commits F and G:
253 .sp
254 .if n \{\
255 .RS 4
256 .\}
257 .nf
258 E\-\-\-H\(aq\-\-\-I\(aq\-\-\-J\(aq topicA
259 .fi
260 .if n \{\
261 .RE
262 .\}
263 .sp
264 .sp
265 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\&.
266 .sp
267 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
268 .sp
269 .if n \{\
270 .RS 4
271 .\}
272 .nf
273 git add <filename>
274 .fi
275 .if n \{\
276 .RE
277 .\}
278 .sp
279 After resolving the conflict manually and updating the index with the desired resolution, you can continue the rebasing process with
280 .sp
281 .if n \{\
282 .RS 4
283 .\}
284 .nf
285 git rebase \-\-continue
286 .fi
287 .if n \{\
288 .RE
289 .\}
290 .sp
291 Alternatively, you can undo the \fIgit rebase\fR with
292 .sp
293 .if n \{\
294 .RS 4
295 .\}
296 .nf
297 git rebase \-\-abort
298 .fi
299 .if n \{\
300 .RE
301 .\}
302 .SH "OPTIONS"
303 .PP
304 \-\-onto <newbase>
305 .RS 4
306 Starting point at which to create the new commits\&. If the
307 \fB\-\-onto\fR
308 option is not specified, the starting point is
309 \fB<upstream>\fR\&. May be any valid commit, and not just an existing branch name\&.
310 .sp
311 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\&.
312 .RE
313 .PP
314 \-\-keep\-base
315 .RS 4
316 Set the starting point at which to create the new commits to the merge base of
317 \fB<upstream>\fR
318 and
319 \fB<branch>\fR\&. Running
320 \fBgit rebase \-\-keep\-base <upstream> <branch>\fR
321 is equivalent to running
322 \fBgit rebase \-\-onto <upstream>\&.\&.\&.<branch> <upstream> <branch>\fR\&.
323 .sp
324 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\&.
325 .sp
326 Although both this option and
327 \fB\-\-fork\-point\fR
328 find the merge base between
329 \fB<upstream>\fR
330 and
331 \fB<branch>\fR, this option uses the merge base as the
332 \fIstarting point\fR
333 on which new commits will be created, whereas
334 \fB\-\-fork\-point\fR
335 uses the merge base to determine the
336 \fIset of commits\fR
337 which will be rebased\&.
338 .sp
339 See also INCOMPATIBLE OPTIONS below\&.
340 .RE
341 .PP
342 <upstream>
343 .RS 4
344 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\&.
345 .RE
346 .PP
347 <branch>
348 .RS 4
349 Working branch; defaults to
350 \fBHEAD\fR\&.
351 .RE
352 .PP
353 \-\-continue
354 .RS 4
355 Restart the rebasing process after having resolved a merge conflict\&.
356 .RE
357 .PP
358 \-\-abort
359 .RS 4
360 Abort the rebase operation and reset HEAD to the original branch\&. If
361 \fB<branch>\fR
362 was provided when the rebase operation was started, then
363 \fBHEAD\fR
364 will be reset to
365 \fB<branch>\fR\&. Otherwise
366 \fBHEAD\fR
367 will be reset to where it was when the rebase operation was started\&.
368 .RE
369 .PP
370 \-\-quit
371 .RS 4
372 Abort the rebase operation but
373 \fBHEAD\fR
374 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
375 \fB\-\-autostash\fR, it will be saved to the stash list\&.
376 .RE
377 .PP
378 \-\-apply
379 .RS 4
380 Use applying strategies to rebase (calling
381 \fBgit\-am\fR
382 internally)\&. This option may become a no\-op in the future once the merge backend handles everything the apply one does\&.
383 .sp
384 See also INCOMPATIBLE OPTIONS below\&.
385 .RE
386 .PP
387 \-\-empty={drop,keep,ask}
388 .RS 4
389 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
390 \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
391 \fB\-\-exec\fR, will use the default of drop unless
392 \fB\-i\fR/\fB\-\-interactive\fR
393 is explicitly specified\&.
394 .sp
395 Note that commits which start empty are kept (unless
396 \fB\-\-no\-keep\-empty\fR
397 is specified), and commits which are clean cherry\-picks (as determined by
398 \fBgit log \-\-cherry\-mark \&.\&.\&.\fR) are detected and dropped as a preliminary step (unless
399 \fB\-\-reapply\-cherry\-picks\fR
400 is passed)\&.
401 .sp
402 See also INCOMPATIBLE OPTIONS below\&.
403 .RE
404 .PP
405 \-\-no\-keep\-empty, \-\-keep\-empty
406 .RS 4
407 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
408 \fB\-\-allow\-empty\fR
409 override flag to
410 \fBgit commit\fR, signifying that a user is very intentionally creating such a commit and thus wants to keep it\&.
411 .sp
412 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\&.
413 .sp
414 For commits which do not start empty but become empty after rebasing, see the
415 \fB\-\-empty\fR
416 flag\&.
417 .sp
418 See also INCOMPATIBLE OPTIONS below\&.
419 .RE
420 .PP
421 \-\-reapply\-cherry\-picks, \-\-no\-reapply\-cherry\-picks
422 .RS 4
423 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
424 \fB\-\-empty\fR
425 flag\&.)
426 .sp
427 By default (or if
428 \fB\-\-no\-reapply\-cherry\-picks\fR
429 is given), these commits will be automatically dropped\&. Because this necessitates reading all upstream commits, this can be expensive in repos with a large number of upstream commits that need to be read\&. When using the
430 \fImerge\fR
431 backend, warnings will be issued for each dropped commit (unless
432 \fB\-\-quiet\fR
433 is given)\&. Advice will also be issued unless
434 \fBadvice\&.skippedCherryPicks\fR
435 is set to false (see
436 \fBgit-config\fR(1))\&.
437 .sp
438 \fB\-\-reapply\-cherry\-picks\fR
439 allows rebase to forgo reading all upstream commits, potentially improving performance\&.
440 .sp
441 See also INCOMPATIBLE OPTIONS below\&.
442 .RE
443 .PP
444 \-\-allow\-empty\-message
445 .RS 4
446 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\&.
447 .sp
448 See also INCOMPATIBLE OPTIONS below\&.
449 .RE
450 .PP
451 \-\-skip
452 .RS 4
453 Restart the rebasing process by skipping the current patch\&.
454 .RE
455 .PP
456 \-\-edit\-todo
457 .RS 4
458 Edit the todo list during an interactive rebase\&.
459 .RE
460 .PP
461 \-\-show\-current\-patch
462 .RS 4
463 Show the current patch in an interactive rebase or when rebase is stopped because of conflicts\&. This is the equivalent of
464 \fBgit show REBASE_HEAD\fR\&.
465 .RE
466 .PP
467 \-m, \-\-merge
468 .RS 4
469 Using merging strategies to rebase (default)\&.
470 .sp
471 Note that a rebase merge works by replaying each commit from the working branch on top of the
472 \fB<upstream>\fR
473 branch\&. Because of this, when a merge conflict happens, the side reported as
474 \fIours\fR
475 is the so\-far rebased series, starting with
476 \fB<upstream>\fR, and
477 \fItheirs\fR
478 is the working branch\&. In other words, the sides are swapped\&.
479 .sp
480 See also INCOMPATIBLE OPTIONS below\&.
481 .RE
482 .PP
483 \-s <strategy>, \-\-strategy=<strategy>
484 .RS 4
485 Use the given merge strategy, instead of the default
486 \fBort\fR\&. This implies
487 \fB\-\-merge\fR\&.
488 .sp
489 Because
490 \fBgit rebase\fR
491 replays each commit from the working branch on top of the
492 \fB<upstream>\fR
493 branch using the given strategy, using the
494 \fBours\fR
495 strategy simply empties all patches from the
496 \fB<branch>\fR, which makes little sense\&.
497 .sp
498 See also INCOMPATIBLE OPTIONS below\&.
499 .RE
500 .PP
501 \-X <strategy\-option>, \-\-strategy\-option=<strategy\-option>
502 .RS 4
503 Pass the <strategy\-option> through to the merge strategy\&. This implies
504 \fB\-\-merge\fR
505 and, if no strategy has been specified,
506 \fB\-s ort\fR\&. Note the reversal of
507 \fIours\fR
508 and
509 \fItheirs\fR
510 as noted above for the
511 \fB\-m\fR
512 option\&.
513 .sp
514 See also INCOMPATIBLE OPTIONS below\&.
515 .RE
516 .PP
517 \-\-rerere\-autoupdate, \-\-no\-rerere\-autoupdate
518 .RS 4
519 Allow the rerere mechanism to update the index with the result of auto\-conflict resolution if possible\&.
520 .RE
521 .PP
522 \-S[<keyid>], \-\-gpg\-sign[=<keyid>], \-\-no\-gpg\-sign
523 .RS 4
524 GPG\-sign commits\&. The
525 \fBkeyid\fR
526 argument is optional and defaults to the committer identity; if specified, it must be stuck to the option without a space\&.
527 \fB\-\-no\-gpg\-sign\fR
528 is useful to countermand both
529 \fBcommit\&.gpgSign\fR
530 configuration variable, and earlier
531 \fB\-\-gpg\-sign\fR\&.
532 .RE
533 .PP
534 \-q, \-\-quiet
535 .RS 4
536 Be quiet\&. Implies
537 \fB\-\-no\-stat\fR\&.
538 .RE
539 .PP
540 \-v, \-\-verbose
541 .RS 4
542 Be verbose\&. Implies
543 \fB\-\-stat\fR\&.
544 .RE
545 .PP
546 \-\-stat
547 .RS 4
548 Show a diffstat of what changed upstream since the last rebase\&. The diffstat is also controlled by the configuration option rebase\&.stat\&.
549 .RE
550 .PP
551 \-n, \-\-no\-stat
552 .RS 4
553 Do not show a diffstat as part of the rebase process\&.
554 .RE
555 .PP
556 \-\-no\-verify
557 .RS 4
558 This option bypasses the pre\-rebase hook\&. See also
559 \fBgithooks\fR(5)\&.
560 .RE
561 .PP
562 \-\-verify
563 .RS 4
564 Allows the pre\-rebase hook to run, which is the default\&. This option can be used to override
565 \fB\-\-no\-verify\fR\&. See also
566 \fBgithooks\fR(5)\&.
567 .RE
568 .PP
569 \-C<n>
570 .RS 4
571 Ensure at least
572 \fB<n>\fR
573 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
574 \fB\-\-apply\fR\&.
575 .sp
576 See also INCOMPATIBLE OPTIONS below\&.
577 .RE
578 .PP
579 \-\-no\-ff, \-\-force\-rebase, \-f
580 .RS 4
581 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\&.
582 .sp
583 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
584 \m[blue]\fBrevert\-a\-faulty\-merge How\-To\fR\m[]\&\s-2\u[1]\d\s+2
585 for details)\&.
586 .RE
587 .PP
588 \-\-fork\-point, \-\-no\-fork\-point
589 .RS 4
590 Use reflog to find a better common ancestor between
591 \fB<upstream>\fR
592 and
593 \fB<branch>\fR
594 when calculating which commits have been introduced by
595 \fB<branch>\fR\&.
596 .sp
597 When
598 \fB\-\-fork\-point\fR
599 is active,
600 \fIfork_point\fR
601 will be used instead of
602 \fB<upstream>\fR
603 to calculate the set of commits to rebase, where
604 \fIfork_point\fR
605 is the result of
606 \fBgit merge\-base \-\-fork\-point <upstream> <branch>\fR
607 command (see
608 \fBgit-merge-base\fR(1))\&. If
609 \fIfork_point\fR
610 ends up being empty, the
611 \fB<upstream>\fR
612 will be used as a fallback\&.
613 .sp
614 If
615 \fB<upstream>\fR
616 is given on the command line, then the default is
617 \fB\-\-no\-fork\-point\fR, otherwise the default is
618 \fB\-\-fork\-point\fR\&. See also
619 \fBrebase\&.forkpoint\fR
620 in
621 \fBgit-config\fR(1)\&.
622 .sp
623 If your branch was based on
624 \fB<upstream>\fR
625 but
626 \fB<upstream>\fR
627 was rewound and your branch contains commits which were dropped, this option can be used with
628 \fB\-\-keep\-base\fR
629 in order to drop those commits from your branch\&.
630 .sp
631 See also INCOMPATIBLE OPTIONS below\&.
632 .RE
633 .PP
634 \-\-ignore\-whitespace
635 .RS 4
636 Ignore whitespace differences when trying to reconcile differences\&. Currently, each backend implements an approximation of this behavior:
637 .PP
638 apply backend
639 .RS 4
640 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\&.
641 .RE
642 .PP
643 merge backend
644 .RS 4
645 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\&.
646 .RE
647 .RE
648 .PP
649 \-\-whitespace=<option>
650 .RS 4
651 This flag is passed to the
652 \fBgit apply\fR
653 program (see
654 \fBgit-apply\fR(1)) that applies the patch\&. Implies
655 \fB\-\-apply\fR\&.
656 .sp
657 See also INCOMPATIBLE OPTIONS below\&.
658 .RE
659 .PP
660 \-\-committer\-date\-is\-author\-date
661 .RS 4
662 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
663 \fB\-\-force\-rebase\fR\&.
664 .RE
665 .PP
666 \-\-ignore\-date, \-\-reset\-author\-date
667 .RS 4
668 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
669 \fB\-\-force\-rebase\fR\&.
670 .sp
671 See also INCOMPATIBLE OPTIONS below\&.
672 .RE
673 .PP
674 \-\-signoff
675 .RS 4
676 Add a
677 \fBSigned\-off\-by\fR
678 trailer to all the rebased commits\&. Note that if
679 \fB\-\-interactive\fR
680 is given then only commits marked to be picked, edited or reworded will have the trailer added\&.
681 .sp
682 See also INCOMPATIBLE OPTIONS below\&.
683 .RE
684 .PP
685 \-i, \-\-interactive
686 .RS 4
687 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)\&.
688 .sp
689 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\&.
690 .sp
691 See also INCOMPATIBLE OPTIONS below\&.
692 .RE
693 .PP
694 \-r, \-\-rebase\-merges[=(rebase\-cousins|no\-rebase\-cousins)]
695 .RS 4
696 By default, a rebase will simply drop merge commits from the todo list, and put the rebased commits into a single, linear branch\&. With
697 \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\&.
698 .sp
699 By default, or when
700 \fBno\-rebase\-cousins\fR
701 was specified, commits which do not have
702 \fB<upstream>\fR
703 as direct ancestor will keep their original branch point, i\&.e\&. commits that would be excluded by
704 \fBgit-log\fR(1)\(aqs
705 \fB\-\-ancestry\-path\fR
706 option will keep their original ancestry by default\&. If the
707 \fBrebase\-cousins\fR
708 mode is turned on, such commits are instead rebased onto
709 \fB<upstream>\fR
710 (or
711 \fB<onto>\fR, if specified)\&.
712 .sp
713 It is currently only possible to recreate the merge commits using the
714 \fBort\fR
715 merge strategy; different merge strategies can be used only via explicit
716 \fBexec git merge \-s <strategy> [\&.\&.\&.]\fR
717 commands\&.
718 .sp
719 See also REBASING MERGES and INCOMPATIBLE OPTIONS below\&.
720 .RE
721 .PP
722 \-x <cmd>, \-\-exec <cmd>
723 .RS 4
724 Append "exec <cmd>" after each line creating a commit in the final history\&.
725 \fB<cmd>\fR
726 will be interpreted as one or more shell commands\&. Any command that fails will interrupt the rebase, with exit code 1\&.
727 .sp
728 You may execute several commands by either using one instance of
729 \fB\-\-exec\fR
730 with several commands:
731 .sp
732 .if n \{\
733 .RS 4
734 .\}
735 .nf
736 git rebase \-i \-\-exec "cmd1 && cmd2 && \&.\&.\&."
737 .fi
738 .if n \{\
739 .RE
740 .\}
741 .sp
742 or by giving more than one
743 \fB\-\-exec\fR:
744 .sp
745 .if n \{\
746 .RS 4
747 .\}
748 .nf
749 git rebase \-i \-\-exec "cmd1" \-\-exec "cmd2" \-\-exec \&.\&.\&.
750 .fi
751 .if n \{\
752 .RE
753 .\}
754 .sp
755 If
756 \fB\-\-autosquash\fR
757 is used,
758 \fBexec\fR
759 lines will not be appended for the intermediate commits, and will only appear at the end of each squash/fixup series\&.
760 .sp
761 This uses the
762 \fB\-\-interactive\fR
763 machinery internally, but it can be run without an explicit
764 \fB\-\-interactive\fR\&.
765 .sp
766 See also INCOMPATIBLE OPTIONS below\&.
767 .RE
768 .PP
769 \-\-root
770 .RS 4
771 Rebase all commits reachable from
772 \fB<branch>\fR, instead of limiting them with an
773 \fB<upstream>\fR\&. This allows you to rebase the root commit(s) on a branch\&. When used with
774 \fB\-\-onto\fR, it will skip changes already contained in
775 \fB<newbase>\fR
776 (instead of
777 \fB<upstream>\fR) whereas without
778 \fB\-\-onto\fR
779 it will operate on every change\&.
780 .sp
781 See also INCOMPATIBLE OPTIONS below\&.
782 .RE
783 .PP
784 \-\-autosquash, \-\-no\-autosquash
785 .RS 4
786 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
787 \fB\&.\&.\&.\fR, automatically modify the todo list of
788 \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
789 \fBpick\fR
790 to
791 \fBsquash\fR
792 or
793 \fBfixup\fR
794 or
795 \fBfixup \-C\fR
796 respectively\&. A commit matches the
797 \fB\&.\&.\&.\fR
798 if the commit subject matches, or if the
799 \fB\&.\&.\&.\fR
800 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
801 \fB\-\-fixup\fR,
802 \fB\-\-fixup=amend:\fR
803 or
804 \fB\-\-fixup=reword:\fR
805 and
806 \fB\-\-squash\fR
807 options respectively of
808 \fBgit-commit\fR(1)\&.
809 .sp
810 If the
811 \fB\-\-autosquash\fR
812 option is enabled by default using the configuration variable
813 \fBrebase\&.autoSquash\fR, this option can be used to override and disable this setting\&.
814 .sp
815 See also INCOMPATIBLE OPTIONS below\&.
816 .RE
817 .PP
818 \-\-autostash, \-\-no\-autostash
819 .RS 4
820 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\&.
821 .RE
822 .PP
823 \-\-reschedule\-failed\-exec, \-\-no\-reschedule\-failed\-exec
824 .RS 4
825 Automatically reschedule
826 \fBexec\fR
827 commands that failed\&. This only makes sense in interactive mode (or when an
828 \fB\-\-exec\fR
829 option was provided)\&.
830 .sp
831 Even though this option applies once a rebase is started, it\(cqs set for the whole rebase at the start based on either the
832 \fBrebase\&.rescheduleFailedExec\fR
833 configuration (see
834 \fBgit-config\fR(1)
835 or "CONFIGURATION" below) or whether this option is provided\&. Otherwise an explicit
836 \fB\-\-no\-reschedule\-failed\-exec\fR
837 at the start would be overridden by the presence of
838 \fBrebase\&.rescheduleFailedExec=true\fR
839 configuration\&.
840 .RE
841 .SH "INCOMPATIBLE OPTIONS"
842 .sp
843 The following options:
844 .sp
845 .RS 4
846 .ie n \{\
847 \h'-04'\(bu\h'+03'\c
848 .\}
849 .el \{\
850 .sp -1
851 .IP \(bu 2.3
852 .\}
853 \-\-apply
854 .RE
855 .sp
856 .RS 4
857 .ie n \{\
858 \h'-04'\(bu\h'+03'\c
859 .\}
860 .el \{\
861 .sp -1
862 .IP \(bu 2.3
863 .\}
864 \-\-whitespace
865 .RE
866 .sp
867 .RS 4
868 .ie n \{\
869 \h'-04'\(bu\h'+03'\c
870 .\}
871 .el \{\
872 .sp -1
873 .IP \(bu 2.3
874 .\}
875 \-C
876 .RE
877 .sp
878 are incompatible with the following options:
879 .sp
880 .RS 4
881 .ie n \{\
882 \h'-04'\(bu\h'+03'\c
883 .\}
884 .el \{\
885 .sp -1
886 .IP \(bu 2.3
887 .\}
888 \-\-merge
889 .RE
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 \-\-strategy
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 \-\-strategy\-option
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 \-\-allow\-empty\-message
922 .RE
923 .sp
924 .RS 4
925 .ie n \{\
926 \h'-04'\(bu\h'+03'\c
927 .\}
928 .el \{\
929 .sp -1
930 .IP \(bu 2.3
931 .\}
932 \-\-[no\-]autosquash
933 .RE
934 .sp
935 .RS 4
936 .ie n \{\
937 \h'-04'\(bu\h'+03'\c
938 .\}
939 .el \{\
940 .sp -1
941 .IP \(bu 2.3
942 .\}
943 \-\-rebase\-merges
944 .RE
945 .sp
946 .RS 4
947 .ie n \{\
948 \h'-04'\(bu\h'+03'\c
949 .\}
950 .el \{\
951 .sp -1
952 .IP \(bu 2.3
953 .\}
954 \-\-interactive
955 .RE
956 .sp
957 .RS 4
958 .ie n \{\
959 \h'-04'\(bu\h'+03'\c
960 .\}
961 .el \{\
962 .sp -1
963 .IP \(bu 2.3
964 .\}
965 \-\-exec
966 .RE
967 .sp
968 .RS 4
969 .ie n \{\
970 \h'-04'\(bu\h'+03'\c
971 .\}
972 .el \{\
973 .sp -1
974 .IP \(bu 2.3
975 .\}
976 \-\-no\-keep\-empty
977 .RE
978 .sp
979 .RS 4
980 .ie n \{\
981 \h'-04'\(bu\h'+03'\c
982 .\}
983 .el \{\
984 .sp -1
985 .IP \(bu 2.3
986 .\}
987 \-\-empty=
988 .RE
989 .sp
990 .RS 4
991 .ie n \{\
992 \h'-04'\(bu\h'+03'\c
993 .\}
994 .el \{\
995 .sp -1
996 .IP \(bu 2.3
997 .\}
998 \-\-reapply\-cherry\-picks
999 .RE
1000 .sp
1001 .RS 4
1002 .ie n \{\
1003 \h'-04'\(bu\h'+03'\c
1004 .\}
1005 .el \{\
1006 .sp -1
1007 .IP \(bu 2.3
1008 .\}
1009 \-\-edit\-todo
1010 .RE
1011 .sp
1012 .RS 4
1013 .ie n \{\
1014 \h'-04'\(bu\h'+03'\c
1015 .\}
1016 .el \{\
1017 .sp -1
1018 .IP \(bu 2.3
1019 .\}
1020 \-\-root when used in combination with \-\-onto
1021 .RE
1022 .sp
1023 In addition, the following pairs of options are incompatible:
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 \-\-keep\-base and \-\-onto
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 \-\-keep\-base and \-\-root
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 \-\-fork\-point and \-\-root
1056 .RE
1057 .SH "BEHAVIORAL DIFFERENCES"
1058 .sp
1059 \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:
1060 .SS "Empty commits"
1061 .sp
1062 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\&.
1063 .sp
1064 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)\&.
1065 .sp
1066 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\&.
1067 .SS "Directory rename detection"
1068 .sp
1069 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\&.
1070 .sp
1071 Directory rename detection works with the \fImerge\fR backend to provide you warnings in such cases\&.
1072 .SS "Context"
1073 .sp
1074 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)\&.
1075 .sp
1076 The \fImerge\fR backend works with a full copy of each relevant file, insulating it from these types of problems\&.
1077 .SS "Labelling of conflicts markers"
1078 .sp
1079 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\&.
1080 .sp
1081 The \fImerge\fR backend works with the full commits on both sides of history and thus has no such limitations\&.
1082 .SS "Hooks"
1083 .sp
1084 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\&.
1085 .SS "Interruptability"
1086 .sp
1087 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\&.)
1088 .SS "Commit Rewording"
1089 .sp
1090 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\&.
1091 .SS "Miscellaneous differences"
1092 .sp
1093 There are a few more behavioral differences that most folks would probably consider inconsequential but which are mentioned for completeness:
1094 .sp
1095 .RS 4
1096 .ie n \{\
1097 \h'-04'\(bu\h'+03'\c
1098 .\}
1099 .el \{\
1100 .sp -1
1101 .IP \(bu 2.3
1102 .\}
1103 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"\&.
1104 .RE
1105 .sp
1106 .RS 4
1107 .ie n \{\
1108 \h'-04'\(bu\h'+03'\c
1109 .\}
1110 .el \{\
1111 .sp -1
1112 .IP \(bu 2.3
1113 .\}
1114 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\&.
1115 .RE
1116 .sp
1117 .RS 4
1118 .ie n \{\
1119 \h'-04'\(bu\h'+03'\c
1120 .\}
1121 .el \{\
1122 .sp -1
1123 .IP \(bu 2.3
1124 .\}
1125 State directories: The two backends keep their state in different directories under
1126 \fB\&.git/\fR
1127 .RE
1128 .SH "MERGE STRATEGIES"
1129 .sp
1130 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\&.
1131 .PP
1132 ort
1133 .RS 4
1134 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,
1135 \fBrecursive\fR\&.
1136 .sp
1137 The
1138 \fIort\fR
1139 strategy can take the following options:
1140 .PP
1141 ours
1142 .RS 4
1143 This option forces conflicting hunks to be auto\-resolved cleanly by favoring
1144 \fIour\fR
1145 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\&.
1146 .sp
1147 This should not be confused with the
1148 \fIours\fR
1149 merge strategy, which does not even look at what the other tree contains at all\&. It discards everything the other tree did, declaring
1150 \fIour\fR
1151 history contains all that happened in it\&.
1152 .RE
1153 .PP
1154 theirs
1155 .RS 4
1156 This is the opposite of
1157 \fIours\fR; note that, unlike
1158 \fIours\fR, there is no
1159 \fItheirs\fR
1160 merge strategy to confuse this merge option with\&.
1161 .RE
1162 .PP
1163 ignore\-space\-change, ignore\-all\-space, ignore\-space\-at\-eol, ignore\-cr\-at\-eol
1164 .RS 4
1165 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
1166 \fBgit-diff\fR(1)
1167 \fB\-b\fR,
1168 \fB\-w\fR,
1169 \fB\-\-ignore\-space\-at\-eol\fR, and
1170 \fB\-\-ignore\-cr\-at\-eol\fR\&.
1171 .sp
1172 .RS 4
1173 .ie n \{\
1174 \h'-04'\(bu\h'+03'\c
1175 .\}
1176 .el \{\
1177 .sp -1
1178 .IP \(bu 2.3
1179 .\}
1180 If
1181 \fItheir\fR
1182 version only introduces whitespace changes to a line,
1183 \fIour\fR
1184 version is used;
1185 .RE
1186 .sp
1187 .RS 4
1188 .ie n \{\
1189 \h'-04'\(bu\h'+03'\c
1190 .\}
1191 .el \{\
1192 .sp -1
1193 .IP \(bu 2.3
1194 .\}
1195 If
1196 \fIour\fR
1197 version introduces whitespace changes but
1198 \fItheir\fR
1199 version includes a substantial change,
1200 \fItheir\fR
1201 version is used;
1202 .RE
1203 .sp
1204 .RS 4
1205 .ie n \{\
1206 \h'-04'\(bu\h'+03'\c
1207 .\}
1208 .el \{\
1209 .sp -1
1210 .IP \(bu 2.3
1211 .\}
1212 Otherwise, the merge proceeds in the usual way\&.
1213 .RE
1214 .RE
1215 .PP
1216 renormalize
1217 .RS 4
1218 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
1219 \fBgitattributes\fR(5)
1220 for details\&.
1221 .RE
1222 .PP
1223 no\-renormalize
1224 .RS 4
1225 Disables the
1226 \fBrenormalize\fR
1227 option\&. This overrides the
1228 \fBmerge\&.renormalize\fR
1229 configuration variable\&.
1230 .RE
1231 .PP
1232 find\-renames[=<n>]
1233 .RS 4
1234 Turn on rename detection, optionally setting the similarity threshold\&. This is the default\&. This overrides the
1235 \fImerge\&.renames\fR
1236 configuration variable\&. See also
1237 \fBgit-diff\fR(1)
1238 \fB\-\-find\-renames\fR\&.
1239 .RE
1240 .PP
1241 rename\-threshold=<n>
1242 .RS 4
1243 Deprecated synonym for
1244 \fBfind\-renames=<n>\fR\&.
1245 .RE
1246 .PP
1247 subtree[=<path>]
1248 .RS 4
1249 This option is a more advanced form of
1250 \fIsubtree\fR
1251 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\&.
1252 .RE
1253 .RE
1254 .PP
1255 recursive
1256 .RS 4
1257 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\&.
1258 .sp
1259 The
1260 \fIrecursive\fR
1261 strategy takes the same options as
1262 \fIort\fR\&. However, there are three additional options that
1263 \fIort\fR
1264 ignores (not documented above) that are potentially useful with the
1265 \fIrecursive\fR
1266 strategy:
1267 .PP
1268 patience
1269 .RS 4
1270 Deprecated synonym for
1271 \fBdiff\-algorithm=patience\fR\&.
1272 .RE
1273 .PP
1274 diff\-algorithm=[patience|minimal|histogram|myers]
1275 .RS 4
1276 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
1277 \fBgit-diff\fR(1)
1278 \fB\-\-diff\-algorithm\fR\&. Note that
1279 \fBort\fR
1280 specifically uses
1281 \fBdiff\-algorithm=histogram\fR, while
1282 \fBrecursive\fR
1283 defaults to the
1284 \fBdiff\&.algorithm\fR
1285 config setting\&.
1286 .RE
1287 .PP
1288 no\-renames
1289 .RS 4
1290 Turn off rename detection\&. This overrides the
1291 \fBmerge\&.renames\fR
1292 configuration variable\&. See also
1293 \fBgit-diff\fR(1)
1294 \fB\-\-no\-renames\fR\&.
1295 .RE
1296 .RE
1297 .PP
1298 resolve
1299 .RS 4
1300 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\&.
1301 .RE
1302 .PP
1303 octopus
1304 .RS 4
1305 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\&.
1306 .RE
1307 .PP
1308 ours
1309 .RS 4
1310 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
1311 \fIrecursive\fR
1312 merge strategy\&.
1313 .RE
1314 .PP
1315 subtree
1316 .RS 4
1317 This is a modified
1318 \fBort\fR
1319 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\&.
1320 .RE
1321 .sp
1322 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\&.
1323 .SH "NOTES"
1324 .sp
1325 You should understand the implications of using \fBgit rebase\fR on a repository that you share\&. See also RECOVERING FROM UPSTREAM REBASE below\&.
1326 .sp
1327 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\&.
1328 .sp
1329 Upon completion, \fB<branch>\fR will be the current branch\&.
1330 .SH "INTERACTIVE MODE"
1331 .sp
1332 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)\&.
1333 .sp
1334 The interactive mode is meant for this type of workflow:
1335 .sp
1336 .RS 4
1337 .ie n \{\
1338 \h'-04' 1.\h'+01'\c
1339 .\}
1340 .el \{\
1341 .sp -1
1342 .IP " 1." 4.2
1343 .\}
1344 have a wonderful idea
1345 .RE
1346 .sp
1347 .RS 4
1348 .ie n \{\
1349 \h'-04' 2.\h'+01'\c
1350 .\}
1351 .el \{\
1352 .sp -1
1353 .IP " 2." 4.2
1354 .\}
1355 hack on the code
1356 .RE
1357 .sp
1358 .RS 4
1359 .ie n \{\
1360 \h'-04' 3.\h'+01'\c
1361 .\}
1362 .el \{\
1363 .sp -1
1364 .IP " 3." 4.2
1365 .\}
1366 prepare a series for submission
1367 .RE
1368 .sp
1369 .RS 4
1370 .ie n \{\
1371 \h'-04' 4.\h'+01'\c
1372 .\}
1373 .el \{\
1374 .sp -1
1375 .IP " 4." 4.2
1376 .\}
1377 submit
1378 .RE
1379 .sp
1380 where point 2\&. consists of several instances of
1381 .sp
1382 a) regular use
1383 .sp
1384 .RS 4
1385 .ie n \{\
1386 \h'-04' 1.\h'+01'\c
1387 .\}
1388 .el \{\
1389 .sp -1
1390 .IP " 1." 4.2
1391 .\}
1392 finish something worthy of a commit
1393 .RE
1394 .sp
1395 .RS 4
1396 .ie n \{\
1397 \h'-04' 2.\h'+01'\c
1398 .\}
1399 .el \{\
1400 .sp -1
1401 .IP " 2." 4.2
1402 .\}
1403 commit
1404 .RE
1405 .sp
1406 b) independent fixup
1407 .sp
1408 .RS 4
1409 .ie n \{\
1410 \h'-04' 1.\h'+01'\c
1411 .\}
1412 .el \{\
1413 .sp -1
1414 .IP " 1." 4.2
1415 .\}
1416 realize that something does not work
1417 .RE
1418 .sp
1419 .RS 4
1420 .ie n \{\
1421 \h'-04' 2.\h'+01'\c
1422 .\}
1423 .el \{\
1424 .sp -1
1425 .IP " 2." 4.2
1426 .\}
1427 fix that
1428 .RE
1429 .sp
1430 .RS 4
1431 .ie n \{\
1432 \h'-04' 3.\h'+01'\c
1433 .\}
1434 .el \{\
1435 .sp -1
1436 .IP " 3." 4.2
1437 .\}
1438 commit it
1439 .RE
1440 .sp
1441 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\&.
1442 .sp
1443 Start it with the last commit you want to retain as\-is:
1444 .sp
1445 .if n \{\
1446 .RS 4
1447 .\}
1448 .nf
1449 git rebase \-i <after\-this\-commit>
1450 .fi
1451 .if n \{\
1452 .RE
1453 .\}
1454 .sp
1455 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:
1456 .sp
1457 .if n \{\
1458 .RS 4
1459 .\}
1460 .nf
1461 pick deadbee The oneline of this commit
1462 pick fa1afe1 The oneline of the next commit
1463 \&.\&.\&.
1464 .fi
1465 .if n \{\
1466 .RE
1467 .\}
1468 .sp
1469 .sp
1470 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\&.
1471 .sp
1472 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\&.
1473 .sp
1474 To interrupt the rebase (just like an "edit" command would do, but without cherry\-picking any commit first), use the "break" command\&.
1475 .sp
1476 If you just want to edit the commit message for a commit, replace the command "pick" with the command "reword"\&.
1477 .sp
1478 To drop a commit, replace the command "pick" with "drop", or just delete the matching line\&.
1479 .sp
1480 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\&.
1481 .sp
1482 \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\&.
1483 .sp
1484 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:
1485 .sp
1486 .if n \{\
1487 .RS 4
1488 .\}
1489 .nf
1490 $ git rebase \-i HEAD~5
1491 .fi
1492 .if n \{\
1493 .RE
1494 .\}
1495 .sp
1496 .sp
1497 And move the first patch to the end of the list\&.
1498 .sp
1499 You might want to recreate merge commits, e\&.g\&. if you have a history like this:
1500 .sp
1501 .if n \{\
1502 .RS 4
1503 .\}
1504 .nf
1505 X
1506 \e
1507 A\-\-\-M\-\-\-B
1508 /
1509 \-\-\-o\-\-\-O\-\-\-P\-\-\-Q
1510 .fi
1511 .if n \{\
1512 .RE
1513 .\}
1514 .sp
1515 .sp
1516 Suppose you want to rebase the side branch starting at "A" to "Q"\&. Make sure that the current \fBHEAD\fR is "B", and call
1517 .sp
1518 .if n \{\
1519 .RS 4
1520 .\}
1521 .nf
1522 $ git rebase \-i \-r \-\-onto Q O
1523 .fi
1524 .if n \{\
1525 .RE
1526 .\}
1527 .sp
1528 .sp
1529 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:
1530 .sp
1531 .if n \{\
1532 .RS 4
1533 .\}
1534 .nf
1535 pick deadbee Implement feature XXX
1536 fixup f1a5c00 Fix to feature XXX
1537 exec make
1538 pick c0ffeee The oneline of the next commit
1539 edit deadbab The oneline of the commit after
1540 exec cd subdir; make test
1541 \&.\&.\&.
1542 .fi
1543 .if n \{\
1544 .RE
1545 .\}
1546 .sp
1547 .sp
1548 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\&.
1549 .sp
1550 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\&.
1551 .sp
1552 .if n \{\
1553 .RS 4
1554 .\}
1555 .nf
1556 $ git rebase \-i \-\-exec "make test"
1557 .fi
1558 .if n \{\
1559 .RE
1560 .\}
1561 .sp
1562 .sp
1563 This command lets you check that intermediate commits are compilable\&. The todo list becomes like that:
1564 .sp
1565 .if n \{\
1566 .RS 4
1567 .\}
1568 .nf
1569 pick 5928aea one
1570 exec make test
1571 pick 04d0fda two
1572 exec make test
1573 pick ba46169 three
1574 exec make test
1575 pick f4593f9 four
1576 exec make test
1577 .fi
1578 .if n \{\
1579 .RE
1580 .\}
1581 .sp
1582 .SH "SPLITTING COMMITS"
1583 .sp
1584 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:
1585 .sp
1586 .RS 4
1587 .ie n \{\
1588 \h'-04'\(bu\h'+03'\c
1589 .\}
1590 .el \{\
1591 .sp -1
1592 .IP \(bu 2.3
1593 .\}
1594 Start an interactive rebase with
1595 \fBgit rebase \-i <commit>^\fR, where
1596 \fB<commit>\fR
1597 is the commit you want to split\&. In fact, any commit range will do, as long as it contains that commit\&.
1598 .RE
1599 .sp
1600 .RS 4
1601 .ie n \{\
1602 \h'-04'\(bu\h'+03'\c
1603 .\}
1604 .el \{\
1605 .sp -1
1606 .IP \(bu 2.3
1607 .\}
1608 Mark the commit you want to split with the action "edit"\&.
1609 .RE
1610 .sp
1611 .RS 4
1612 .ie n \{\
1613 \h'-04'\(bu\h'+03'\c
1614 .\}
1615 .el \{\
1616 .sp -1
1617 .IP \(bu 2.3
1618 .\}
1619 When it comes to editing that commit, execute
1620 \fBgit reset HEAD^\fR\&. The effect is that the
1621 \fBHEAD\fR
1622 is rewound by one, and the index follows suit\&. However, the working tree stays the same\&.
1623 .RE
1624 .sp
1625 .RS 4
1626 .ie n \{\
1627 \h'-04'\(bu\h'+03'\c
1628 .\}
1629 .el \{\
1630 .sp -1
1631 .IP \(bu 2.3
1632 .\}
1633 Now add the changes to the index that you want to have in the first commit\&. You can use
1634 \fBgit add\fR
1635 (possibly interactively) or
1636 \fBgit gui\fR
1637 (or both) to do that\&.
1638 .RE
1639 .sp
1640 .RS 4
1641 .ie n \{\
1642 \h'-04'\(bu\h'+03'\c
1643 .\}
1644 .el \{\
1645 .sp -1
1646 .IP \(bu 2.3
1647 .\}
1648 Commit the now\-current index with whatever commit message is appropriate now\&.
1649 .RE
1650 .sp
1651 .RS 4
1652 .ie n \{\
1653 \h'-04'\(bu\h'+03'\c
1654 .\}
1655 .el \{\
1656 .sp -1
1657 .IP \(bu 2.3
1658 .\}
1659 Repeat the last two steps until your working tree is clean\&.
1660 .RE
1661 .sp
1662 .RS 4
1663 .ie n \{\
1664 \h'-04'\(bu\h'+03'\c
1665 .\}
1666 .el \{\
1667 .sp -1
1668 .IP \(bu 2.3
1669 .\}
1670 Continue the rebase with
1671 \fBgit rebase \-\-continue\fR\&.
1672 .RE
1673 .sp
1674 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\&.
1675 .SH "RECOVERING FROM UPSTREAM REBASE"
1676 .sp
1677 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\&.
1678 .sp
1679 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:
1680 .sp
1681 .if n \{\
1682 .RS 4
1683 .\}
1684 .nf
1685 o\-\-\-o\-\-\-o\-\-\-o\-\-\-o\-\-\-o\-\-\-o\-\-\-o master
1686 \e
1687 o\-\-\-o\-\-\-o\-\-\-o\-\-\-o subsystem
1688 \e
1689 *\-\-\-*\-\-\-* topic
1690 .fi
1691 .if n \{\
1692 .RE
1693 .\}
1694 .sp
1695 .sp
1696 If \fIsubsystem\fR is rebased against \fImaster\fR, the following happens:
1697 .sp
1698 .if n \{\
1699 .RS 4
1700 .\}
1701 .nf
1702 o\-\-\-o\-\-\-o\-\-\-o\-\-\-o\-\-\-o\-\-\-o\-\-\-o master
1703 \e \e
1704 o\-\-\-o\-\-\-o\-\-\-o\-\-\-o o\(aq\-\-o\(aq\-\-o\(aq\-\-o\(aq\-\-o\(aq subsystem
1705 \e
1706 *\-\-\-*\-\-\-* topic
1707 .fi
1708 .if n \{\
1709 .RE
1710 .\}
1711 .sp
1712 .sp
1713 If you now continue development as usual, and eventually merge \fItopic\fR to \fIsubsystem\fR, the commits from \fIsubsystem\fR will remain duplicated forever:
1714 .sp
1715 .if n \{\
1716 .RS 4
1717 .\}
1718 .nf
1719 o\-\-\-o\-\-\-o\-\-\-o\-\-\-o\-\-\-o\-\-\-o\-\-\-o master
1720 \e \e
1721 o\-\-\-o\-\-\-o\-\-\-o\-\-\-o o\(aq\-\-o\(aq\-\-o\(aq\-\-o\(aq\-\-o\(aq\-\-M subsystem
1722 \e /
1723 *\-\-\-*\-\-\-*\-\&.\&.\&.\&.\&.\&.\&.\&.\&.\&.\-*\-\-* topic
1724 .fi
1725 .if n \{\
1726 .RE
1727 .\}
1728 .sp
1729 .sp
1730 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!
1731 .sp
1732 There are two kinds of fixes, discussed in the following subsections:
1733 .PP
1734 Easy case: The changes are literally the same\&.
1735 .RS 4
1736 This happens if the
1737 \fIsubsystem\fR
1738 rebase was a simple rebase and had no conflicts\&.
1739 .RE
1740 .PP
1741 Hard case: The changes are not the same\&.
1742 .RS 4
1743 This happens if the
1744 \fIsubsystem\fR
1745 rebase had conflicts, or used
1746 \fB\-\-interactive\fR
1747 to omit, edit, squash, or fixup commits; or if the upstream used one of
1748 \fBcommit \-\-amend\fR,
1749 \fBreset\fR, or a full history rewriting command like
1750 \m[blue]\fB\fBfilter\-repo\fR\fR\m[]\&\s-2\u[2]\d\s+2\&.
1751 .RE
1752 .SS "The easy case"
1753 .sp
1754 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\&.
1755 .sp
1756 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)
1757 .sp
1758 .if n \{\
1759 .RS 4
1760 .\}
1761 .nf
1762 $ git rebase subsystem
1763 .fi
1764 .if n \{\
1765 .RE
1766 .\}
1767 .sp
1768 .sp
1769 you will end up with the fixed history
1770 .sp
1771 .if n \{\
1772 .RS 4
1773 .\}
1774 .nf
1775 o\-\-\-o\-\-\-o\-\-\-o\-\-\-o\-\-\-o\-\-\-o\-\-\-o master
1776 \e
1777 o\(aq\-\-o\(aq\-\-o\(aq\-\-o\(aq\-\-o\(aq subsystem
1778 \e
1779 *\-\-\-*\-\-\-* topic
1780 .fi
1781 .if n \{\
1782 .RE
1783 .\}
1784 .sp
1785 .SS "The hard case"
1786 .sp
1787 Things get more complicated if the \fIsubsystem\fR changes do not exactly correspond to the ones before the rebase\&.
1788 .if n \{\
1789 .sp
1790 .\}
1791 .RS 4
1792 .it 1 an-trap
1793 .nr an-no-space-flag 1
1794 .nr an-break-flag 1
1795 .br
1796 .ps +1
1797 \fBNote\fR
1798 .ps -1
1799 .br
1800 .sp
1801 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!
1802 .sp .5v
1803 .RE
1804 .sp
1805 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:
1806 .sp
1807 .RS 4
1808 .ie n \{\
1809 \h'-04'\(bu\h'+03'\c
1810 .\}
1811 .el \{\
1812 .sp -1
1813 .IP \(bu 2.3
1814 .\}
1815 With the
1816 \fIsubsystem\fR
1817 reflog: after
1818 \fBgit fetch\fR, the old tip of
1819 \fIsubsystem\fR
1820 is at
1821 \fBsubsystem@{1}\fR\&. Subsequent fetches will increase the number\&. (See
1822 \fBgit-reflog\fR(1)\&.)
1823 .RE
1824 .sp
1825 .RS 4
1826 .ie n \{\
1827 \h'-04'\(bu\h'+03'\c
1828 .\}
1829 .el \{\
1830 .sp -1
1831 .IP \(bu 2.3
1832 .\}
1833 Relative to the tip of
1834 \fItopic\fR: knowing that your
1835 \fItopic\fR
1836 has three commits, the old tip of
1837 \fIsubsystem\fR
1838 must be
1839 \fBtopic~3\fR\&.
1840 .RE
1841 .sp
1842 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):
1843 .sp
1844 .if n \{\
1845 .RS 4
1846 .\}
1847 .nf
1848 $ git rebase \-\-onto subsystem subsystem@{1}
1849 .fi
1850 .if n \{\
1851 .RE
1852 .\}
1853 .sp
1854 .sp
1855 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!
1856 .SH "REBASING MERGES"
1857 .sp
1858 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)\&.
1859 .sp
1860 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\&.
1861 .sp
1862 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:
1863 .sp
1864 .if n \{\
1865 .RS 4
1866 .\}
1867 .nf
1868 * Merge branch \(aqreport\-a\-bug\(aq
1869 |\e
1870 | * Add the feedback button
1871 * | Merge branch \(aqrefactor\-button\(aq
1872 |\e \e
1873 | |/
1874 | * Use the Button class for all buttons
1875 | * Extract a generic Button class from the DownloadButton one
1876 .fi
1877 .if n \{\
1878 .RE
1879 .\}
1880 .sp
1881 .sp
1882 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\&.
1883 .sp
1884 This rebase can be performed using the \fB\-\-rebase\-merges\fR option\&. It will generate a todo list looking like this:
1885 .sp
1886 .if n \{\
1887 .RS 4
1888 .\}
1889 .nf
1890 label onto
1892 # Branch: refactor\-button
1893 reset onto
1894 pick 123456 Extract a generic Button class from the DownloadButton one
1895 pick 654321 Use the Button class for all buttons
1896 label refactor\-button
1898 # Branch: report\-a\-bug
1899 reset refactor\-button # Use the Button class for all buttons
1900 pick abcdef Add the feedback button
1901 label report\-a\-bug
1903 reset onto
1904 merge \-C a1b2c3 refactor\-button # Merge \(aqrefactor\-button\(aq
1905 merge \-C 6f5e4d report\-a\-bug # Merge \(aqreport\-a\-bug\(aq
1906 .fi
1907 .if n \{\
1908 .RE
1909 .\}
1910 .sp
1911 .sp
1912 In contrast to a regular interactive rebase, there are \fBlabel\fR, \fBreset\fR and \fBmerge\fR commands in addition to \fBpick\fR ones\&.
1913 .sp
1914 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\&.
1915 .sp
1916 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)\&.
1917 .sp
1918 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\&.
1919 .sp
1920 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\&.
1921 .sp
1922 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\&.
1923 .sp
1924 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\&.
1925 .sp
1926 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:
1927 .sp
1928 .if n \{\
1929 .RS 4
1930 .\}
1931 .nf
1932 pick 192837 Switch from GNU Makefiles to CMake
1933 pick 5a6c7e Document the switch to CMake
1934 pick 918273 Fix detection of OpenSSL in CMake
1935 pick afbecd http: add support for TLS v1\&.3
1936 pick fdbaec Fix detection of cURL in CMake on Windows
1937 .fi
1938 .if n \{\
1939 .RE
1940 .\}
1941 .sp
1942 .sp
1943 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:
1944 .sp
1945 .if n \{\
1946 .RS 4
1947 .\}
1948 .nf
1949 label onto
1951 pick afbecd http: add support for TLS v1\&.3
1952 label tlsv1\&.3
1954 reset onto
1955 pick 192837 Switch from GNU Makefiles to CMake
1956 pick 918273 Fix detection of OpenSSL in CMake
1957 pick fdbaec Fix detection of cURL in CMake on Windows
1958 pick 5a6c7e Document the switch to CMake
1959 label cmake
1961 reset onto
1962 merge tlsv1\&.3
1963 merge cmake
1964 .fi
1965 .if n \{\
1966 .RE
1967 .\}
1968 .sp
1969 .SH "CONFIGURATION"
1970 .PP
1971 rebase\&.backend
1972 .RS 4
1973 Default backend to use for rebasing\&. Possible choices are
1974 \fIapply\fR
1975 or
1976 \fImerge\fR\&. In the future, if the merge backend gains all remaining capabilities of the apply backend, this setting may become unused\&.
1977 .RE
1978 .PP
1979 rebase\&.stat
1980 .RS 4
1981 Whether to show a diffstat of what changed upstream since the last rebase\&. False by default\&.
1982 .RE
1983 .PP
1984 rebase\&.autoSquash
1985 .RS 4
1986 If set to true enable
1987 \fB\-\-autosquash\fR
1988 option by default\&.
1989 .RE
1990 .PP
1991 rebase\&.autoStash
1992 .RS 4
1993 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
1994 \fB\-\-no\-autostash\fR
1995 and
1996 \fB\-\-autostash\fR
1997 options of
1998 \fBgit-rebase\fR(1)\&. Defaults to false\&.
1999 .RE
2000 .PP
2001 rebase\&.missingCommitsCheck
2002 .RS 4
2003 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,
2004 \fIgit rebase \-\-edit\-todo\fR
2005 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
2006 \fBdrop\fR
2007 command in the todo list\&. Defaults to "ignore"\&.
2008 .RE
2009 .PP
2010 rebase\&.instructionFormat
2011 .RS 4
2012 A format string, as specified in
2013 \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\&.
2014 .RE
2015 .PP
2016 rebase\&.abbreviateCommands
2017 .RS 4
2018 If set to true,
2019 \fBgit rebase\fR
2020 will use abbreviated command names in the todo list resulting in something like this:
2021 .sp
2022 .if n \{\
2023 .RS 4
2024 .\}
2025 .nf
2026 p deadbee The oneline of the commit
2027 p fa1afe1 The oneline of the next commit
2028 \&.\&.\&.
2029 .fi
2030 .if n \{\
2031 .RE
2032 .\}
2033 .sp
2034 instead of:
2035 .sp
2036 .if n \{\
2037 .RS 4
2038 .\}
2039 .nf
2040 pick deadbee The oneline of the commit
2041 pick fa1afe1 The oneline of the next commit
2042 \&.\&.\&.
2043 .fi
2044 .if n \{\
2045 .RE
2046 .\}
2047 .sp
2048 Defaults to false\&.
2049 .RE
2050 .PP
2051 rebase\&.rescheduleFailedExec
2052 .RS 4
2053 Automatically reschedule
2054 \fBexec\fR
2055 commands that failed\&. This only makes sense in interactive mode (or when an
2056 \fB\-\-exec\fR
2057 option was provided)\&. This is the same as specifying the
2058 \fB\-\-reschedule\-failed\-exec\fR
2059 option\&.
2060 .RE
2061 .PP
2062 rebase\&.forkPoint
2063 .RS 4
2064 If set to false set
2065 \fB\-\-no\-fork\-point\fR
2066 option by default\&.
2067 .RE
2068 .PP
2069 sequence\&.editor
2070 .RS 4
2071 Text editor used by
2072 \fBgit rebase \-i\fR
2073 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
2074 \fBGIT_SEQUENCE_EDITOR\fR
2075 environment variable\&. When not configured the default commit message editor is used instead\&.
2076 .RE
2077 .SH "GIT"
2078 .sp
2079 Part of the \fBgit\fR(1) suite
2080 .SH "NOTES"
2081 .IP " 1." 4
2082 revert-a-faulty-merge How-To
2083 .RS 4
2084 \%git-htmldocs/howto/revert-a-faulty-merge.html
2085 .RE
2086 .IP " 2." 4
2087 \fBfilter-repo\fR
2088 .RS 4
2089 \%https://github.com/newren/git-filter-repo
2090 .RE