[PATCH 2/2] git-rebase.txt: clarify that --abort checks out <branch>
- From
Martin von Zweigbergk <martin.von.zweigbergk@gmail.com>
- Date
- Jul 2, 2011, 02:38 UTC
- Message-ID
- <1309574324-6833-1-git-send-email-martin.von.zweigbergk@gmail.com>
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, like so:
Abort the rebase operation and check out <branch>.
Signed-off-by: Martin von Zweigbergk <martin.von.zweigbergk@gmail.com> ---
This was basically suggested by Jonathan in [1] ('git rebase --discard'/'git rebase --abort --stay' or whatever it should be called). Since I have not had much time for Git lately, I thought I would just post these two patches for now, in case it will take time before I get a chance to move even the simple work in [1] forward.
[1] http://thread.gmane.org/gmane.comp.version-control.git/174655/focus=174683
Documentation/git-rebase.txt | 2 +- git-rebase.sh | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt index a9e0e50..f103eca 100644 --- a/Documentation/git-rebase.txt +++ b/Documentation/git-rebase.txt @@ -232,7 +232,7 @@ 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 check out <branch>. --skip:: Restart the rebasing process by skipping the current patch. diff --git a/git-rebase.sh b/git-rebase.sh index d7855ea..de419ac 100755 --- a/git-rebase.sh +++ b/git-rebase.sh @@ -58,7 +58,7 @@ ignore-whitespace! passed to 'git apply' C=! passed to 'git apply' Actions: continue! continue rebasing process -abort! abort rebasing process and restore original branch +abort! abort rebasing process and check out <branch> skip! skip current patch and continue rebasing process " . git-sh-setup
-- 1.7.5.3.640.gd1066