From 5960bc9d63c2cd9dc7eb9d44f470d516579f1bd6 Mon Sep 17 00:00:00 2001 From: Martin von Zweigbergk Date: Wed, 13 Jul 2011 23:47:06 -0400 Subject: rebase: clarify "restore the original branch" The description for 'git rebase --abort' currently says: Restore the original branch and abort the rebase operation. The "restore" can be misinterpreted to imply that the original branch was somehow in a broken state during the rebase operation. It is also not completely clear what "the original branch" is --- is it the branch that was checked out before the rebase operation was called or is the the branch that is being rebased (it is the latter)? Although both issues are made clear in the DESCRIPTION section, let us also make the entry in the OPTIONS secion more clear. Also remove the term "rebasing process" from the usage text, since the user already knows that the text is about "git rebase". Signed-off-by: Martin von Zweigbergk Signed-off-by: Junio C Hamano --- Documentation/git-rebase.txt | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) (limited to 'Documentation') diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt index 9a075bc4d..952859f40 100644 --- a/Documentation/git-rebase.txt +++ b/Documentation/git-rebase.txt @@ -46,7 +46,7 @@ with a different commit message or timestamp will be skipped). It is possible that a merge failure will prevent this process from being completely automatic. You will have to resolve any such merge failure and run `git rebase --continue`. Another option is to bypass the commit -that caused the merge failure with `git rebase --skip`. To restore the +that caused the merge failure with `git rebase --skip`. To check out the original and remove the .git/rebase-apply working files, use the command `git rebase --abort` instead. @@ -233,7 +233,11 @@ leave out at most one of A and B, in which case it defaults to HEAD. Restart the rebasing process after having resolved a merge conflict. --abort:: - Restore the original branch and abort the rebase operation. + 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. --skip:: Restart the rebasing process by skipping the current patch. -- cgit v1.2.1