diff options
| author |  Martin von Zweigbergk <martin.von.zweigbergk@gmail.com> | 2011-07-13 23:47:06 -0400 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2011-07-13 22:03:12 -0700 |
| commit | 5960bc9d63c2cd9dc7eb9d44f470d516579f1bd6 (patch) | |
| tree | 5cc29a3e85c68ed4ec0b4e0a7ce789dc1dc853f3 /Documentation | |
| parent | docs: document --textconv diff option (diff) | |
| download | tgif-5960bc9d63c2cd9dc7eb9d44f470d516579f1bd6.tar.xz | |
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>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/git-rebase.txt | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt index 9a075bc4d2..952859f40a 100644 --- a/Documentation/git-rebase.txt +++ b/Documentation/git-rebase.txt @@ -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. @@ -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. |