[PATCH v3] git-rebase.txt: clarify that --abort checks out <branch>
- From
Martin von Zweigbergk <martin.von.zweigbergk@gmail.com>
- Date
- Jul 10, 2011, 18:31 UTC
- Message-ID
- <1310322661-24924-1-git-send-email-martin.von.zweigbergk@gmail.com>
- In-Reply-To
- <1310092069-19708-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.
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> --- Documentation/git-rebase.txt | 6 +++++- git-rebase.sh | 6 +++--- 2 files changed, 8 insertions(+), 4 deletions(-)
diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt index a9e0e50..d2f2cd9 100644 --- a/Documentation/git-rebase.txt +++ b/Documentation/git-rebase.txt @@ -232,7 +232,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. diff --git a/git-rebase.sh b/git-rebase.sh index d7855ea..9065c16 100755 --- a/git-rebase.sh +++ b/git-rebase.sh @@ -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
-- 1.7.6.51.g07e0e