Documentation/git-rebase.txt

   1 git-rebase(1)
   2 =============
   3
   4 NAME
   5 ----
   6 git-rebase - Forward-port local commits to the updated upstream head
   7
   8 SYNOPSIS
   9 --------
  10 [verse]
  11 'git-rebase' [-i | --interactive] [-v | --verbose] [-m | --merge]
  12         [-s <strategy> | --strategy=<strategy>]
  13         [-C<n>] [ --whitespace=<option>] [-p | --preserve-merges]
  14         [--onto <newbase>] <upstream> [<branch>]
  15 'git-rebase' --continue | --skip | --abort
  16
  17 DESCRIPTION
  18 -----------
  19 If <branch> is specified, git-rebase will perform an automatic
  20 `git checkout <branch>` before doing anything else.  Otherwise
  21 it remains on the current branch.
  22
  23 All changes made by commits in the current branch but that are not
  24 in <upstream> are saved to a temporary area.  This is the same set
  25 of commits that would be shown by `git log <upstream>..HEAD`.
  26
  27 The current branch is reset to <upstream>, or <newbase> if the
  28 --onto option was supplied.  This has the exact same effect as
  29 `git reset --hard <upstream>` (or <newbase>).
  30
  31 The commits that were previously saved into the temporary area are
  32 then reapplied to the current branch, one by one, in order. Note that
  33 any commits in HEAD which introduce the same textual changes as a commit
  34 in HEAD..<upstream> are omitted (i.e., a patch already accepted upstream
  35 with a different commit message or timestamp will be skipped).
  36
  37 It is possible that a merge failure will prevent this process from being
  38 completely automatic.  You will have to resolve any such merge failure
  39 and run `git rebase --continue`.  Another option is to bypass the commit
  40 that caused the merge failure with `git rebase --skip`.  To restore the
  41 original <branch> and remove the .dotest working files, use the command
  42 `git rebase --abort` instead.
  43
  44 Assume the following history exists and the current branch is "topic":
  45
  46 ------------
  47           A---B---C topic
  48          /
  49     D---E---F---G master
  50 ------------
  51
  52 From this point, the result of either of the following commands:
  53
  54
  55     git-rebase master
  56     git-rebase master topic
  57
  58 would be:
  59
  60 ------------
  61                   A'--B'--C' topic
  62                  /
  63     D---E---F---G master
  64 ------------
  65
  66 The latter form is just a short-hand of `git checkout topic`
  67 followed by `git rebase master`.
  68
  69 If the upstream branch already contains a change you have made (e.g.,
  70 because you mailed a patch which was applied upstream), then that commit
  71 will be skipped. For example, running `git-rebase master` on the
  72 following history (in which A' and A introduce the same set of changes,
  73 but have different committer information):
  74
  75 ------------
  76           A---B---C topic
  77          /
  78     D---E---A'---F master
  79 ------------
  80
  81 will result in:
  82
  83 ------------
  84                    B'---C' topic
  85                   /
  86     D---E---A'---F master
  87 ------------
  88
  89 Here is how you would transplant a topic branch based on one
  90 branch to another, to pretend that you forked the topic branch
  91 from the latter branch, using `rebase --onto`.
  92
  93 First let's assume your 'topic' is based on branch 'next'.
  94 For example feature developed in 'topic' depends on some
  95 functionality which is found in 'next'.
  96
  97 ------------
  98     o---o---o---o---o  master
  99          \
 100           o---o---o---o---o  next
 101                            \
 102                             o---o---o  topic
 103 ------------
 104
 105 We would want to make 'topic' forked from branch 'master',
 106 for example because the functionality 'topic' branch depend on
 107 got merged into more stable 'master' branch, like this:
 108
 109 ------------
 110     o---o---o---o---o  master
 111         |            \
 112         |             o'--o'--o'  topic
 113          \
 114           o---o---o---o---o  next
 115 ------------
 116
 117 We can get this using the following command:
 118
 119     git-rebase --onto master next topic
 120
 121
 122 Another example of --onto option is to rebase part of a
 123 branch.  If we have the following situation:
 124
 125 ------------
 126                             H---I---J topicB
 127                            /
 128                   E---F---G  topicA
 129                  /
 130     A---B---C---D  master
 131 ------------
 132
 133 then the command
 134
 135     git-rebase --onto master topicA topicB
 136
 137 would result in:
 138
 139 ------------
 140                  H'--I'--J'  topicB
 141                 /
 142                 | E---F---G  topicA
 143                 |/
 144     A---B---C---D  master
 145 ------------
 146
 147 This is useful when topicB does not depend on topicA.
 148
 149 A range of commits could also be removed with rebase.  If we have
 150 the following situation:
 151
 152 ------------
 153     E---F---G---H---I---J  topicA
 154 ------------
 155
 156 then the command
 157
 158     git-rebase --onto topicA~5 topicA~3 topicA
 159
 160 would result in the removal of commits F and G:
 161
 162 ------------
 163     E---H'---I'---J'  topicA
 164 ------------
 165
 166 This is useful if F and G were flawed in some way, or should not be
 167 part of topicA.  Note that the argument to --onto and the <upstream>
 168 parameter can be any valid commit-ish.
 169
 170 In case of conflict, git-rebase will stop at the first problematic commit
 171 and leave conflict markers in the tree.  You can use git diff to locate
 172 the markers (<<<<<<) and make edits to resolve the conflict.  For each
 173 file you edit, you need to tell git that the conflict has been resolved,
 174 typically this would be done with
 175
 176
 177     git add <filename>
 178
 179
 180 After resolving the conflict manually and updating the index with the
 181 desired resolution, you can continue the rebasing process with
 182
 183
 184     git rebase --continue
 185
 186
 187 Alternatively, you can undo the git-rebase with
 188
 189
 190     git rebase --abort
 191
 192 OPTIONS
 193 -------
 194 <newbase>::
 195         Starting point at which to create the new commits. If the
 196         --onto option is not specified, the starting point is
 197         <upstream>.  May be any valid commit, and not just an
 198         existing branch name.
 199
 200 <upstream>::
 201         Upstream branch to compare against.  May be any valid commit,
 202         not just an existing branch name.
 203
 204 <branch>::
 205         Working branch; defaults to HEAD.
 206
 207 --continue::
 208         Restart the rebasing process after having resolved a merge conflict.
 209
 210 --abort::
 211         Restore the original branch and abort the rebase operation.
 212
 213 --skip::
 214         Restart the rebasing process by skipping the current patch.
 215
 216 -m, \--merge::
 217         Use merging strategies to rebase.  When the recursive (default) merge
 218         strategy is used, this allows rebase to be aware of renames on the
 219         upstream side.
 220
 221 -s <strategy>, \--strategy=<strategy>::
 222         Use the given merge strategy; can be supplied more than
 223         once to specify them in the order they should be tried.
 224         If there is no `-s` option, a built-in list of strategies
 225         is used instead (`git-merge-recursive` when merging a single
 226         head, `git-merge-octopus` otherwise).  This implies --merge.
 227
 228 -v, \--verbose::
 229         Display a diffstat of what changed upstream since the last rebase.
 230
 231 -C<n>::
 232         Ensure at least <n> lines of surrounding context match before
 233         and after each change.  When fewer lines of surrounding
 234         context exist they all must match.  By default no context is
 235         ever ignored.
 236
 237 --whitespace=<nowarn|warn|error|error-all|strip>::
 238         This flag is passed to the `git-apply` program
 239         (see linkgit:git-apply[1]) that applies the patch.
 240
 241 -i, \--interactive::
 242         Make a list of the commits which are about to be rebased.  Let the
 243         user edit that list before rebasing.  This mode can also be used to
 244         split commits (see SPLITTING COMMITS below).
 245
 246 -p, \--preserve-merges::
 247         Instead of ignoring merges, try to recreate them.  This option
 248         only works in interactive mode.
 249
 250 include::merge-strategies.txt[]
 251
 252 NOTES
 253 -----
 254 When you rebase a branch, you are changing its history in a way that
 255 will cause problems for anyone who already has a copy of the branch
 256 in their repository and tries to pull updates from you.  You should
 257 understand the implications of using 'git rebase' on a repository that
 258 you share.
 259
 260 When the git rebase command is run, it will first execute a "pre-rebase"
 261 hook if one exists.  You can use this hook to do sanity checks and
 262 reject the rebase if it isn't appropriate.  Please see the template
 263 pre-rebase hook script for an example.
 264
 265 You must be in the top directory of your project to start (or continue)
 266 a rebase.  Upon completion, <branch> will be the current branch.
 267
 268 INTERACTIVE MODE
 269 ----------------
 270
 271 Rebasing interactively means that you have a chance to edit the commits
 272 which are rebased.  You can reorder the commits, and you can
 273 remove them (weeding out bad or otherwise unwanted patches).
 274
 275 The interactive mode is meant for this type of workflow:
 276
 277 1. have a wonderful idea
 278 2. hack on the code
 279 3. prepare a series for submission
 280 4. submit
 281
 282 where point 2. consists of several instances of
 283
 284 a. regular use
 285  1. finish something worthy of a commit
 286  2. commit
 287 b. independent fixup
 288  1. realize that something does not work
 289  2. fix that
 290  3. commit it
 291
 292 Sometimes the thing fixed in b.2. cannot be amended to the not-quite
 293 perfect commit it fixes, because that commit is buried deeply in a
 294 patch series.  That is exactly what interactive rebase is for: use it
 295 after plenty of "a"s and "b"s, by rearranging and editing
 296 commits, and squashing multiple commits into one.
 297
 298 Start it with the last commit you want to retain as-is:
 299
 300         git rebase -i <after-this-commit>
 301
 302 An editor will be fired up with all the commits in your current branch
 303 (ignoring merge commits), which come after the given commit.  You can
 304 reorder the commits in this list to your heart's content, and you can
 305 remove them.  The list looks more or less like this:
 306
 307 -------------------------------------------
 308 pick deadbee The oneline of this commit
 309 pick fa1afe1 The oneline of the next commit
 310 ...
 311 -------------------------------------------
 312
 313 The oneline descriptions are purely for your pleasure; `git-rebase` will
 314 not look at them but at the commit names ("deadbee" and "fa1afe1" in this
 315 example), so do not delete or edit the names.
 316
 317 By replacing the command "pick" with the command "edit", you can tell
 318 `git-rebase` to stop after applying that commit, so that you can edit
 319 the files and/or the commit message, amend the commit, and continue
 320 rebasing.
 321
 322 If you want to fold two or more commits into one, replace the command
 323 "pick" with "squash" for the second and subsequent commit.  If the
 324 commits had different authors, it will attribute the squashed commit to
 325 the author of the first commit.
 326
 327 In both cases, or when a "pick" does not succeed (because of merge
 328 errors), the loop will stop to let you fix things, and you can continue
 329 the loop with `git rebase --continue`.
 330
 331 For example, if you want to reorder the last 5 commits, such that what
 332 was HEAD~4 becomes the new HEAD. To achieve that, you would call
 333 `git-rebase` like this:
 334
 335 ----------------------
 336 $ git rebase -i HEAD~5
 337 ----------------------
 338
 339 And move the first patch to the end of the list.
 340
 341 You might want to preserve merges, if you have a history like this:
 342
 343 ------------------
 344            X
 345             \
 346          A---M---B
 347         /
 348 ---o---O---P---Q
 349 ------------------
 350
 351 Suppose you want to rebase the side branch starting at "A" to "Q". Make
 352 sure that the current HEAD is "B", and call
 353
 354 -----------------------------
 355 $ git rebase -i -p --onto Q O
 356 -----------------------------
 357
 358
 359 SPLITTING COMMITS
 360 -----------------
 361
 362 In interactive mode, you can mark commits with the action "edit".  However,
 363 this does not necessarily mean that 'git rebase' expects the result of this
 364 edit to be exactly one commit.  Indeed, you can undo the commit, or you can
 365 add other commits.  This can be used to split a commit into two:
 366
 367 - Start an interactive rebase with 'git rebase -i <commit>^', where
 368   <commit> is the commit you want to split.  In fact, any commit range
 369   will do, as long as it contains that commit.
 370
 371 - Mark the commit you want to split with the action "edit".
 372
 373 - When it comes to editing that commit, execute 'git reset HEAD^'.  The
 374   effect is that the HEAD is rewound by one, and the index follows suit.
 375   However, the working tree stays the same.
 376
 377 - Now add the changes to the index that you want to have in the first
 378   commit.  You can use linkgit:git-add[1] (possibly interactively) and/or
 379   linkgit:git-gui[1] to do that.
 380
 381 - Commit the now-current index with whatever commit message is appropriate
 382   now.
 383
 384 - Repeat the last two steps until your working tree is clean.
 385
 386 - Continue the rebase with 'git rebase --continue'.
 387
 388 If you are not absolutely sure that the intermediate revisions are
 389 consistent (they compile, pass the testsuite, etc.) you should use
 390 linkgit:git-stash[1] to stash away the not-yet-committed changes
 391 after each commit, test, and amend the commit if fixes are necessary.
 392
 393
 394 Authors
 395 ------
 396 Written by Junio C Hamano <junkio@cox.net> and
 397 Johannes E. Schindelin <johannes.schindelin@gmx.de>
 398
 399 Documentation
 400 --------------
 401 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 402
 403 GIT
 404 ---
 405 Part of the linkgit:git[7] suite