GIT-REBASE(1) Git Manual GIT-REBASE(1) NAME git-rebase - Reapply commits on top of another base tip SYNOPSIS git rebase [-i | --interactive] [] [--exec ] [--onto | --keep-base] [ []] git rebase [-i | --interactive] [] [--exec ] [--onto ] --root [] git rebase (--continue|--skip|--abort|--quit|--edit-todo|--show-current-patch) DESCRIPTION Transplant a series of commits onto a different starting point. You can also use git rebase to reorder or combine commits: see INTERACTIVE MODE below for how to do that. For example, imagine that you have been working on the topic branch in this history, and you want to "catch up" to the work done on the master branch. A---B---C topic / D---E---F---G master You want to transplant the commits you made on topic since it diverged from master (i.e. A, B, and C), on top of the current master. You can do this by running git rebase master while the topic branch is checked out. If you want to rebase topic while on another branch, git rebase master topic is a shortcut for git checkout topic && git rebase master. A'--B'--C' topic / D---E---F---G master If there is a merge conflict during this process, git rebase will stop at the first problematic commit and leave conflict markers. If this happens, you can do one of these things: 1. Resolve the conflict. You can use git diff to find the markers (<<<<<<) and make edits to resolve the conflict. For each file you edit, you need to tell Git that the conflict has been resolved. You can mark the conflict as resolved with git add . After resolving all of the conflicts, you can continue the rebasing process with git rebase --continue 2. Stop the git rebase and return your branch to its original state with git rebase --abort 3. Skip the commit that caused the merge conflict with git rebase --skip If you don't specify an to rebase onto, the upstream configured in branch..remote and branch..merge options will be used (see git-config(1) for details) and the --fork-point option is assumed. If you are currently not on any branch or if the current branch does not have a configured upstream, the rebase will abort. Here is a simplified description of what git rebase does: 1. Make a list of all commits on your current branch since it branched off from that do not have an equivalent commit in . 2. Check out with the equivalent of git checkout --detach . 3. Replay the commits, one by one, in order. This is similar to running git cherry-pick for each commit. See REBASING MERGES for how merges are handled. 4. Update your branch to point to the final commit with the equivalent of git checkout -B . Note When starting the rebase, ORIG_HEAD is set to point to the commit at the tip of the to-be-rebased branch. However, ORIG_HEAD is not guaranteed to still point to that commit at the end of the rebase if other commands that change ORIG_HEAD (like git reset) are used during the rebase. The previous branch tip, however, is accessible using the reflog of the current branch (i.e. @{1}, see gitrevisions(7)). TRANSPLANTING A TOPIC BRANCH WITH --ONTO Here is how you would transplant a topic branch based on one branch to another, to pretend that you forked the topic branch from the latter branch, using rebase --onto. First let's assume your topic is based on branch next. For example, a feature developed in topic depends on some functionality which is found in next. o---o---o---o---o master \ o---o---o---o---o next \ o---o---o topic We want to make topic forked from branch master; for example, because the functionality on which topic depends was merged into the more stable master branch. We want our tree to look like this: o---o---o---o---o master | \ | o'--o'--o' topic \ o---o---o---o---o next We can get this using the following command: git rebase --onto master next topic Another example of --onto option is to rebase part of a branch. If we have the following situation: H---I---J topicB / E---F---G topicA / A---B---C---D master then the command git rebase --onto master topicA topicB would result in: H'--I'--J' topicB / | E---F---G topicA |/ A---B---C---D master This is useful when topicB does not depend on topicA. A range of commits could also be removed with rebase. If we have the following situation: E---F---G---H---I---J topicA then the command git rebase --onto topicA~5 topicA~3 topicA would result in the removal of commits F and G: E---H'---I'---J' topicA This is useful if F and G were flawed in some way, or should not be part of topicA. Note that the argument to --onto and the parameter can be any valid commit-ish. MODE OPTIONS The options in this section cannot be used with any other option, including not with each other: --continue Restart the rebasing process after having resolved a merge conflict. --skip Restart the rebasing process by skipping the current patch. --abort Abort the rebase operation and reset HEAD to the original branch. If was provided when the rebase operation was started, then HEAD will be reset to . Otherwise HEAD will be reset to where it was when the rebase operation was started. --quit Abort the rebase operation but HEAD is not reset back to the original branch. The index and working tree are also left unchanged as a result. If a temporary stash entry was created using --autostash, it will be saved to the stash list. --edit-todo Edit the todo list during an interactive rebase. --show-current-patch Show the current patch in an interactive rebase or when rebase is stopped because of conflicts. This is the equivalent of git show REBASE_HEAD. OPTIONS --onto Starting point at which to create the new commits. If the --onto option is not specified, the starting point is . May be any valid commit, and not just an existing branch name. As a special case, you may use "A...B" as a shortcut for the merge base of A and B if there is exactly one merge base. You can leave out at most one of A and B, in which case it defaults to HEAD. See TRANSPLANTING A TOPIC BRANCH WITH --ONTO above for examples. --keep-base Set the starting point at which to create the new commits to the merge base of and . Running git rebase --keep-base is equivalent to running git rebase --reapply-cherry-picks --no-fork-point --onto ... . This option is useful in the case where one is developing a feature on top of an upstream branch. While the feature is being worked on, the upstream branch may advance and it may not be the best idea to keep rebasing on top of the upstream but to keep the base commit as-is. As the base commit is unchanged this option implies --reapply-cherry-picks to avoid losing commits. Although both this option and --fork-point find the merge base between and , this option uses the merge base as the starting point on which new commits will be created, whereas --fork-point uses the merge base to determine the set of commits which will be rebased. See also INCOMPATIBLE OPTIONS below. Upstream branch to compare against. May be any valid commit, not just an existing branch name. Defaults to the configured upstream for the current branch. Working branch; defaults to HEAD. --apply Use applying strategies to rebase (calling git-am internally). This option may become a no-op in the future once the merge backend handles everything the apply one does. See also INCOMPATIBLE OPTIONS below. --empty=(drop|keep|stop) How to handle commits that are not empty to start and are not clean cherry-picks of any upstream commit, but which become empty after rebasing (because they contain a subset of already upstream changes): drop The commit will be dropped. This is the default behavior. keep The commit will be kept. This option is implied when --exec is specified unless -i/--interactive is also specified. stop, ask The rebase will halt when the commit is applied, allowing you to choose whether to drop it, edit files more, or just commit the empty changes. This option is implied when -i/--interactive is specified. ask is a deprecated synonym of stop. Note that commits which start empty are kept (unless --no-keep-empty is specified), and commits which are clean cherry-picks (as determined by git log --cherry-mark ...) are detected and dropped as a preliminary step (unless --reapply-cherry-picks or --keep-base is passed). See also INCOMPATIBLE OPTIONS below. --no-keep-empty, --keep-empty Do not keep commits that start empty before the rebase (i.e. that do not change anything from its parent) in the result. The default is to keep commits which start empty, since creating such commits requires passing the --allow-empty override flag to git commit, signifying that a user is very intentionally creating such a commit and thus wants to keep it. Usage of this flag will probably be rare, since you can get rid of commits that start empty by just firing up an interactive rebase and removing the lines corresponding to the commits you don't want. This flag exists as a convenient shortcut, such as for cases where external tools generate many empty commits and you want them all removed. For commits which do not start empty but become empty after rebasing, see the --empty flag. See also INCOMPATIBLE OPTIONS below. --reapply-cherry-picks, --no-reapply-cherry-picks Reapply all clean cherry-picks of any upstream commit instead of preemptively dropping them. (If these commits then become empty after rebasing, because they contain a subset of already upstream changes, the behavior towards them is controlled by the --empty flag.) In the absence of --keep-base (or if --no-reapply-cherry-picks is given), these commits will be automatically dropped. Because this necessitates reading all upstream commits, this can be expensive in repositories with a large number of upstream commits that need to be read. When using the merge backend, warnings will be issued for each dropped commit (unless --quiet is given). Advice will also be issued unless advice.skippedCherryPicks is set to false (see git- config(1)). --reapply-cherry-picks allows rebase to forgo reading all upstream commits, potentially improving performance. See also INCOMPATIBLE OPTIONS below. --allow-empty-message No-op. Rebasing commits with an empty message used to fail and this option would override that behavior, allowing commits with empty messages to be rebased. Now commits with an empty message do not cause rebasing to halt. See also INCOMPATIBLE OPTIONS below. -m, --merge Using merging strategies to rebase (default). Note that a rebase merge works by replaying each commit from the working branch on top of the branch. Because of this, when a merge conflict happens, the side reported as ours is the so-far rebased series, starting with , and theirs is the working branch. In other words, the sides are swapped. See also INCOMPATIBLE OPTIONS below. -s , --strategy= Use the given merge strategy, instead of the default ort. This implies --merge. Because git rebase replays each commit from the working branch on top of the branch using the given strategy, using the ours strategy simply empties all patches from the , which makes little sense. See also INCOMPATIBLE OPTIONS below. -X , --strategy-option= Pass the through to the merge strategy. This implies --merge and, if no strategy has been specified, -s ort. Note the reversal of ours and theirs as noted above for the -m option. See also INCOMPATIBLE OPTIONS below. --rerere-autoupdate, --no-rerere-autoupdate After the rerere mechanism reuses a recorded resolution on the current conflict to update the files in the working tree, allow it to also update the index with the result of resolution. --no-rerere-autoupdate is a good way to double-check what git- rerere(1) did and catch potential mismerges, before committing the result to the index with a separate git-add(1). -S[], --gpg-sign[=], --no-gpg-sign GPG-sign commits. The keyid argument is optional and defaults to the committer identity; if specified, it must be stuck to the option without a space. --no-gpg-sign is useful to countermand both commit.gpgSign configuration variable, and earlier --gpg-sign. -q, --quiet Be quiet. Implies --no-stat. -v, --verbose Be verbose. Implies --stat. --stat Show a diffstat of what changed upstream since the last rebase. The diffstat is also controlled by the configuration option rebase.stat. -n, --no-stat Do not show a diffstat as part of the rebase process. --no-verify This option bypasses the pre-rebase hook. See also githooks(5). --verify Allows the pre-rebase hook to run, which is the default. This option can be used to override --no-verify. See also githooks(5). -C Ensure at least lines of surrounding context match before and after each change. When fewer lines of surrounding context exist they all must match. By default no context is ever ignored. Implies --apply. See also INCOMPATIBLE OPTIONS below. --no-ff, --force-rebase, -f Individually replay all rebased commits instead of fast-forwarding over the unchanged ones. This ensures that the entire history of the rebased branch is composed of new commits. You may find this helpful after reverting a topic branch merge, as this option recreates the topic branch with fresh commits so it can be remerged successfully without needing to "revert the reversion" (see the revert-a-faulty-merge How-To[1] for details). --fork-point, --no-fork-point Use reflog to find a better common ancestor between and when calculating which commits have been introduced by . When --fork-point is active, fork_point will be used instead of to calculate the set of commits to rebase, where fork_point is the result of git merge-base --fork-point command (see git-merge-base(1)). If fork_point ends up being empty, the will be used as a fallback. If or --keep-base is given on the command line, then the default is --no-fork-point, otherwise the default is --fork-point. See also rebase.forkpoint in git-config(1). If your branch was based on but was rewound and your branch contains commits which were dropped, this option can be used with --keep-base in order to drop those commits from your branch. See also INCOMPATIBLE OPTIONS below. --ignore-whitespace Ignore whitespace differences when trying to reconcile differences. Currently, each backend implements an approximation of this behavior: apply backend When applying a patch, ignore changes in whitespace in context lines. Unfortunately, this means that if the "old" lines being replaced by the patch differ only in whitespace from the existing file, you will get a merge conflict instead of a successful patch application. merge backend Treat lines with only whitespace changes as unchanged when merging. Unfortunately, this means that any patch hunks that were intended to modify whitespace and nothing else will be dropped, even if the other side had no changes that conflicted. --whitespace=