Skip to content

Commit

Permalink
rebase: clarify "restore the original branch"
Browse files Browse the repository at this point in the history
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 <martin.von.zweigbergk@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
Martin von Zweigbergk authored and Junio C Hamano committed Jul 14, 2011
1 parent d28790d commit 5960bc9
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 7 deletions.
8 changes: 6 additions & 2 deletions Documentation/git-rebase.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 <branch> and remove the .git/rebase-apply working files, use the
command `git rebase --abort` instead.

Expand Down Expand Up @@ -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 <branch> was provided when the rebase operation was
started, then HEAD will be reset to <branch>. 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.
Expand Down
10 changes: 5 additions & 5 deletions git-rebase.sh
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ It then attempts to create a new commit for each commit from the original
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 <branch> and remove the .git/rebase-apply working files, use the
command git rebase --abort instead.
Expand Down Expand Up @@ -57,9 +57,9 @@ whitespace=! passed to 'git apply'
ignore-whitespace! passed to 'git apply'
C=! passed to 'git apply'
Actions:
continue! continue rebasing process
abort! abort rebasing process and restore original branch
skip! skip current patch and continue rebasing process
continue! continue
abort! abort and check out the original branch
skip! skip current patch and continue
"
. git-sh-setup
set_reflog_action rebase
Expand All @@ -72,7 +72,7 @@ ok_to_skip_pre_rebase=
resolvemsg="
When you have resolved this problem run \"git rebase --continue\".
If you would prefer to skip this patch, instead run \"git rebase --skip\".
To restore the original branch and stop rebasing run \"git rebase --abort\".
To check out the original branch and stop rebasing run \"git rebase --abort\".
"
unset onto
strategy=
Expand Down

0 comments on commit 5960bc9

Please sign in to comment.