Skip to content

Commit 5960bc9

Browse files
Martin von Zweigbergkgitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent d28790d commit 5960bc9

File tree

2 files changed

+11
-7
lines changed

2 files changed

+11
-7
lines changed

Documentation/git-rebase.txt

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ with a different commit message or timestamp will be skipped).
4646
It is possible that a merge failure will prevent this process from being
4747
completely automatic. You will have to resolve any such merge failure
4848
and run `git rebase --continue`. Another option is to bypass the commit
49-
that caused the merge failure with `git rebase --skip`. To restore the
49+
that caused the merge failure with `git rebase --skip`. To check out the
5050
original <branch> and remove the .git/rebase-apply working files, use the
5151
command `git rebase --abort` instead.
5252

@@ -233,7 +233,11 @@ leave out at most one of A and B, in which case it defaults to HEAD.
233233
Restart the rebasing process after having resolved a merge conflict.
234234

235235
--abort::
236-
Restore the original branch and abort the rebase operation.
236+
Abort the rebase operation and reset HEAD to the original
237+
branch. If <branch> was provided when the rebase operation was
238+
started, then HEAD will be reset to <branch>. Otherwise HEAD
239+
will be reset to where it was when the rebase operation was
240+
started.
237241

238242
--skip::
239243
Restart the rebasing process by skipping the current patch.

git-rebase.sh

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ It then attempts to create a new commit for each commit from the original
1313
It is possible that a merge failure will prevent this process from being
1414
completely automatic. You will have to resolve any such merge failure
1515
and run git rebase --continue. Another option is to bypass the commit
16-
that caused the merge failure with git rebase --skip. To restore the
16+
that caused the merge failure with git rebase --skip. To check out the
1717
original <branch> and remove the .git/rebase-apply working files, use the
1818
command git rebase --abort instead.
1919
@@ -57,9 +57,9 @@ whitespace=! passed to 'git apply'
5757
ignore-whitespace! passed to 'git apply'
5858
C=! passed to 'git apply'
5959
Actions:
60-
continue! continue rebasing process
61-
abort! abort rebasing process and restore original branch
62-
skip! skip current patch and continue rebasing process
60+
continue! continue
61+
abort! abort and check out the original branch
62+
skip! skip current patch and continue
6363
"
6464
. git-sh-setup
6565
set_reflog_action rebase
@@ -72,7 +72,7 @@ ok_to_skip_pre_rebase=
7272
resolvemsg="
7373
When you have resolved this problem run \"git rebase --continue\".
7474
If you would prefer to skip this patch, instead run \"git rebase --skip\".
75-
To restore the original branch and stop rebasing run \"git rebase --abort\".
75+
To check out the original branch and stop rebasing run \"git rebase --abort\".
7676
"
7777
unset onto
7878
strategy=

0 commit comments

Comments
 (0)