git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Thomas Gummerer <t.gummerer@gmail.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org, "Stephan Beyer" <s-beyer@gmx.net>,
	"Marc Strapetz" <marc.strapetz@syntevo.com>,
	"Jeff King" <peff@peff.net>,
	"Johannes Schindelin" <Johannes.Schindelin@gmx.de>,
	"Øyvind A. Holm" <sunny@sunbase.org>,
	"Jakub Narębski" <jnareb@gmail.com>
Subject: Re: [PATCH v2 1/4] Documentation/stash: remove mention of git reset --hard
Date: Sun, 5 Feb 2017 12:13:47 +0000	[thread overview]
Message-ID: <20170205121346.GH31189@hank> (raw)
In-Reply-To: <xmqq7f5cuu8l.fsf@gitster.mtv.corp.google.com>

On 01/30, Junio C Hamano wrote:
> Thomas Gummerer <t.gummerer@gmail.com> writes:
> 
> > Don't mention git reset --hard in the documentation for git stash save.
> > It's an implementation detail that doesn't matter to the end user and
> > thus shouldn't be exposed to them.
> 
> Everybody understands what "reset --hard" does; it can be an
> easier-to-read "short-hand" description to say "reset --hard"
> instead of giving a lengthy description of what happens.

While this is definitely true for experienced git users, it might not
be for some people relatively new to git, which are probably the ones
that need the description most.

> Because of that, I do not necessarily agree with the above
> justification.  I'll read the remainder of the series before
> commenting further on the above.
> 
> > diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt
> > index 2e9cef06e6..0fc23c25ee 100644
> > --- a/Documentation/git-stash.txt
> > +++ b/Documentation/git-stash.txt
> > @@ -47,8 +47,9 @@ OPTIONS
> >  
> >  save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [<message>]::
> >  
> > -	Save your local modifications to a new 'stash', and run `git reset
> > -	--hard` to revert them.  The <message> part is optional and gives
> > +	Save your local modifications to a new 'stash' and roll them
> > +	back both in the working tree and in the index.
> 
> "... roll them back both ..." is unclear where they are rolled back
> to.  
> 
> Perhaps "roll them back ... to HEAD" or something?

Yeah that makes sense, thanks.

-- 
Thomas

  reply	other threads:[~2017-02-05 12:13 UTC|newest]

Thread overview: 57+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-01-21 20:08 [PATCH 0/3] stash: support filename argument Thomas Gummerer
2017-01-21 20:08 ` [PATCH 1/3] Documentation/stash: remove mention of git reset --hard Thomas Gummerer
2017-01-22  1:27   ` Øyvind A. Holm
2017-01-24 19:51   ` Jakub Narębski
2017-01-24 20:14   ` Jeff King
2017-01-25 13:02     ` Jakub Narębski
2017-01-25 21:20       ` Junio C Hamano
2017-01-25 21:20     ` Junio C Hamano
2017-01-28 19:30       ` Thomas Gummerer
2017-01-28 23:54         ` Jeff King
2017-01-21 20:08 ` [PATCH 2/3] stash: introduce push verb Thomas Gummerer
2017-01-23 18:27   ` Junio C Hamano
2017-01-29 12:39     ` Thomas Gummerer
2017-01-21 20:08 ` [PATCH 3/3] stash: support filename argument Thomas Gummerer
2017-01-23 18:50   ` Junio C Hamano
2017-01-29 13:29     ` Thomas Gummerer
2017-01-24 10:56 ` [PATCH 0/3] " Johannes Schindelin
2017-01-29 20:16 ` [PATCH v2 0/4] stash: create " Thomas Gummerer
2017-01-29 20:16   ` [PATCH v2 1/4] Documentation/stash: remove mention of git reset --hard Thomas Gummerer
2017-01-30 21:13     ` Junio C Hamano
2017-02-05 12:13       ` Thomas Gummerer [this message]
2017-01-29 20:16   ` [PATCH v2 2/4] stash: introduce push verb Thomas Gummerer
2017-01-30 21:12     ` Junio C Hamano
     [not found]     ` <xmqqy3xsux4g.fsf@gitster.mtv.corp.google.com>
2017-02-04 12:19       ` Thomas Gummerer
2017-01-29 20:16   ` [PATCH v2 3/4] introduce new format for git stash create Thomas Gummerer
2017-01-30 21:10     ` Junio C Hamano
     [not found]     ` <xmqqtw8guwfm.fsf@gitster.mtv.corp.google.com>
2017-02-04 13:18       ` Thomas Gummerer
2017-01-29 20:16   ` [PATCH v2 4/4] stash: support filename argument Thomas Gummerer
2017-01-30 21:11     ` Junio C Hamano
2017-02-05 11:02       ` Thomas Gummerer
2017-02-05 20:26   ` [PATCH v3 0/5] stash: support pathspec argument Thomas Gummerer
2017-02-05 20:26     ` [PATCH v3 1/5] Documentation/stash: remove mention of git reset --hard Thomas Gummerer
2017-02-06 15:22       ` Jeff King
2017-02-05 20:26     ` [PATCH v3 2/5] stash: introduce push verb Thomas Gummerer
2017-02-06 15:46       ` Jeff King
2017-02-11 13:33         ` Thomas Gummerer
     [not found]       ` <vpqlgtaz09q.fsf@anie.imag.fr>
2017-02-13 22:16         ` Thomas Gummerer
2017-02-05 20:26     ` [PATCH v3 3/5] stash: add test for the create command line arguments Thomas Gummerer
2017-02-06 15:50       ` Jeff King
2017-02-11 13:55         ` Thomas Gummerer
2017-02-05 20:26     ` [PATCH v3 4/5] stash: introduce new format create Thomas Gummerer
2017-02-06 15:56       ` Jeff King
2017-02-11 14:51         ` Thomas Gummerer
2017-02-13 21:57           ` Jeff King
2017-02-13 23:05             ` Jeff King
2017-02-14 21:30               ` Thomas Gummerer
2017-02-05 20:26     ` [PATCH v3 5/5] stash: teach 'push' (and 'create') to honor pathspec Thomas Gummerer
     [not found]       ` <xmqqmvdz3ied.fsf@gitster.mtv.corp.google.com>
2017-02-06 15:20         ` Jeff King
2017-02-11 16:50         ` Thomas Gummerer
2017-02-06 16:14     ` [PATCH v3 0/5] stash: support pathspec argument Jeff King
2017-02-12 19:30       ` Thomas Gummerer
     [not found]         ` <vpq7f4uxjmo.fsf@anie.imag.fr>
2017-02-13 20:09           ` Jeff King
     [not found]             ` <vpqo9y5lqos.fsf@anie.imag.fr>
2017-02-13 21:45               ` Jeff King
2017-02-13 22:33                 ` Thomas Gummerer
     [not found]                   ` <xmqqwpctabvw.fsf@gitster.mtv.corp.google.com>
2017-02-14  0:27                     ` Jeff King
     [not found]                       ` <xmqqpoila9rt.fsf@gitster.mtv.corp.google.com>
2017-02-14  0:37                         ` Jeff King
     [not found]                   ` <vpq60kdjl63.fsf@anie.imag.fr>
2017-02-14 21:36                     ` Thomas Gummerer

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=20170205121346.GH31189@hank \
    --to=t.gummerer@gmail.com \
    --cc=Johannes.Schindelin@gmx.de \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=jnareb@gmail.com \
    --cc=marc.strapetz@syntevo.com \
    --cc=peff@peff.net \
    --cc=s-beyer@gmx.net \
    --cc=sunny@sunbase.org \
    /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).