Add --continue and --abort options to git-rebase.

git rebase [--onto <newbase>] <upstream> [<branch>]
  git rebase --continue
  git rebase --abort

Add "--continue" to restart the rebase process after
manually resolving conflicts.  The user is warned if
there are still differences between the index and the
working files.

Add "--abort" to restore the original branch, and
remove the .dotest working files.

Some minor additions to the git-rebase documentation.

[jc: fix that applies to the maintenance track has been dealt
 with separately.]

Signed-off-by: Junio C Hamano <junkio@cox.net>
This commit is contained in:
sean 2006-04-26 10:49:38 -04:00 committed by Junio C Hamano
parent 69bcc43eca
commit 031321c654
2 changed files with 97 additions and 33 deletions

View File

@ -3,38 +3,54 @@ git-rebase(1)
NAME NAME
---- ----
git-rebase - Rebase local commits to new upstream head git-rebase - Rebase local commits to a new head
SYNOPSIS SYNOPSIS
-------- --------
'git-rebase' [--onto <newbase>] <upstream> [<branch>] 'git-rebase' [--onto <newbase>] <upstream> [<branch>]
'git-rebase' --continue
'git-rebase' --abort
DESCRIPTION DESCRIPTION
----------- -----------
git-rebase applies to <upstream> (or optionally to <newbase>) commits git-rebase replaces <branch> with a new branch of the same name. When
from <branch> that do not appear in <upstream>. When <branch> is not the --onto option is provided the new branch starts out with a HEAD equal
specified it defaults to the current branch (HEAD). to <newbase>, otherwise it is equal to <upstream>. It then attempts to
create a new commit for each commit from the original <branch> that does
not exist in the <upstream> branch.
When git-rebase is complete, <branch> will be updated to point to the It is possible that a merge failure will prevent this process from being
newly created line of commit objects, so the previous line will not be completely automatic. You will have to resolve any such merge failure
accessible unless there are other references to it already. and run `git rebase --continue`. If you can not resolve the merge
failure, running `git rebase --abort` will restore the original <branch>
and remove the working files found in the .dotest directory.
Note that if <branch> is not specified on the command line, the currently
checked out branch is used.
Assume the following history exists and the current branch is "topic": Assume the following history exists and the current branch is "topic":
------------
A---B---C topic A---B---C topic
/ /
D---E---F---G master D---E---F---G master
------------
From this point, the result of either of the following commands: From this point, the result of either of the following commands:
git-rebase master git-rebase master
git-rebase master topic git-rebase master topic
would be: would be:
------------
A'--B'--C' topic A'--B'--C' topic
/ /
D---E---F---G master D---E---F---G master
------------
While, starting from the same point, the result of either of the following While, starting from the same point, the result of either of the following
commands: commands:
@ -44,21 +60,33 @@ commands:
would be: would be:
------------
A'--B'--C' topic A'--B'--C' topic
/ /
D---E---F---G master D---E---F---G master
------------
In case of conflict, git-rebase will stop at the first problematic commit In case of conflict, git-rebase will stop at the first problematic commit
and leave conflict markers in the tree. After resolving the conflict manually and leave conflict markers in the tree. You can use git diff to locate
and updating the index with the desired resolution, you can continue the the markers (<<<<<<) and make edits to resolve the conflict. For each
rebasing process with file you edit, you need to tell git that the conflict has been resolved,
typically this would be done with
git update-index <filename>
After resolving the conflict manually and updating the index with the
desired resolution, you can continue the rebasing process with
git rebase --continue
git am --resolved --3way
Alternatively, you can undo the git-rebase with Alternatively, you can undo the git-rebase with
git reset --hard ORIG_HEAD
rm -r .dotest git rebase --abort
OPTIONS OPTIONS
------- -------
@ -73,6 +101,28 @@ OPTIONS
<branch>:: <branch>::
Working branch; defaults to HEAD. Working branch; defaults to HEAD.
--continue::
Restart the rebasing process after having resolved a merge conflict.
--abort::
Restore the original branch and abort the rebase operation.
NOTES
-----
When you rebase a branch, you are changing its history in a way that
will cause problems for anyone who already has a copy of the branch
in their repository and tries to pull updates from you. You should
understand the implications of using 'git rebase' on a repository that
you share.
When the git rebase command is run, it will first execute a "pre-rebase"
hook if one exists. You can use this hook to do sanity checks and
reject the rebase if it isn't appropriate. Please see the template
pre-rebase hook script for an example.
You must be in the top directory of your project to start (or continue)
a rebase. Upon completion, <branch> will be the current branch.
Author Author
------ ------
Written by Junio C Hamano <junkio@cox.net> Written by Junio C Hamano <junkio@cox.net>

View File

@ -4,37 +4,51 @@
# #
USAGE='[--onto <newbase>] <upstream> [<branch>]' USAGE='[--onto <newbase>] <upstream> [<branch>]'
LONG_USAGE='git-rebase applies to <upstream> (or optionally to <newbase>) commits LONG_USAGE='git-rebase replaces <branch> with a new branch of the
from <branch> that do not appear in <upstream>. When <branch> is not same name. When the --onto option is provided the new branch starts
specified it defaults to the current branch (HEAD). out with a HEAD equal to <newbase>, otherwise it is equal to <upstream>
It then attempts to create a new commit for each commit from the original
<branch> that does not exist in the <upstream> branch.
When git-rebase is complete, <branch> will be updated to point to the It is possible that a merge failure will prevent this process from being
newly created line of commit objects, so the previous line will not be completely automatic. You will have to resolve any such merge failure
accessible unless there are other references to it already. and run git-rebase --continue. If you can not resolve the merge failure,
running git-rebase --abort will restore the original <branch> and remove
the working files found in the .dotest directory.
Assuming the following history: Note that if <branch> is not specified on the command line, the
currently checked out branch is used. You must be in the top
directory of your project to start (or continue) a rebase.
A---B---C topic Example: git-rebase master~1 topic
/
D---E---F---G master
The result of the following command: A---B---C topic A'\''--B'\''--C'\'' topic
/ --> /
git-rebase --onto master~1 master topic D---E---F---G master D---E---F---G master
would be:
A'\''--B'\''--C'\'' topic
/
D---E---F---G master
' '
. git-sh-setup . git-sh-setup
unset newbase unset newbase
while case "$#" in 0) break ;; esac while case "$#" in 0) break ;; esac
do do
case "$1" in case "$1" in
--continue)
diff=$(git-diff-files)
case "$diff" in
?*) echo "You must edit all merge conflicts and then"
echo "mark them as resolved using git update-index"
exit 1
;;
esac
git am --resolved --3way
exit
;;
--abort)
[ -d .dotest ] || die "No rebase in progress?"
git reset --hard ORIG_HEAD
rm -r .dotest
exit
;;
--onto) --onto)
test 2 -le "$#" || usage test 2 -le "$#" || usage
newbase="$2" newbase="$2"