git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Jonathan Nieder <jrnieder@gmail.com>
To: Johannes Schindelin <Johannes.Schindelin@gmx.de>
Cc: Junio C Hamano <gitster@pobox.com>,
	Thomas Rast <trast@student.ethz.ch>,
	Nicolas Sebrecht <nicolas.s.dev@gmx.fr>,
	Matthieu Moy <Matthieu.Moy@imag.fr>,
	git@vger.kernel.org, Kevin Ballard <kevin@sb.org>,
	Yann Dirson <dirson@bertin.fr>, Eric Raible <raible@nextest.com>,
	Christian Couder <chriscool@tuxfamily.org>
Subject: [PATCH] Documentation: suggest "reset --keep" to undo a commit
Date: Fri, 21 Jan 2011 01:37:30 -0600	[thread overview]
Message-ID: <20110121073730.GA26276@burratino> (raw)
In-Reply-To: <alpine.DEB.1.00.1101210801210.15247@pacific.mpi-cbg.de>

When one's only goal is to move from one commit to another, reset
--keep is simply better than reset --hard, since it preserves local
changes in the index and worktree when easy and errors out without
doing anything when not.  Update the two "how to remove commits"
examples in this vein.  "reset --hard" is still explained in a later
example about cleaning up during a merge.

Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
---
Johannes Schindelin wrote:

> rebase -i checks that all is well and we could come back to the current 
> status later if we realized that things went horribly wrong.
>
> reset --hard does not do that. No safety net. No reflog. Nada.

Right.  I think we should encourage people to use "reset --keep" more
often.  (In general.  The particular "rebase to pull" example just
mentioned is less obvious.)

 Documentation/git-reset.txt |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/git-reset.txt b/Documentation/git-reset.txt
index fd72976..1f13a1e 100644
--- a/Documentation/git-reset.txt
+++ b/Documentation/git-reset.txt
@@ -148,7 +148,7 @@ Undo a commit, making it a topic branch::
 +
 ------------
 $ git branch topic/wip     <1>
-$ git reset --hard HEAD~3  <2>
+$ git reset --keep HEAD~3  <2>
 $ git checkout topic/wip   <3>
 ------------
 +
@@ -163,7 +163,7 @@ Undo commits permanently::
 +
 ------------
 $ git commit ...
-$ git reset --hard HEAD~3   <1>
+$ git reset --keep HEAD~3   <1>
 ------------
 +
 <1> The last three commits (HEAD, HEAD^, and HEAD~2) were bad
-- 
1.7.4.rc2

  reply	other threads:[~2011-01-21  7:38 UTC|newest]

Thread overview: 38+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-08-10 13:08 Black smoke from git rebase -i exec Ævar Arnfjörð Bjarmason
2010-08-10 13:37 ` Matthieu Moy
2010-08-10 13:57   ` Ævar Arnfjörð Bjarmason
2010-08-10 14:12     ` Johannes Sixt
2010-08-10 14:16       ` Ævar Arnfjörð Bjarmason
2010-08-10 15:05         ` Matthieu Moy
2010-08-10 15:17           ` [PATCH 1/2 (fix broken test)] rebase -i: add exec command to launch a shell command Matthieu Moy
2010-08-11 18:31             ` Junio C Hamano
2010-08-12  7:47               ` Matthieu Moy
2011-01-16  1:59             ` [PATCH 0/2] rebase -i: in-editor documentation nits Jonathan Nieder
2011-01-16  2:01               ` [PATCH 1/2] rebase -i: reword in-editor documentation of "exec" Jonathan Nieder
2011-01-16 10:27                 ` Matthieu Moy
2011-01-18 15:05                   ` Junio C Hamano
2011-01-20 20:09                   ` Jonathan Nieder
2011-01-20 20:59                     ` Junio C Hamano
2011-01-21  0:36                       ` [PATCH 1/2 v2] rebase -i: clarify " Jonathan Nieder
2011-01-21  6:59                         ` Matthieu Moy
2011-01-21  7:47                           ` Jonathan Nieder
2011-01-21 10:43                             ` Matthieu Moy
2011-01-16  2:02               ` [PATCH 2/2] rebase -i: explain how to discard all commits Jonathan Nieder
2011-01-20 19:39                 ` [PATCH 2/2] " Nicolas Sebrecht
2011-01-20 19:57                   ` Jonathan Nieder
2011-01-20 20:08                     ` Nicolas Sebrecht
2011-01-20 20:34                       ` Thomas Rast
2011-01-20 21:28                         ` Junio C Hamano
2011-01-21  7:04                           ` Johannes Schindelin
2011-01-21  7:37                             ` Jonathan Nieder [this message]
2011-01-21 17:34                               ` [PATCH] Documentation: suggest "reset --keep" to undo a commit Junio C Hamano
2011-01-21 19:14                                 ` Jonathan Nieder
2011-01-21 20:28                                   ` Junio C Hamano
2011-01-21 16:51                             ` [PATCH 2/2] Re: rebase -i: explain how to discard all commits Junio C Hamano
2011-01-21 17:05                               ` Matthieu Moy
2011-01-21 17:57                                 ` Joshua Jensen
2011-01-21 18:37                                   ` [PATCH] Documentation: do not treat reset --keep as a special case Jonathan Nieder
2011-01-21 20:35                                     ` Junio C Hamano
2011-01-26  7:33                                   ` [PATCH 2/2] Re: rebase -i: explain how to discard all commits Jay Soffian
2011-01-23 20:10                               ` Johannes Schindelin
2010-08-10 15:17           ` [PATCH 2/2] test-lib: user-friendly alternatives to test [-d|-f|-e] Matthieu Moy

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=20110121073730.GA26276@burratino \
    --to=jrnieder@gmail.com \
    --cc=Johannes.Schindelin@gmx.de \
    --cc=Matthieu.Moy@imag.fr \
    --cc=chriscool@tuxfamily.org \
    --cc=dirson@bertin.fr \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=kevin@sb.org \
    --cc=nicolas.s.dev@gmx.fr \
    --cc=raible@nextest.com \
    --cc=trast@student.ethz.ch \
    /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).