git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Michael J Gruber <git@drmicha.warpmail.net>
To: Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org, Christian Couder <chriscool@tuxfamily.org>
Subject: Re: [PATCH 6/6] git-reset.txt: make modes description more consistent
Date: Wed, 15 Sep 2010 22:47:27 +0200	[thread overview]
Message-ID: <4C9130DF.70303@drmicha.warpmail.net> (raw)
In-Reply-To: <7vd3sh9n7l.fsf@alter.siamese.dyndns.org>

Thanks for all your hints and thoughts. I'll be sending a v2 in a
minute. There's just one point where I chose not to follow completely
for now:

Junio C Hamano venit, vidit, dixit 14.09.2010 02:35:
> Michael J Gruber <git@drmicha.warpmail.net> writes:
[snip]
>> @@ -57,22 +58,30 @@ linkgit:git-add[1]).
>>  	been updated. This is the default action.
>>  
>>  --hard::
>> -	Matches the working tree and index to that of the tree being
>> -	switched to. Any changes to tracked files in the working tree
>> -	since <commit> are lost.
>> +	Resets the index and working tree. Any changes to tracked files in the
>> +	working tree since <commit> are lost.
> 
> Explaining what "reset" does using the undefined word "reset" smells
> somewhat wrong.  Not that "matches" is any better, but at least the
> original says "to that of the tree", which you seem to have lost, so there
> is no indication what they are reset _to_.  I don't think the above is a
> good change for this reason.

The idea was to define "reset" once (in the paragraph right before the
list of modes) and then use it without repeating that. I tried to make
this a bit clearer now by emphasising the term "reset" more in the
leading paragraph.

[snip]
> It may be just me, but "unstaged" sounds as if you once have staged and
> then changed your mind and took it back.  "... which have changes that
> haven't been added" might be clearer.

We use "unstaged" in the meaning of "not staged/added yet" in other
places, as well - but in surprisingly few I have to admit! I went with
your version here.

Michael

  reply	other threads:[~2010-09-15 20:47 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-09-13  8:06 [PATCH 0/6] git-reset.txt improvements Michael J Gruber
2010-09-13  8:06 ` [PATCH 1/6] git-reset.txt: clarify branch vs. branch head Michael J Gruber
2010-09-14  0:35   ` Junio C Hamano
2010-09-13  8:06 ` [PATCH 2/6] git-reset.txt: reset does not change files in target Michael J Gruber
2010-09-14  0:12   ` Junio C Hamano
2010-09-13  8:06 ` [PATCH 3/6] git-reset.txt: reset --soft is not a no-op Michael J Gruber
2010-09-13 22:13   ` Jay Soffian
2010-09-13 23:19     ` Junio C Hamano
2010-09-13  8:06 ` [PATCH 4/6] git-reset.txt: use "working tree" consistently Michael J Gruber
2010-09-13  8:06 ` [PATCH 5/6] git-reset.txt: point to git-checkout Michael J Gruber
2010-09-14  0:19   ` Junio C Hamano
2010-09-13  8:06 ` [PATCH 6/6] git-reset.txt: make modes description more consistent Michael J Gruber
2010-09-14  0:35   ` Junio C Hamano
2010-09-15 20:47     ` Michael J Gruber [this message]
2010-09-13 22:15 ` [PATCH 0/6] git-reset.txt improvements Jay Soffian
2010-09-15 20:47 ` [PATCHv2 " Michael J Gruber
2010-09-15 20:47   ` [PATCHv2 1/6] git-reset.txt: clarify branch vs. branch head Michael J Gruber
2010-09-15 20:47   ` [PATCHv2 2/6] git-reset.txt: reset does not change files in target Michael J Gruber
2010-09-15 20:47   ` [PATCHv2 3/6] git-reset.txt: reset --soft is not a no-op Michael J Gruber
2010-09-15 20:47   ` [PATCHv2 4/6] git-reset.txt: use "working tree" consistently Michael J Gruber
2010-09-15 20:47   ` [PATCHv2 5/6] git-reset.txt: point to git-checkout Michael J Gruber
2010-09-15 20:47   ` [PATCHv2 6/6] git-reset.txt: make modes description more consistent Michael J Gruber

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

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

  git send-email \
    --in-reply-to=4C9130DF.70303@drmicha.warpmail.net \
    --to=git@drmicha.warpmail.net \
    --cc=chriscool@tuxfamily.org \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.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.
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 NNTP newsgroup(s).