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