]>
Commit | Line | Data |
---|---|---|
215a7ad1 JH |
1 | git-rebase(1) |
2 | ============= | |
7fc9d69f JH |
3 | |
4 | NAME | |
5 | ---- | |
b385085b | 6 | git-rebase - Reapply commits on top of another base tip |
7fc9d69f JH |
7 | |
8 | SYNOPSIS | |
9 | -------- | |
e448ff87 | 10 | [verse] |
414d924b DL |
11 | 'git rebase' [-i | --interactive] [<options>] [--exec <cmd>] |
12 | [--onto <newbase> | --keep-base] [<upstream> [<branch>]] | |
de613050 | 13 | 'git rebase' [-i | --interactive] [<options>] [--exec <cmd>] [--onto <newbase>] |
be496621 | 14 | --root [<branch>] |
0620ae0f | 15 | 'git rebase' (--continue|--skip|--abort|--quit|--edit-todo|--show-current-patch) |
031321c6 | 16 | |
7fc9d69f JH |
17 | DESCRIPTION |
18 | ----------- | |
54e51e55 | 19 | If `<branch>` is specified, `git rebase` will perform an automatic |
328c6cb8 | 20 | `git switch <branch>` before doing anything else. Otherwise |
5ca2db53 SP |
21 | it remains on the current branch. |
22 | ||
54e51e55 DS |
23 | If `<upstream>` is not specified, the upstream configured in |
24 | `branch.<name>.remote` and `branch.<name>.merge` options will be used (see | |
f51a48ec SO |
25 | linkgit:git-config[1] for details) and the `--fork-point` option is |
26 | assumed. If you are currently not on any branch or if the current | |
27 | branch does not have a configured upstream, the rebase will abort. | |
15a147e6 | 28 | |
5ca2db53 | 29 | All changes made by commits in the current branch but that are not |
54e51e55 | 30 | in `<upstream>` are saved to a temporary area. This is the same set |
f51a48ec SO |
31 | of commits that would be shown by `git log <upstream>..HEAD`; or by |
32 | `git log 'fork_point'..HEAD`, if `--fork-point` is active (see the | |
33 | description on `--fork-point` below); or by `git log HEAD`, if the | |
34 | `--root` option is specified. | |
5ca2db53 | 35 | |
54e51e55 DS |
36 | The current branch is reset to `<upstream>` or `<newbase>` if the |
37 | `--onto` option was supplied. This has the exact same effect as | |
38 | `git reset --hard <upstream>` (or `<newbase>`). `ORIG_HEAD` is set | |
9869099b | 39 | to point at the tip of the branch before the reset. |
5ca2db53 | 40 | |
f1c9243f PB |
41 | [NOTE] |
42 | `ORIG_HEAD` is not guaranteed to still point to the previous branch tip | |
43 | at the end of the rebase if other commands that write that pseudo-ref | |
44 | (e.g. `git reset`) are used during the rebase. The previous branch tip, | |
45 | however, is accessible using the reflog of the current branch | |
46 | (i.e. `@{1}`, see linkgit:gitrevisions[7]). | |
47 | ||
5ca2db53 | 48 | The commits that were previously saved into the temporary area are |
ff905462 | 49 | then reapplied to the current branch, one by one, in order. Note that |
54e51e55 DS |
50 | any commits in `HEAD` which introduce the same textual changes as a commit |
51 | in `HEAD..<upstream>` are omitted (i.e., a patch already accepted upstream | |
ff905462 | 52 | with a different commit message or timestamp will be skipped). |
69a60af5 | 53 | |
031321c6 SE |
54 | It is possible that a merge failure will prevent this process from being |
55 | completely automatic. You will have to resolve any such merge failure | |
cc120056 | 56 | and run `git rebase --continue`. Another option is to bypass the commit |
5960bc9d | 57 | that caused the merge failure with `git rebase --skip`. To check out the |
54e51e55 DS |
58 | original `<branch>` and remove the `.git/rebase-apply` working files, use |
59 | the command `git rebase --abort` instead. | |
031321c6 | 60 | |
69a60af5 CW |
61 | Assume the following history exists and the current branch is "topic": |
62 | ||
031321c6 | 63 | ------------ |
69a60af5 CW |
64 | A---B---C topic |
65 | / | |
66 | D---E---F---G master | |
031321c6 | 67 | ------------ |
69a60af5 | 68 | |
228382ae | 69 | From this point, the result of either of the following commands: |
69a60af5 | 70 | |
031321c6 | 71 | |
b1889c36 JN |
72 | git rebase master |
73 | git rebase master topic | |
69a60af5 CW |
74 | |
75 | would be: | |
76 | ||
031321c6 | 77 | ------------ |
69a60af5 CW |
78 | A'--B'--C' topic |
79 | / | |
80 | D---E---F---G master | |
031321c6 | 81 | ------------ |
69a60af5 | 82 | |
ee55703b DN |
83 | *NOTE:* The latter form is just a short-hand of `git checkout topic` |
84 | followed by `git rebase master`. When rebase exits `topic` will | |
85 | remain the checked-out branch. | |
69a60af5 | 86 | |
ff905462 JK |
87 | If the upstream branch already contains a change you have made (e.g., |
88 | because you mailed a patch which was applied upstream), then that commit | |
54e51e55 | 89 | will be skipped and warnings will be issued (if the 'merge' backend is |
767a4ca6 JS |
90 | used). For example, running `git rebase master` on the following |
91 | history (in which `A'` and `A` introduce the same set of changes, but | |
92 | have different committer information): | |
ff905462 JK |
93 | |
94 | ------------ | |
95 | A---B---C topic | |
96 | / | |
97 | D---E---A'---F master | |
98 | ------------ | |
99 | ||
100 | will result in: | |
101 | ||
102 | ------------ | |
103 | B'---C' topic | |
104 | / | |
105 | D---E---A'---F master | |
106 | ------------ | |
107 | ||
e52775f4 JN |
108 | Here is how you would transplant a topic branch based on one |
109 | branch to another, to pretend that you forked the topic branch | |
110 | from the latter branch, using `rebase --onto`. | |
69a60af5 | 111 | |
e52775f4 | 112 | First let's assume your 'topic' is based on branch 'next'. |
e2b850b2 | 113 | For example, a feature developed in 'topic' depends on some |
e52775f4 | 114 | functionality which is found in 'next'. |
69a60af5 | 115 | |
031321c6 | 116 | ------------ |
e52775f4 JN |
117 | o---o---o---o---o master |
118 | \ | |
119 | o---o---o---o---o next | |
120 | \ | |
121 | o---o---o topic | |
122 | ------------ | |
123 | ||
e2b850b2 GD |
124 | We want to make 'topic' forked from branch 'master'; for example, |
125 | because the functionality on which 'topic' depends was merged into the | |
126 | more stable 'master' branch. We want our tree to look like this: | |
e52775f4 JN |
127 | |
128 | ------------ | |
129 | o---o---o---o---o master | |
130 | | \ | |
131 | | o'--o'--o' topic | |
132 | \ | |
133 | o---o---o---o---o next | |
031321c6 | 134 | ------------ |
7fc9d69f | 135 | |
e52775f4 JN |
136 | We can get this using the following command: |
137 | ||
b1889c36 | 138 | git rebase --onto master next topic |
e52775f4 JN |
139 | |
140 | ||
141 | Another example of --onto option is to rebase part of a | |
142 | branch. If we have the following situation: | |
143 | ||
144 | ------------ | |
145 | H---I---J topicB | |
146 | / | |
147 | E---F---G topicA | |
148 | / | |
149 | A---B---C---D master | |
150 | ------------ | |
151 | ||
152 | then the command | |
153 | ||
b1889c36 | 154 | git rebase --onto master topicA topicB |
e52775f4 JN |
155 | |
156 | would result in: | |
157 | ||
158 | ------------ | |
159 | H'--I'--J' topicB | |
160 | / | |
161 | | E---F---G topicA | |
162 | |/ | |
163 | A---B---C---D master | |
164 | ------------ | |
165 | ||
166 | This is useful when topicB does not depend on topicA. | |
167 | ||
ea81fcc5 SP |
168 | A range of commits could also be removed with rebase. If we have |
169 | the following situation: | |
170 | ||
171 | ------------ | |
172 | E---F---G---H---I---J topicA | |
173 | ------------ | |
174 | ||
175 | then the command | |
176 | ||
b1889c36 | 177 | git rebase --onto topicA~5 topicA~3 topicA |
ea81fcc5 SP |
178 | |
179 | would result in the removal of commits F and G: | |
180 | ||
181 | ------------ | |
182 | E---H'---I'---J' topicA | |
183 | ------------ | |
184 | ||
185 | This is useful if F and G were flawed in some way, or should not be | |
54e51e55 | 186 | part of topicA. Note that the argument to `--onto` and the `<upstream>` |
ea81fcc5 SP |
187 | parameter can be any valid commit-ish. |
188 | ||
54e51e55 DS |
189 | In case of conflict, `git rebase` will stop at the first problematic commit |
190 | and leave conflict markers in the tree. You can use `git diff` to locate | |
031321c6 | 191 | the markers (<<<<<<) and make edits to resolve the conflict. For each |
2de9b711 | 192 | file you edit, you need to tell Git that the conflict has been resolved, |
031321c6 SE |
193 | typically this would be done with |
194 | ||
195 | ||
d7f078b8 | 196 | git add <filename> |
031321c6 SE |
197 | |
198 | ||
199 | After resolving the conflict manually and updating the index with the | |
200 | desired resolution, you can continue the rebasing process with | |
201 | ||
202 | ||
203 | git rebase --continue | |
8978d043 | 204 | |
8978d043 | 205 | |
0b444cdb | 206 | Alternatively, you can undo the 'git rebase' with |
8978d043 | 207 | |
031321c6 SE |
208 | |
209 | git rebase --abort | |
8978d043 | 210 | |
92536004 EN |
211 | MODE OPTIONS |
212 | ------------ | |
213 | ||
214 | The options in this section cannot be used with any other option, | |
215 | including not with each other: | |
216 | ||
217 | --continue:: | |
218 | Restart the rebasing process after having resolved a merge conflict. | |
219 | ||
220 | --skip:: | |
221 | Restart the rebasing process by skipping the current patch. | |
222 | ||
223 | --abort:: | |
224 | Abort the rebase operation and reset HEAD to the original | |
225 | branch. If `<branch>` was provided when the rebase operation was | |
226 | started, then `HEAD` will be reset to `<branch>`. Otherwise `HEAD` | |
227 | will be reset to where it was when the rebase operation was | |
228 | started. | |
229 | ||
230 | --quit:: | |
231 | Abort the rebase operation but `HEAD` is not reset back to the | |
232 | original branch. The index and working tree are also left | |
233 | unchanged as a result. If a temporary stash entry was created | |
234 | using `--autostash`, it will be saved to the stash list. | |
235 | ||
236 | --edit-todo:: | |
237 | Edit the todo list during an interactive rebase. | |
238 | ||
239 | --show-current-patch:: | |
240 | Show the current patch in an interactive rebase or when rebase | |
241 | is stopped because of conflicts. This is the equivalent of | |
242 | `git show REBASE_HEAD`. | |
243 | ||
7fc9d69f JH |
244 | OPTIONS |
245 | ------- | |
c2145384 | 246 | --onto <newbase>:: |
69a60af5 | 247 | Starting point at which to create the new commits. If the |
54e51e55 DS |
248 | `--onto` option is not specified, the starting point is |
249 | `<upstream>`. May be any valid commit, and not just an | |
ea81fcc5 | 250 | existing branch name. |
873c3472 | 251 | + |
b9190e79 | 252 | As a special case, you may use "A\...B" as a shortcut for the |
873c3472 MG |
253 | merge base of A and B if there is exactly one merge base. You can |
254 | leave out at most one of A and B, in which case it defaults to HEAD. | |
69a60af5 | 255 | |
414d924b DL |
256 | --keep-base:: |
257 | Set the starting point at which to create the new commits to the | |
54e51e55 DS |
258 | merge base of `<upstream>` and `<branch>`. Running |
259 | `git rebase --keep-base <upstream> <branch>` is equivalent to | |
9e5ebe96 | 260 | running |
aa1df814 | 261 | `git rebase --reapply-cherry-picks --no-fork-point --onto <upstream>...<branch> <upstream> <branch>`. |
414d924b DL |
262 | + |
263 | This option is useful in the case where one is developing a feature on | |
264 | top of an upstream branch. While the feature is being worked on, the | |
265 | upstream branch may advance and it may not be the best idea to keep | |
ce5238a6 PW |
266 | rebasing on top of the upstream but to keep the base commit as-is. As |
267 | the base commit is unchanged this option implies `--reapply-cherry-picks` | |
268 | to avoid losing commits. | |
414d924b | 269 | + |
54e51e55 DS |
270 | Although both this option and `--fork-point` find the merge base between |
271 | `<upstream>` and `<branch>`, this option uses the merge base as the _starting | |
272 | point_ on which new commits will be created, whereas `--fork-point` uses | |
414d924b DL |
273 | the merge base to determine the _set of commits_ which will be rebased. |
274 | + | |
275 | See also INCOMPATIBLE OPTIONS below. | |
276 | ||
52a22d1e | 277 | <upstream>:: |
ea81fcc5 | 278 | Upstream branch to compare against. May be any valid commit, |
15a147e6 MZ |
279 | not just an existing branch name. Defaults to the configured |
280 | upstream for the current branch. | |
7fc9d69f | 281 | |
228382ae | 282 | <branch>:: |
54e51e55 | 283 | Working branch; defaults to `HEAD`. |
7fc9d69f | 284 | |
81de0c01 | 285 | --apply:: |
10cdb9f3 EN |
286 | Use applying strategies to rebase (calling `git-am` |
287 | internally). This option may become a no-op in the future | |
288 | once the merge backend handles everything the apply one does. | |
52eb738d EN |
289 | + |
290 | See also INCOMPATIBLE OPTIONS below. | |
291 | ||
c282eba2 | 292 | --empty=(drop|keep|stop):: |
e98c4269 EN |
293 | How to handle commits that are not empty to start and are not |
294 | clean cherry-picks of any upstream commit, but which become | |
295 | empty after rebasing (because they contain a subset of already | |
64a443ef BL |
296 | upstream changes): |
297 | + | |
298 | -- | |
64a443ef BL |
299 | `drop`;; |
300 | The commit will be dropped. This is the default behavior. | |
301 | `keep`;; | |
302 | The commit will be kept. This option is implied when `--exec` is | |
303 | specified unless `-i`/`--interactive` is also specified. | |
c282eba2 BL |
304 | `stop`;; |
305 | `ask`;; | |
306 | The rebase will halt when the commit is applied, allowing you to | |
307 | choose whether to drop it, edit files more, or just commit the empty | |
308 | changes. This option is implied when `-i`/`--interactive` is | |
309 | specified. `ask` is a deprecated synonym of `stop`. | |
64a443ef | 310 | -- |
e98c4269 | 311 | + |
54e51e55 | 312 | Note that commits which start empty are kept (unless `--no-keep-empty` |
b9cbd295 | 313 | is specified), and commits which are clean cherry-picks (as determined |
0fcb4f6b | 314 | by `git log --cherry-mark ...`) are detected and dropped as a |
ce5238a6 PW |
315 | preliminary step (unless `--reapply-cherry-picks` or `--keep-base` is |
316 | passed). | |
e98c4269 EN |
317 | + |
318 | See also INCOMPATIBLE OPTIONS below. | |
319 | ||
b9cbd295 | 320 | --no-keep-empty:: |
90e1818f | 321 | --keep-empty:: |
b9cbd295 EN |
322 | Do not keep commits that start empty before the rebase |
323 | (i.e. that do not change anything from its parent) in the | |
324 | result. The default is to keep commits which start empty, | |
54e51e55 | 325 | since creating such commits requires passing the `--allow-empty` |
b9cbd295 EN |
326 | override flag to `git commit`, signifying that a user is very |
327 | intentionally creating such a commit and thus wants to keep | |
328 | it. | |
329 | + | |
330 | Usage of this flag will probably be rare, since you can get rid of | |
331 | commits that start empty by just firing up an interactive rebase and | |
332 | removing the lines corresponding to the commits you don't want. This | |
333 | flag exists as a convenient shortcut, such as for cases where external | |
334 | tools generate many empty commits and you want them all removed. | |
335 | + | |
336 | For commits which do not start empty but become empty after rebasing, | |
54e51e55 | 337 | see the `--empty` flag. |
5dacd4ab | 338 | + |
b9cbd295 | 339 | See also INCOMPATIBLE OPTIONS below. |
90e1818f | 340 | |
0fcb4f6b JT |
341 | --reapply-cherry-picks:: |
342 | --no-reapply-cherry-picks:: | |
343 | Reapply all clean cherry-picks of any upstream commit instead | |
344 | of preemptively dropping them. (If these commits then become | |
345 | empty after rebasing, because they contain a subset of already | |
346 | upstream changes, the behavior towards them is controlled by | |
347 | the `--empty` flag.) | |
348 | + | |
ce5238a6 PW |
349 | In the absence of `--keep-base` (or if `--no-reapply-cherry-picks` is |
350 | given), these commits will be automatically dropped. Because this | |
351 | necessitates reading all upstream commits, this can be expensive in | |
352 | repositories with a large number of upstream commits that need to be | |
353 | read. When using the 'merge' backend, warnings will be issued for each | |
354 | dropped commit (unless `--quiet` is given). Advice will also be issued | |
355 | unless `advice.skippedCherryPicks` is set to false (see | |
356 | linkgit:git-config[1]). | |
0fcb4f6b JT |
357 | + |
358 | `--reapply-cherry-picks` allows rebase to forgo reading all upstream | |
359 | commits, potentially improving performance. | |
360 | + | |
361 | See also INCOMPATIBLE OPTIONS below. | |
362 | ||
a6c612b5 | 363 | --allow-empty-message:: |
22a69fda EN |
364 | No-op. Rebasing commits with an empty message used to fail |
365 | and this option would override that behavior, allowing commits | |
366 | with empty messages to be rebased. Now commits with an empty | |
367 | message do not cause rebasing to halt. | |
5dacd4ab EN |
368 | + |
369 | See also INCOMPATIBLE OPTIONS below. | |
a6c612b5 | 370 | |
3240240f SB |
371 | -m:: |
372 | --merge:: | |
6320813b | 373 | Using merging strategies to rebase (default). |
31ddd1ee TR |
374 | + |
375 | Note that a rebase merge works by replaying each commit from the working | |
54e51e55 | 376 | branch on top of the `<upstream>` branch. Because of this, when a merge |
31ddd1ee | 377 | conflict happens, the side reported as 'ours' is the so-far rebased |
54e51e55 DS |
378 | series, starting with `<upstream>`, and 'theirs' is the working branch. |
379 | In other words, the sides are swapped. | |
5dacd4ab EN |
380 | + |
381 | See also INCOMPATIBLE OPTIONS below. | |
58634dbf | 382 | |
3240240f SB |
383 | -s <strategy>:: |
384 | --strategy=<strategy>:: | |
f5a3c5e6 EN |
385 | Use the given merge strategy, instead of the default `ort`. |
386 | This implies `--merge`. | |
31ddd1ee | 387 | + |
54e51e55 DS |
388 | Because `git rebase` replays each commit from the working branch |
389 | on top of the `<upstream>` branch using the given strategy, using | |
390 | the `ours` strategy simply empties all patches from the `<branch>`, | |
31ddd1ee | 391 | which makes little sense. |
5dacd4ab EN |
392 | + |
393 | See also INCOMPATIBLE OPTIONS below. | |
58634dbf | 394 | |
93ce190c ML |
395 | -X <strategy-option>:: |
396 | --strategy-option=<strategy-option>:: | |
397 | Pass the <strategy-option> through to the merge strategy. | |
6cf378f0 | 398 | This implies `--merge` and, if no strategy has been |
f5a3c5e6 | 399 | specified, `-s ort`. Note the reversal of 'ours' and |
edfbbf7e | 400 | 'theirs' as noted above for the `-m` option. |
5dacd4ab EN |
401 | + |
402 | See also INCOMPATIBLE OPTIONS below. | |
93ce190c | 403 | |
0dbc715a | 404 | include::rerere-options.txt[] |
aba4954c | 405 | |
3ee5e540 NV |
406 | -S[<keyid>]:: |
407 | --gpg-sign[=<keyid>]:: | |
c241371c | 408 | --no-gpg-sign:: |
2b594bf9 MM |
409 | GPG-sign commits. The `keyid` argument is optional and |
410 | defaults to the committer identity; if specified, it must be | |
c241371c ĐTCD |
411 | stuck to the option without a space. `--no-gpg-sign` is useful to |
412 | countermand both `commit.gpgSign` configuration variable, and | |
413 | earlier `--gpg-sign`. | |
3ee5e540 | 414 | |
0e987a12 SB |
415 | -q:: |
416 | --quiet:: | |
54e51e55 | 417 | Be quiet. Implies `--no-stat`. |
0e987a12 | 418 | |
3240240f SB |
419 | -v:: |
420 | --verbose:: | |
54e51e55 | 421 | Be verbose. Implies `--stat`. |
a9c3821c TAV |
422 | |
423 | --stat:: | |
424 | Show a diffstat of what changed upstream since the last rebase. The | |
425 | diffstat is also controlled by the configuration option rebase.stat. | |
426 | ||
427 | -n:: | |
428 | --no-stat:: | |
429 | Do not show a diffstat as part of the rebase process. | |
b758789c | 430 | |
fd631d58 NS |
431 | --no-verify:: |
432 | This option bypasses the pre-rebase hook. See also linkgit:githooks[5]. | |
433 | ||
7baf9c4b MZ |
434 | --verify:: |
435 | Allows the pre-rebase hook to run, which is the default. This option can | |
54e51e55 | 436 | be used to override `--no-verify`. See also linkgit:githooks[5]. |
7baf9c4b | 437 | |
67dad687 | 438 | -C<n>:: |
54e51e55 | 439 | Ensure at least `<n>` lines of surrounding context match before |
67dad687 MT |
440 | and after each change. When fewer lines of surrounding |
441 | context exist they all must match. By default no context is | |
54e51e55 | 442 | ever ignored. Implies `--apply`. |
5dacd4ab EN |
443 | + |
444 | See also INCOMPATIBLE OPTIONS below. | |
67dad687 | 445 | |
983f464f | 446 | --no-ff:: |
5e75d56f | 447 | --force-rebase:: |
983f464f EN |
448 | -f:: |
449 | Individually replay all rebased commits instead of fast-forwarding | |
450 | over the unchanged ones. This ensures that the entire history of | |
451 | the rebased branch is composed of new commits. | |
b4995494 | 452 | + |
983f464f EN |
453 | You may find this helpful after reverting a topic branch merge, as this option |
454 | recreates the topic branch with fresh commits so it can be remerged | |
455 | successfully without needing to "revert the reversion" (see the | |
456 | link:howto/revert-a-faulty-merge.html[revert-a-faulty-merge How-To] for | |
457 | details). | |
5e75d56f | 458 | |
ad8261d2 JK |
459 | --fork-point:: |
460 | --no-fork-point:: | |
54e51e55 DS |
461 | Use reflog to find a better common ancestor between `<upstream>` |
462 | and `<branch>` when calculating which commits have been | |
463 | introduced by `<branch>`. | |
ad8261d2 | 464 | + |
54e51e55 DS |
465 | When `--fork-point` is active, 'fork_point' will be used instead of |
466 | `<upstream>` to calculate the set of commits to rebase, where | |
f51a48ec SO |
467 | 'fork_point' is the result of `git merge-base --fork-point <upstream> |
468 | <branch>` command (see linkgit:git-merge-base[1]). If 'fork_point' | |
54e51e55 | 469 | ends up being empty, the `<upstream>` will be used as a fallback. |
f51a48ec | 470 | + |
aa1df814 PW |
471 | If `<upstream>` or `--keep-base` is given on the command line, then |
472 | the default is `--no-fork-point`, otherwise the default is | |
473 | `--fork-point`. See also `rebase.forkpoint` in linkgit:git-config[1]. | |
414d924b | 474 | + |
54e51e55 | 475 | If your branch was based on `<upstream>` but `<upstream>` was rewound and |
414d924b DL |
476 | your branch contains commits which were dropped, this option can be used |
477 | with `--keep-base` in order to drop those commits from your branch. | |
a35413c3 EN |
478 | + |
479 | See also INCOMPATIBLE OPTIONS below. | |
ad8261d2 | 480 | |
86c91f91 | 481 | --ignore-whitespace:: |
ef484add | 482 | Ignore whitespace differences when trying to reconcile |
54e51e55 DS |
483 | differences. Currently, each backend implements an approximation of |
484 | this behavior: | |
ef484add | 485 | + |
54e51e55 DS |
486 | apply backend;; |
487 | When applying a patch, ignore changes in whitespace in context | |
488 | lines. Unfortunately, this means that if the "old" lines being | |
489 | replaced by the patch differ only in whitespace from the existing | |
490 | file, you will get a merge conflict instead of a successful patch | |
491 | application. | |
ef484add | 492 | + |
54e51e55 DS |
493 | merge backend;; |
494 | Treat lines with only whitespace changes as unchanged when merging. | |
495 | Unfortunately, this means that any patch hunks that were intended | |
496 | to modify whitespace and nothing else will be dropped, even if the | |
497 | other side had no changes that conflicted. | |
ef484add | 498 | |
749485f6 | 499 | --whitespace=<option>:: |
54e51e55 | 500 | This flag is passed to the `git apply` program |
5162e697 | 501 | (see linkgit:git-apply[1]) that applies the patch. |
54e51e55 | 502 | Implies `--apply`. |
5dacd4ab EN |
503 | + |
504 | See also INCOMPATIBLE OPTIONS below. | |
059f446d | 505 | |
570ccad3 | 506 | --committer-date-is-author-date:: |
7573cec5 PW |
507 | Instead of using the current time as the committer date, use |
508 | the author date of the commit being rebased as the committer | |
509 | date. This option implies `--force-rebase`. | |
510 | ||
570ccad3 | 511 | --ignore-date:: |
27126692 | 512 | --reset-author-date:: |
a3894aad PW |
513 | Instead of using the author date of the original commit, use |
514 | the current time as the author date of the rebased commit. This | |
515 | option implies `--force-rebase`. | |
5dacd4ab EN |
516 | + |
517 | See also INCOMPATIBLE OPTIONS below. | |
570ccad3 | 518 | |
9f79524a | 519 | --signoff:: |
3abd4a67 | 520 | Add a `Signed-off-by` trailer to all the rebased commits. Note |
a852ec7f | 521 | that if `--interactive` is given then only commits marked to be |
5dacd4ab EN |
522 | picked, edited or reworded will have the trailer added. |
523 | + | |
524 | See also INCOMPATIBLE OPTIONS below. | |
9f79524a | 525 | |
3240240f SB |
526 | -i:: |
527 | --interactive:: | |
1b1dce4b | 528 | Make a list of the commits which are about to be rebased. Let the |
f0fd889d JS |
529 | user edit that list before rebasing. This mode can also be used to |
530 | split commits (see SPLITTING COMMITS below). | |
16cf51c7 MR |
531 | + |
532 | The commit list format can be changed by setting the configuration option | |
533 | rebase.instructionFormat. A customized instruction format will automatically | |
9cd30af9 | 534 | have the commit hash prepended to the format. |
5dacd4ab EN |
535 | + |
536 | See also INCOMPATIBLE OPTIONS below. | |
1b1dce4b | 537 | |
8f6aed71 | 538 | -r:: |
7543f6f4 | 539 | --rebase-merges[=(rebase-cousins|no-rebase-cousins)]:: |
7e5dcec3 | 540 | --no-rebase-merges:: |
8f6aed71 JS |
541 | By default, a rebase will simply drop merge commits from the todo |
542 | list, and put the rebased commits into a single, linear branch. | |
543 | With `--rebase-merges`, the rebase will instead try to preserve | |
544 | the branching structure within the commits that are to be rebased, | |
545 | by recreating the merge commits. Any resolved merge conflicts or | |
546 | manual amendments in these merge commits will have to be | |
7e5dcec3 | 547 | resolved/re-applied manually. `--no-rebase-merges` can be used to |
6605fb70 AH |
548 | countermand both the `rebase.rebaseMerges` config option and a previous |
549 | `--rebase-merges`. | |
7e5dcec3 AH |
550 | + |
551 | When rebasing merges, there are two modes: `rebase-cousins` and | |
552 | `no-rebase-cousins`. If the mode is not specified, it defaults to | |
553 | `no-rebase-cousins`. In `no-rebase-cousins` mode, commits which do not have | |
554 | `<upstream>` as direct ancestor will keep their original branch point, i.e. | |
555 | commits that would be excluded by linkgit:git-log[1]'s `--ancestry-path` | |
556 | option will keep their original ancestry by default. In `rebase-cousins` mode, | |
557 | such commits are instead rebased onto `<upstream>` (or `<onto>`, if | |
558 | specified). | |
7543f6f4 | 559 | + |
8f6aed71 | 560 | It is currently only possible to recreate the merge commits using the |
f5a3c5e6 | 561 | `ort` merge strategy; different merge strategies can be used only via |
8f6aed71 | 562 | explicit `exec git merge -s <strategy> [...]` commands. |
25cff9f1 | 563 | + |
5dacd4ab | 564 | See also REBASING MERGES and INCOMPATIBLE OPTIONS below. |
8f6aed71 | 565 | |
c2145384 LK |
566 | -x <cmd>:: |
567 | --exec <cmd>:: | |
568 | Append "exec <cmd>" after each line creating a commit in the | |
54e51e55 | 569 | final history. `<cmd>` will be interpreted as one or more shell |
b8c0b210 JS |
570 | commands. Any command that fails will interrupt the rebase, |
571 | with exit code 1. | |
c2145384 | 572 | + |
c2145384 LK |
573 | You may execute several commands by either using one instance of `--exec` |
574 | with several commands: | |
575 | + | |
576 | git rebase -i --exec "cmd1 && cmd2 && ..." | |
577 | + | |
578 | or by giving more than one `--exec`: | |
579 | + | |
580 | git rebase -i --exec "cmd1" --exec "cmd2" --exec ... | |
581 | + | |
54e51e55 | 582 | If `--autosquash` is used, `exec` lines will not be appended for |
c2145384 LK |
583 | the intermediate commits, and will only appear at the end of each |
584 | squash/fixup series. | |
78ec2400 SB |
585 | + |
586 | This uses the `--interactive` machinery internally, but it can be run | |
587 | without an explicit `--interactive`. | |
5dacd4ab EN |
588 | + |
589 | See also INCOMPATIBLE OPTIONS below. | |
f09c9b8c | 590 | |
be496621 | 591 | --root:: |
54e51e55 DS |
592 | Rebase all commits reachable from `<branch>`, instead of |
593 | limiting them with an `<upstream>`. This allows you to rebase | |
b8ad3656 | 594 | the root commit(s) on a branch. |
5dacd4ab EN |
595 | + |
596 | See also INCOMPATIBLE OPTIONS below. | |
be496621 | 597 | |
f59baa50 | 598 | --autosquash:: |
dd1e5b31 | 599 | --no-autosquash:: |
cb00f524 AK |
600 | Automatically squash commits with specially formatted messages into |
601 | previous commits being rebased. If a commit message starts with | |
602 | "squash! ", "fixup! " or "amend! ", the remainder of the subject line | |
603 | is taken as a commit specifier, which matches a previous commit if it | |
604 | matches the subject line or the hash of that commit. If no commit | |
605 | matches fully, matches of the specifier with the start of commit | |
606 | subjects are considered. | |
607 | + | |
608 | In the rebase todo list, the actions of squash, fixup and amend commits are | |
609 | changed from `pick` to `squash`, `fixup` or `fixup -C`, respectively, and they | |
610 | are moved right after the commit they modify. The `--interactive` option can | |
611 | be used to review and edit the todo list before proceeding. | |
612 | + | |
613 | The recommended way to create commits with squash markers is by using the | |
614 | `--squash`, `--fixup`, `--fixup=amend:` or `--fixup=reword:` options of | |
615 | linkgit:git-commit[1], which take the target commit as an argument and | |
616 | automatically fill in the subject line of the new commit from that. | |
617 | + | |
40b80764 | 618 | Setting configuration variable `rebase.autoSquash` to true enables |
cb00f524 AK |
619 | auto-squashing by default for interactive rebase. The `--no-autosquash` |
620 | option can be used to override that setting. | |
5dacd4ab EN |
621 | + |
622 | See also INCOMPATIBLE OPTIONS below. | |
b4995494 | 623 | |
82e0668c JK |
624 | --autostash:: |
625 | --no-autostash:: | |
e01db917 | 626 | Automatically create a temporary stash entry before the operation |
58794775 RR |
627 | begins, and apply it after the operation ends. This means |
628 | that you can run rebase on a dirty worktree. However, use | |
629 | with care: the final stash application after a successful | |
630 | rebase might result in non-trivial conflicts. | |
631 | ||
d421afa0 JS |
632 | --reschedule-failed-exec:: |
633 | --no-reschedule-failed-exec:: | |
634 | Automatically reschedule `exec` commands that failed. This only makes | |
635 | sense in interactive mode (or when an `--exec` option was provided). | |
e5b32bff | 636 | + |
25aec063 IB |
637 | This option applies once a rebase is started. It is preserved for the whole |
638 | rebase based on, in order, the command line option provided to the initial `git | |
639 | rebase`, the `rebase.rescheduleFailedExec` configuration (see | |
640 | linkgit:git-config[1] or "CONFIGURATION" below), or it defaults to false. | |
641 | + | |
642 | Recording this option for the whole rebase is a convenience feature. Otherwise | |
643 | an explicit `--no-reschedule-failed-exec` at the start would be overridden by | |
644 | the presence of a `rebase.rescheduleFailedExec=true` configuration when `git | |
645 | rebase --continue` is invoked. Currently, you cannot pass | |
646 | `--[no-]reschedule-failed-exec` to `git rebase --continue`. | |
d421afa0 | 647 | |
900b50c2 DS |
648 | --update-refs:: |
649 | --no-update-refs:: | |
650 | Automatically force-update any branches that point to commits that | |
651 | are being rebased. Any branches that are checked out in a worktree | |
652 | are not updated in this way. | |
3113feda DS |
653 | + |
654 | If the configuration variable `rebase.updateRefs` is set, then this option | |
655 | can be used to override and disable this setting. | |
1207599e EN |
656 | + |
657 | See also INCOMPATIBLE OPTIONS below. | |
900b50c2 | 658 | |
5dacd4ab EN |
659 | INCOMPATIBLE OPTIONS |
660 | -------------------- | |
661 | ||
68aa495b | 662 | The following options: |
5dacd4ab | 663 | |
10cdb9f3 | 664 | * --apply |
be50c938 | 665 | * --whitespace |
5dacd4ab EN |
666 | * -C |
667 | ||
68aa495b | 668 | are incompatible with the following options: |
5dacd4ab EN |
669 | |
670 | * --merge | |
671 | * --strategy | |
672 | * --strategy-option | |
eddfcd8e | 673 | * --autosquash |
5dacd4ab | 674 | * --rebase-merges |
5dacd4ab EN |
675 | * --interactive |
676 | * --exec | |
b9cbd295 | 677 | * --no-keep-empty |
e98c4269 | 678 | * --empty= |
ffeaca17 | 679 | * --[no-]reapply-cherry-picks when used without --keep-base |
900b50c2 | 680 | * --update-refs |
b8ad3656 | 681 | * --root when used without --onto |
5dacd4ab | 682 | |
68aa495b | 683 | In addition, the following pairs of options are incompatible: |
5dacd4ab | 684 | |
414d924b DL |
685 | * --keep-base and --onto |
686 | * --keep-base and --root | |
a35413c3 | 687 | * --fork-point and --root |
5dacd4ab | 688 | |
0661e49a EN |
689 | BEHAVIORAL DIFFERENCES |
690 | ----------------------- | |
691 | ||
54e51e55 | 692 | `git rebase` has two primary backends: 'apply' and 'merge'. (The 'apply' |
344420bf | 693 | backend used to be known as the 'am' backend, but the name led to |
54e51e55 | 694 | confusion as it looks like a verb instead of a noun. Also, the 'merge' |
10cdb9f3 EN |
695 | backend used to be known as the interactive backend, but it is now |
696 | used for non-interactive cases as well. Both were renamed based on | |
697 | lower-level functionality that underpinned each.) There are some | |
698 | subtle differences in how these two backends behave: | |
0661e49a | 699 | |
6fcbad87 JS |
700 | Empty commits |
701 | ~~~~~~~~~~~~~ | |
0661e49a | 702 | |
54e51e55 | 703 | The 'apply' backend unfortunately drops intentionally empty commits, i.e. |
d48e5e21 EN |
704 | commits that started empty, though these are rare in practice. It |
705 | also drops commits that become empty and has no option for controlling | |
706 | this behavior. | |
0661e49a | 707 | |
54e51e55 DS |
708 | The 'merge' backend keeps intentionally empty commits by default (though |
709 | with `-i` they are marked as empty in the todo list editor, or they can | |
710 | be dropped automatically with `--no-keep-empty`). | |
b9cbd295 EN |
711 | |
712 | Similar to the apply backend, by default the merge backend drops | |
54e51e55 | 713 | commits that become empty unless `-i`/`--interactive` is specified (in |
b9cbd295 | 714 | which case it stops and asks the user what to do). The merge backend |
c282eba2 | 715 | also has an `--empty=(drop|keep|stop)` option for changing the behavior |
b9cbd295 | 716 | of handling commits that become empty. |
0661e49a | 717 | |
6fcbad87 JS |
718 | Directory rename detection |
719 | ~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
720 | ||
be50c938 EN |
721 | Due to the lack of accurate tree information (arising from |
722 | constructing fake ancestors with the limited information available in | |
54e51e55 | 723 | patches), directory rename detection is disabled in the 'apply' backend. |
be50c938 EN |
724 | Disabled directory rename detection means that if one side of history |
725 | renames a directory and the other adds new files to the old directory, | |
726 | then the new files will be left behind in the old directory without | |
727 | any warning at the time of rebasing that you may want to move these | |
728 | files into the new directory. | |
729 | ||
54e51e55 | 730 | Directory rename detection works with the 'merge' backend to provide you |
10cdb9f3 | 731 | warnings in such cases. |
be50c938 EN |
732 | |
733 | Context | |
734 | ~~~~~~~ | |
735 | ||
54e51e55 | 736 | The 'apply' backend works by creating a sequence of patches (by calling |
be50c938 EN |
737 | `format-patch` internally), and then applying the patches in sequence |
738 | (calling `am` internally). Patches are composed of multiple hunks, | |
739 | each with line numbers, a context region, and the actual changes. The | |
740 | line numbers have to be taken with some fuzz, since the other side | |
741 | will likely have inserted or deleted lines earlier in the file. The | |
742 | context region is meant to help find how to adjust the line numbers in | |
743 | order to apply the changes to the right lines. However, if multiple | |
744 | areas of the code have the same surrounding lines of context, the | |
745 | wrong one can be picked. There are real-world cases where this has | |
746 | caused commits to be reapplied incorrectly with no conflicts reported. | |
54e51e55 | 747 | Setting `diff.context` to a larger value may prevent such types of |
be50c938 EN |
748 | problems, but increases the chance of spurious conflicts (since it |
749 | will require more lines of matching context to apply). | |
750 | ||
54e51e55 | 751 | The 'merge' backend works with a full copy of each relevant file, |
be50c938 EN |
752 | insulating it from these types of problems. |
753 | ||
754 | Labelling of conflicts markers | |
755 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
756 | ||
757 | When there are content conflicts, the merge machinery tries to | |
758 | annotate each side's conflict markers with the commits where the | |
54e51e55 | 759 | content came from. Since the 'apply' backend drops the original |
be50c938 EN |
760 | information about the rebased commits and their parents (and instead |
761 | generates new fake commits based off limited information in the | |
762 | generated patches), those commits cannot be identified; instead it has | |
54e51e55 DS |
763 | to fall back to a commit summary. Also, when `merge.conflictStyle` is |
764 | set to `diff3` or `zdiff3`, the 'apply' backend will use "constructed merge | |
ddfc44a8 EN |
765 | base" to label the content from the merge base, and thus provide no |
766 | information about the merge base commit whatsoever. | |
be50c938 | 767 | |
54e51e55 | 768 | The 'merge' backend works with the full commits on both sides of history |
10cdb9f3 | 769 | and thus has no such limitations. |
be50c938 EN |
770 | |
771 | Hooks | |
772 | ~~~~~ | |
773 | ||
54e51e55 DS |
774 | The 'apply' backend has not traditionally called the post-commit hook, |
775 | while the 'merge' backend has. Both have called the post-checkout hook, | |
776 | though the 'merge' backend has squelched its output. Further, both | |
f7139e7c EN |
777 | backends only call the post-checkout hook with the starting point |
778 | commit of the rebase, not the intermediate commits nor the final | |
779 | commit. In each case, the calling of these hooks was by accident of | |
780 | implementation rather than by design (both backends were originally | |
781 | implemented as shell scripts and happened to invoke other commands | |
54e51e55 | 782 | like `git checkout` or `git commit` that would call the hooks). Both |
f7139e7c EN |
783 | backends should have the same behavior, though it is not entirely |
784 | clear which, if any, is correct. We will likely make rebase stop | |
785 | calling either of these hooks in the future. | |
be50c938 | 786 | |
2ac0d627 EN |
787 | Interruptability |
788 | ~~~~~~~~~~~~~~~~ | |
789 | ||
54e51e55 | 790 | The 'apply' backend has safety problems with an ill-timed interrupt; if |
10cdb9f3 EN |
791 | the user presses Ctrl-C at the wrong time to try to abort the rebase, |
792 | the rebase can enter a state where it cannot be aborted with a | |
54e51e55 | 793 | subsequent `git rebase --abort`. The 'merge' backend does not appear to |
2ac0d627 EN |
794 | suffer from the same shortcoming. (See |
795 | https://lore.kernel.org/git/20200207132152.GC2868@szeder.dev/ for | |
796 | details.) | |
797 | ||
120b1eb7 EN |
798 | Commit Rewording |
799 | ~~~~~~~~~~~~~~~~ | |
800 | ||
801 | When a conflict occurs while rebasing, rebase stops and asks the user | |
802 | to resolve. Since the user may need to make notable changes while | |
803 | resolving conflicts, after conflicts are resolved and the user has run | |
804 | `git rebase --continue`, the rebase should open an editor and ask the | |
54e51e55 DS |
805 | user to update the commit message. The 'merge' backend does this, while |
806 | the 'apply' backend blindly applies the original commit message. | |
120b1eb7 | 807 | |
be50c938 EN |
808 | Miscellaneous differences |
809 | ~~~~~~~~~~~~~~~~~~~~~~~~~ | |
810 | ||
811 | There are a few more behavioral differences that most folks would | |
812 | probably consider inconsequential but which are mentioned for | |
813 | completeness: | |
814 | ||
815 | * Reflog: The two backends will use different wording when describing | |
816 | the changes made in the reflog, though both will make use of the | |
817 | word "rebase". | |
818 | ||
819 | * Progress, informational, and error messages: The two backends | |
820 | provide slightly different progress and informational messages. | |
10cdb9f3 EN |
821 | Also, the apply backend writes error messages (such as "Your files |
822 | would be overwritten...") to stdout, while the merge backend writes | |
823 | them to stderr. | |
be50c938 EN |
824 | |
825 | * State directories: The two backends keep their state in different | |
54e51e55 | 826 | directories under `.git/` |
f59baa50 | 827 | |
58634dbf EW |
828 | include::merge-strategies.txt[] |
829 | ||
031321c6 SE |
830 | NOTES |
831 | ----- | |
90d1c08e | 832 | |
54e51e55 | 833 | You should understand the implications of using `git rebase` on a |
90d1c08e TR |
834 | repository that you share. See also RECOVERING FROM UPSTREAM REBASE |
835 | below. | |
031321c6 | 836 | |
54e51e55 DS |
837 | When the rebase is run, it will first execute a `pre-rebase` hook if one |
838 | exists. You can use this hook to do sanity checks and reject the rebase | |
839 | if it isn't appropriate. Please see the template `pre-rebase` hook script | |
840 | for an example. | |
031321c6 | 841 | |
54e51e55 | 842 | Upon completion, `<branch>` will be the current branch. |
031321c6 | 843 | |
1b1dce4b JS |
844 | INTERACTIVE MODE |
845 | ---------------- | |
846 | ||
847 | Rebasing interactively means that you have a chance to edit the commits | |
848 | which are rebased. You can reorder the commits, and you can | |
849 | remove them (weeding out bad or otherwise unwanted patches). | |
850 | ||
851 | The interactive mode is meant for this type of workflow: | |
852 | ||
853 | 1. have a wonderful idea | |
854 | 2. hack on the code | |
855 | 3. prepare a series for submission | |
856 | 4. submit | |
857 | ||
858 | where point 2. consists of several instances of | |
859 | ||
d3f2475c NBL |
860 | a) regular use |
861 | ||
1b1dce4b JS |
862 | 1. finish something worthy of a commit |
863 | 2. commit | |
d3f2475c NBL |
864 | |
865 | b) independent fixup | |
866 | ||
1b1dce4b JS |
867 | 1. realize that something does not work |
868 | 2. fix that | |
869 | 3. commit it | |
870 | ||
871 | Sometimes the thing fixed in b.2. cannot be amended to the not-quite | |
872 | perfect commit it fixes, because that commit is buried deeply in a | |
873 | patch series. That is exactly what interactive rebase is for: use it | |
874 | after plenty of "a"s and "b"s, by rearranging and editing | |
875 | commits, and squashing multiple commits into one. | |
876 | ||
877 | Start it with the last commit you want to retain as-is: | |
878 | ||
879 | git rebase -i <after-this-commit> | |
880 | ||
881 | An editor will be fired up with all the commits in your current branch | |
882 | (ignoring merge commits), which come after the given commit. You can | |
883 | reorder the commits in this list to your heart's content, and you can | |
884 | remove them. The list looks more or less like this: | |
885 | ||
886 | ------------------------------------------- | |
887 | pick deadbee The oneline of this commit | |
888 | pick fa1afe1 The oneline of the next commit | |
889 | ... | |
890 | ------------------------------------------- | |
891 | ||
0b444cdb | 892 | The oneline descriptions are purely for your pleasure; 'git rebase' will |
1b1dce4b JS |
893 | not look at them but at the commit names ("deadbee" and "fa1afe1" in this |
894 | example), so do not delete or edit the names. | |
895 | ||
896 | By replacing the command "pick" with the command "edit", you can tell | |
54e51e55 | 897 | `git rebase` to stop after applying that commit, so that you can edit |
1b1dce4b JS |
898 | the files and/or the commit message, amend the commit, and continue |
899 | rebasing. | |
900 | ||
71f82465 JS |
901 | To interrupt the rebase (just like an "edit" command would do, but without |
902 | cherry-picking any commit first), use the "break" command. | |
903 | ||
6741aa6c BG |
904 | If you just want to edit the commit message for a commit, replace the |
905 | command "pick" with the command "reword". | |
906 | ||
c9266d58 GR |
907 | To drop a commit, replace the command "pick" with "drop", or just |
908 | delete the matching line. | |
909 | ||
1b1dce4b | 910 | If you want to fold two or more commits into one, replace the command |
0205e72f MH |
911 | "pick" for the second and subsequent commits with "squash" or "fixup". |
912 | If the commits had different authors, the folded commit will be | |
913 | attributed to the author of the first commit. The suggested commit | |
2c0aa2ce CM |
914 | message for the folded commit is the concatenation of the first |
915 | commit's message with those identified by "squash" commands, omitting the | |
916 | messages of commits identified by "fixup" commands, unless "fixup -c" | |
917 | is used. In that case the suggested commit message is only the message | |
918 | of the "fixup -c" commit, and an editor is opened allowing you to edit | |
919 | the message. The contents (patch) of the "fixup -c" commit are still | |
920 | incorporated into the folded commit. If there is more than one "fixup -c" | |
fa153c1c | 921 | commit, the message from the final one is used. You can also use |
2c0aa2ce CM |
922 | "fixup -C" to get the same behavior as "fixup -c" except without opening |
923 | an editor. | |
924 | ||
54e51e55 | 925 | `git rebase` will stop when "pick" has been replaced with "edit" or |
6741aa6c BG |
926 | when a command fails due to merge errors. When you are done editing |
927 | and/or resolving conflicts you can continue with `git rebase --continue`. | |
1b1dce4b JS |
928 | |
929 | For example, if you want to reorder the last 5 commits, such that what | |
54e51e55 DS |
930 | was `HEAD~4` becomes the new `HEAD`. To achieve that, you would call |
931 | `git rebase` like this: | |
1b1dce4b JS |
932 | |
933 | ---------------------- | |
934 | $ git rebase -i HEAD~5 | |
935 | ---------------------- | |
936 | ||
937 | And move the first patch to the end of the list. | |
938 | ||
7948b49a JS |
939 | You might want to recreate merge commits, e.g. if you have a history |
940 | like this: | |
f09c9b8c JS |
941 | |
942 | ------------------ | |
943 | X | |
944 | \ | |
945 | A---M---B | |
946 | / | |
947 | ---o---O---P---Q | |
948 | ------------------ | |
949 | ||
950 | Suppose you want to rebase the side branch starting at "A" to "Q". Make | |
54e51e55 | 951 | sure that the current `HEAD` is "B", and call |
f09c9b8c JS |
952 | |
953 | ----------------------------- | |
7948b49a | 954 | $ git rebase -i -r --onto Q O |
f09c9b8c JS |
955 | ----------------------------- |
956 | ||
cd035b1c MM |
957 | Reordering and editing commits usually creates untested intermediate |
958 | steps. You may want to check that your history editing did not break | |
959 | anything by running a test, or at least recompiling at intermediate | |
960 | points in history by using the "exec" command (shortcut "x"). You may | |
961 | do so by creating a todo list like this one: | |
962 | ||
963 | ------------------------------------------- | |
964 | pick deadbee Implement feature XXX | |
965 | fixup f1a5c00 Fix to feature XXX | |
966 | exec make | |
967 | pick c0ffeee The oneline of the next commit | |
968 | edit deadbab The oneline of the commit after | |
969 | exec cd subdir; make test | |
970 | ... | |
971 | ------------------------------------------- | |
972 | ||
973 | The interactive rebase will stop when a command fails (i.e. exits with | |
974 | non-0 status) to give you an opportunity to fix the problem. You can | |
975 | continue with `git rebase --continue`. | |
976 | ||
f10031fa NB |
977 | The "exec" command launches the command in a shell (the default one, usually |
978 | /bin/sh), so you can use shell features (like "cd", ">", ";" ...). The command | |
979 | is run from the root of the working tree. | |
f0fd889d | 980 | |
c2145384 LK |
981 | ---------------------------------- |
982 | $ git rebase -i --exec "make test" | |
983 | ---------------------------------- | |
984 | ||
985 | This command lets you check that intermediate commits are compilable. | |
986 | The todo list becomes like that: | |
987 | ||
988 | -------------------- | |
989 | pick 5928aea one | |
990 | exec make test | |
991 | pick 04d0fda two | |
992 | exec make test | |
993 | pick ba46169 three | |
994 | exec make test | |
995 | pick f4593f9 four | |
996 | exec make test | |
997 | -------------------- | |
998 | ||
f0fd889d JS |
999 | SPLITTING COMMITS |
1000 | ----------------- | |
1001 | ||
1002 | In interactive mode, you can mark commits with the action "edit". However, | |
54e51e55 | 1003 | this does not necessarily mean that `git rebase` expects the result of this |
f0fd889d JS |
1004 | edit to be exactly one commit. Indeed, you can undo the commit, or you can |
1005 | add other commits. This can be used to split a commit into two: | |
1006 | ||
483bc4f0 | 1007 | - Start an interactive rebase with `git rebase -i <commit>^`, where |
54e51e55 | 1008 | `<commit>` is the commit you want to split. In fact, any commit range |
f0fd889d JS |
1009 | will do, as long as it contains that commit. |
1010 | ||
1011 | - Mark the commit you want to split with the action "edit". | |
1012 | ||
483bc4f0 | 1013 | - When it comes to editing that commit, execute `git reset HEAD^`. The |
54e51e55 | 1014 | effect is that the `HEAD` is rewound by one, and the index follows suit. |
f0fd889d JS |
1015 | However, the working tree stays the same. |
1016 | ||
1017 | - Now add the changes to the index that you want to have in the first | |
483bc4f0 | 1018 | commit. You can use `git add` (possibly interactively) or |
54e51e55 | 1019 | `git gui` (or both) to do that. |
f0fd889d JS |
1020 | |
1021 | - Commit the now-current index with whatever commit message is appropriate | |
1022 | now. | |
1023 | ||
1024 | - Repeat the last two steps until your working tree is clean. | |
1025 | ||
483bc4f0 | 1026 | - Continue the rebase with `git rebase --continue`. |
f0fd889d JS |
1027 | |
1028 | If you are not absolutely sure that the intermediate revisions are | |
1029 | consistent (they compile, pass the testsuite, etc.) you should use | |
54e51e55 | 1030 | `git stash` to stash away the not-yet-committed changes |
f0fd889d JS |
1031 | after each commit, test, and amend the commit if fixes are necessary. |
1032 | ||
1033 | ||
90d1c08e TR |
1034 | RECOVERING FROM UPSTREAM REBASE |
1035 | ------------------------------- | |
1036 | ||
1037 | Rebasing (or any other form of rewriting) a branch that others have | |
1038 | based work on is a bad idea: anyone downstream of it is forced to | |
1039 | manually fix their history. This section explains how to do the fix | |
1040 | from the downstream's point of view. The real fix, however, would be | |
1041 | to avoid rebasing the upstream in the first place. | |
1042 | ||
1043 | To illustrate, suppose you are in a situation where someone develops a | |
1044 | 'subsystem' branch, and you are working on a 'topic' that is dependent | |
1045 | on this 'subsystem'. You might end up with a history like the | |
1046 | following: | |
1047 | ||
1048 | ------------ | |
01826066 | 1049 | o---o---o---o---o---o---o---o master |
90d1c08e TR |
1050 | \ |
1051 | o---o---o---o---o subsystem | |
1052 | \ | |
1053 | *---*---* topic | |
1054 | ------------ | |
1055 | ||
1056 | If 'subsystem' is rebased against 'master', the following happens: | |
1057 | ||
1058 | ------------ | |
1059 | o---o---o---o---o---o---o---o master | |
1060 | \ \ | |
1061 | o---o---o---o---o o'--o'--o'--o'--o' subsystem | |
1062 | \ | |
1063 | *---*---* topic | |
1064 | ------------ | |
1065 | ||
1066 | If you now continue development as usual, and eventually merge 'topic' | |
1067 | to 'subsystem', the commits from 'subsystem' will remain duplicated forever: | |
1068 | ||
1069 | ------------ | |
1070 | o---o---o---o---o---o---o---o master | |
1071 | \ \ | |
1072 | o---o---o---o---o o'--o'--o'--o'--o'--M subsystem | |
1073 | \ / | |
1074 | *---*---*-..........-*--* topic | |
1075 | ------------ | |
1076 | ||
1077 | Such duplicates are generally frowned upon because they clutter up | |
1078 | history, making it harder to follow. To clean things up, you need to | |
1079 | transplant the commits on 'topic' to the new 'subsystem' tip, i.e., | |
1080 | rebase 'topic'. This becomes a ripple effect: anyone downstream from | |
1081 | 'topic' is forced to rebase too, and so on! | |
1082 | ||
1083 | There are two kinds of fixes, discussed in the following subsections: | |
1084 | ||
1085 | Easy case: The changes are literally the same.:: | |
1086 | ||
1087 | This happens if the 'subsystem' rebase was a simple rebase and | |
1088 | had no conflicts. | |
1089 | ||
1090 | Hard case: The changes are not the same.:: | |
1091 | ||
1092 | This happens if the 'subsystem' rebase had conflicts, or used | |
6cf378f0 JK |
1093 | `--interactive` to omit, edit, squash, or fixup commits; or |
1094 | if the upstream used one of `commit --amend`, `reset`, or | |
9df53c5d EN |
1095 | a full history rewriting command like |
1096 | https://github.com/newren/git-filter-repo[`filter-repo`]. | |
90d1c08e TR |
1097 | |
1098 | ||
1099 | The easy case | |
1100 | ~~~~~~~~~~~~~ | |
1101 | ||
1102 | Only works if the changes (patch IDs based on the diff contents) on | |
1103 | 'subsystem' are literally the same before and after the rebase | |
1104 | 'subsystem' did. | |
1105 | ||
0b444cdb | 1106 | In that case, the fix is easy because 'git rebase' knows to skip |
0fcb4f6b JT |
1107 | changes that are already present in the new upstream (unless |
1108 | `--reapply-cherry-picks` is given). So if you say | |
90d1c08e TR |
1109 | (assuming you're on 'topic') |
1110 | ------------ | |
1111 | $ git rebase subsystem | |
1112 | ------------ | |
1113 | you will end up with the fixed history | |
1114 | ------------ | |
1115 | o---o---o---o---o---o---o---o master | |
1116 | \ | |
1117 | o'--o'--o'--o'--o' subsystem | |
1118 | \ | |
1119 | *---*---* topic | |
1120 | ------------ | |
1121 | ||
1122 | ||
1123 | The hard case | |
1124 | ~~~~~~~~~~~~~ | |
1125 | ||
1126 | Things get more complicated if the 'subsystem' changes do not exactly | |
1127 | correspond to the ones before the rebase. | |
1128 | ||
1129 | NOTE: While an "easy case recovery" sometimes appears to be successful | |
1130 | even in the hard case, it may have unintended consequences. For | |
1131 | example, a commit that was removed via `git rebase | |
6cf378f0 | 1132 | --interactive` will be **resurrected**! |
90d1c08e | 1133 | |
54e51e55 | 1134 | The idea is to manually tell `git rebase` "where the old 'subsystem' |
414d924b | 1135 | ended and your 'topic' began", that is, what the old merge base |
90d1c08e TR |
1136 | between them was. You will have to find a way to name the last commit |
1137 | of the old 'subsystem', for example: | |
1138 | ||
54e51e55 | 1139 | * With the 'subsystem' reflog: after `git fetch`, the old tip of |
6cf378f0 | 1140 | 'subsystem' is at `subsystem@{1}`. Subsequent fetches will |
90d1c08e TR |
1141 | increase the number. (See linkgit:git-reflog[1].) |
1142 | ||
1143 | * Relative to the tip of 'topic': knowing that your 'topic' has three | |
1144 | commits, the old tip of 'subsystem' must be `topic~3`. | |
1145 | ||
1146 | You can then transplant the old `subsystem..topic` to the new tip by | |
1147 | saying (for the reflog case, and assuming you are on 'topic' already): | |
1148 | ------------ | |
1149 | $ git rebase --onto subsystem subsystem@{1} | |
1150 | ------------ | |
1151 | ||
1152 | The ripple effect of a "hard case" recovery is especially bad: | |
1153 | 'everyone' downstream from 'topic' will now have to perform a "hard | |
1154 | case" recovery too! | |
1155 | ||
25cff9f1 | 1156 | REBASING MERGES |
81d395cc | 1157 | --------------- |
25cff9f1 JS |
1158 | |
1159 | The interactive rebase command was originally designed to handle | |
1160 | individual patch series. As such, it makes sense to exclude merge | |
1161 | commits from the todo list, as the developer may have merged the | |
1162 | then-current `master` while working on the branch, only to rebase | |
1163 | all the commits onto `master` eventually (skipping the merge | |
1164 | commits). | |
1165 | ||
1166 | However, there are legitimate reasons why a developer may want to | |
1167 | recreate merge commits: to keep the branch structure (or "commit | |
1168 | topology") when working on multiple, inter-related branches. | |
1169 | ||
1170 | In the following example, the developer works on a topic branch that | |
1171 | refactors the way buttons are defined, and on another topic branch | |
1172 | that uses that refactoring to implement a "Report a bug" button. The | |
1173 | output of `git log --graph --format=%s -5` may look like this: | |
1174 | ||
1175 | ------------ | |
1176 | * Merge branch 'report-a-bug' | |
1177 | |\ | |
1178 | | * Add the feedback button | |
1179 | * | Merge branch 'refactor-button' | |
1180 | |\ \ | |
1181 | | |/ | |
1182 | | * Use the Button class for all buttons | |
1183 | | * Extract a generic Button class from the DownloadButton one | |
1184 | ------------ | |
1185 | ||
1186 | The developer might want to rebase those commits to a newer `master` | |
1187 | while keeping the branch topology, for example when the first topic | |
1188 | branch is expected to be integrated into `master` much earlier than the | |
1189 | second one, say, to resolve merge conflicts with changes to the | |
1190 | DownloadButton class that made it into `master`. | |
1191 | ||
1192 | This rebase can be performed using the `--rebase-merges` option. | |
1193 | It will generate a todo list looking like this: | |
1194 | ||
1195 | ------------ | |
1196 | label onto | |
1197 | ||
1198 | # Branch: refactor-button | |
1199 | reset onto | |
1200 | pick 123456 Extract a generic Button class from the DownloadButton one | |
1201 | pick 654321 Use the Button class for all buttons | |
1202 | label refactor-button | |
1203 | ||
1204 | # Branch: report-a-bug | |
1205 | reset refactor-button # Use the Button class for all buttons | |
1206 | pick abcdef Add the feedback button | |
1207 | label report-a-bug | |
1208 | ||
1209 | reset onto | |
1210 | merge -C a1b2c3 refactor-button # Merge 'refactor-button' | |
1211 | merge -C 6f5e4d report-a-bug # Merge 'report-a-bug' | |
1212 | ------------ | |
1213 | ||
1214 | In contrast to a regular interactive rebase, there are `label`, `reset` | |
1215 | and `merge` commands in addition to `pick` ones. | |
1216 | ||
1217 | The `label` command associates a label with the current HEAD when that | |
1218 | command is executed. These labels are created as worktree-local refs | |
1219 | (`refs/rewritten/<label>`) that will be deleted when the rebase | |
1220 | finishes. That way, rebase operations in multiple worktrees linked to | |
1221 | the same repository do not interfere with one another. If the `label` | |
1222 | command fails, it is rescheduled immediately, with a helpful message how | |
1223 | to proceed. | |
1224 | ||
1225 | The `reset` command resets the HEAD, index and worktree to the specified | |
ad0b8f95 | 1226 | revision. It is similar to an `exec git reset --hard <label>`, but |
25cff9f1 JS |
1227 | refuses to overwrite untracked files. If the `reset` command fails, it is |
1228 | rescheduled immediately, with a helpful message how to edit the todo list | |
1229 | (this typically happens when a `reset` command was inserted into the todo | |
1230 | list manually and contains a typo). | |
1231 | ||
caafecfc JS |
1232 | The `merge` command will merge the specified revision(s) into whatever |
1233 | is HEAD at that time. With `-C <original-commit>`, the commit message of | |
25cff9f1 JS |
1234 | the specified merge commit will be used. When the `-C` is changed to |
1235 | a lower-case `-c`, the message will be opened in an editor after a | |
1236 | successful merge so that the user can edit the message. | |
1237 | ||
1238 | If a `merge` command fails for any reason other than merge conflicts (i.e. | |
1239 | when the merge operation did not even start), it is rescheduled immediately. | |
1240 | ||
f5a3c5e6 EN |
1241 | By default, the `merge` command will use the `ort` merge strategy for |
1242 | regular merges, and `octopus` for octopus merges. One can specify a | |
1243 | default strategy for all merges using the `--strategy` argument when | |
1244 | invoking rebase, or can override specific merges in the interactive | |
1245 | list of commands by using an `exec` command to call `git merge` | |
1246 | explicitly with a `--strategy` argument. Note that when calling `git | |
1247 | merge` explicitly like this, you can make use of the fact that the | |
1248 | labels are worktree-local refs (the ref `refs/rewritten/onto` would | |
1249 | correspond to the label `onto`, for example) in order to refer to the | |
1250 | branches you want to merge. | |
25cff9f1 JS |
1251 | |
1252 | Note: the first command (`label onto`) labels the revision onto which | |
1253 | the commits are rebased; The name `onto` is just a convention, as a nod | |
1254 | to the `--onto` option. | |
1255 | ||
1256 | It is also possible to introduce completely new merge commits from scratch | |
1257 | by adding a command of the form `merge <merge-head>`. This form will | |
1258 | generate a tentative commit message and always open an editor to let the | |
1259 | user edit it. This can be useful e.g. when a topic branch turns out to | |
1260 | address more than a single concern and wants to be split into two or | |
1261 | even more topic branches. Consider this todo list: | |
1262 | ||
1263 | ------------ | |
1264 | pick 192837 Switch from GNU Makefiles to CMake | |
1265 | pick 5a6c7e Document the switch to CMake | |
1266 | pick 918273 Fix detection of OpenSSL in CMake | |
1267 | pick afbecd http: add support for TLS v1.3 | |
1268 | pick fdbaec Fix detection of cURL in CMake on Windows | |
1269 | ------------ | |
1270 | ||
1271 | The one commit in this list that is not related to CMake may very well | |
1272 | have been motivated by working on fixing all those bugs introduced by | |
1273 | switching to CMake, but it addresses a different concern. To split this | |
1274 | branch into two topic branches, the todo list could be edited like this: | |
1275 | ||
1276 | ------------ | |
1277 | label onto | |
1278 | ||
1279 | pick afbecd http: add support for TLS v1.3 | |
1280 | label tlsv1.3 | |
1281 | ||
1282 | reset onto | |
1283 | pick 192837 Switch from GNU Makefiles to CMake | |
1284 | pick 918273 Fix detection of OpenSSL in CMake | |
1285 | pick fdbaec Fix detection of cURL in CMake on Windows | |
1286 | pick 5a6c7e Document the switch to CMake | |
1287 | label cmake | |
1288 | ||
1289 | reset onto | |
1290 | merge tlsv1.3 | |
1291 | merge cmake | |
1292 | ------------ | |
1293 | ||
414abf15 ÆAB |
1294 | CONFIGURATION |
1295 | ------------- | |
1296 | ||
18d89fe2 ÆAB |
1297 | include::includes/cmd-config-section-all.txt[] |
1298 | ||
414abf15 ÆAB |
1299 | include::config/rebase.txt[] |
1300 | include::config/sequencer.txt[] | |
1301 | ||
7fc9d69f JH |
1302 | GIT |
1303 | --- | |
9e1f0a85 | 1304 | Part of the linkgit:git[1] suite |