@matheusbsbs / matheus-bagliano / commits / 5960bc9d63

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 <martin.von.zweigbergk@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Martin von Zweigbergk committed Jul 13, 2011 at 23:47 UTC 5960bc9d63c2cd9dc7eb9d44f470d516579f1bd6
2 files changed +11 -7
Documentation/git-rebase.txt
+6 -2
@@ -46,7 +46,7 @@ with a different commit message or timestamp will be skipped).
46 It is possible that a merge failure will prevent this process from being
47 completely automatic. You will have to resolve any such merge failure
48 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
50 original <branch> and remove the .git/rebase-apply working files, use the
51 command `git rebase --abort` instead.
52
@@ -233,7 +233,11 @@ leave out at most one of A and B, in which case it defaults to HEAD.
233 Restart the rebasing process after having resolved a merge conflict.
234
235 --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.
241
242 --skip::
243 Restart the rebasing process by skipping the current patch.
git-rebase.sh
+5 -5
@@ -13,7 +13,7 @@ It then attempts to create a new commit for each commit from the original
13 It is possible that a merge failure will prevent this process from being
14 completely automatic. You will have to resolve any such merge failure
15 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
17 original <branch> and remove the .git/rebase-apply working files, use the
18 command git rebase --abort instead.
19
@@ -57,9 +57,9 @@ whitespace=! passed to 'git apply'
57 ignore-whitespace! passed to 'git apply'
58 C=! passed to 'git apply'
59 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
63 "
64 . git-sh-setup
65 set_reflog_action rebase
@@ -72,7 +72,7 @@ ok_to_skip_pre_rebase=
72 resolvemsg="
73 When you have resolved this problem run \"git rebase --continue\".
74 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\".
76 "
77 unset onto
78 strategy=