git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Martin von Zweigbergk <martin.von.zweigbergk@gmail.com>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>,
	Jonathan Nieder <jrnieder@gmail.com>,
	Martin von Zweigbergk <martin.von.zweigbergk@gmail.com>
Subject: [PATCH 2/2] git-rebase.txt: clarify that --abort checks out <branch>
Date: Fri,  1 Jul 2011 22:38:44 -0400	[thread overview]
Message-ID: <1309574324-6833-1-git-send-email-martin.von.zweigbergk@gmail.com> (raw)

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

             reply	other threads:[~2011-07-02  2:39 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-07-02  2:38 Martin von Zweigbergk [this message]
2011-07-05 21:43 ` [PATCH 2/2] git-rebase.txt: clarify that --abort checks out <branch> Drew Northup
2011-07-06  2:19   ` Martin von Zweigbergk
2011-07-06  2:52     ` Jonathan Nieder
2011-07-06 13:25       ` Drew Northup
2011-07-08  2:27 ` [PATCH v2] " Martin von Zweigbergk
2011-07-08 16:07   ` Junio C Hamano
2011-07-10 18:07     ` Martin von Zweigbergk
2011-07-10 18:31   ` [PATCH v3] " Martin von Zweigbergk
2011-07-14  3:47     ` [PATCH v4] rebase: clarify "restore the original branch" Martin von Zweigbergk

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1309574324-6833-1-git-send-email-martin.von.zweigbergk@gmail.com \
    --to=martin.von.zweigbergk@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=jrnieder@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).