public inbox for git@vger.kernel.org 
 help / color / mirror / Atom feed
From: Nanako Shiraishi <nanako3@lavabit•com>
To: Felipe Contreras <felipe.contreras@gmail•com>
Cc: Michael J Gruber <git@drmicha•warpmail.net>,
	Jonathan Nieder <jrnieder@gmail•com>,
	Junio C Hamano <gitster@pobox•com>,
	git@vger•kernel.org, "J. Bruce Fields" <bfields@fieldses•org>,
	Hannu Koivisto <azure@iki•fi>, Jeff King <peff@peff•net>,
	Wincent Colaiuta <win@wincent•com>,
	Matthias Lederhofer <matled@gmx•net>
Subject: Re: [PATCH v2 0/2] user-manual: new "getting started" section
Date: Tue, 17 Nov 2009 21:06:25 +0900	[thread overview]
Message-ID: <20091117210625.6117@nanako3.lavabit.com> (raw)
In-Reply-To: <94a0d4530911161452xe82858el322a1985341bf13c@mail.gmail.com>

Quoting Felipe Contreras <felipe.contreras@gmail•com>

> On Fri, Nov 13, 2009 at 11:06 PM, Nanako Shiraishi <nanako3@lavabit•com> wrote:
>> ... I don't
>> think Felipe seriously wants to change them to --gogo vs --dance, but
>> if he made a more constructive proposal, instead of making such a
>> comment whose intended effect is only to annoy people, we may see
>> an improved UI at the end.  Proposing "--index-only" vs "--index-too"
>> or even "--stage-only" vs "--stage-too" would have helped him appear
>> to be more serious and constructive and I think your expression
>> "mismatching participants" was a great way to say this.
>
> Right, your explanation is more clear:

You have a funny way of saying "I'm sorry, I wasn't constructive, 
and my attitude repelled many participants from the discussion".

> the fact that we need both
> doesn't mean we cannot use the term "stage". As to "constructive
> proposal" I deliberately tried to avoid them in case somebody tried to
> disregard it as bike-shedding, and move on.

If the only constructive proposal you could make is to replace 
words used in two operations without clarifying concepts any 
better to newbies, then what you are doing is bike-shedding. 
I don't think trying to hide that by not making any proposal 
changes that.

> What I'm trying to do is
> bring up the issue that the stage is not user friendly.

I thought you were the one who wanted to use "stage" everywhere?

For what it's worth, "stage" isn't very user friendly to me; 
maybe it is because I'm not a native English speaker. I'm not 
saying that when I hear "index" or "cached" I'll understand 
what they mean even if I didn't have any prior knowledge of 
git, but I am saying "stage" isn't any better than these two 
words in that respect. Of course the user needs to understand 
what it is and how it is used, no matter what word you use.

I think a proposal to replace the word "index" with "stage" 
will sound nothing but bike-shedding to anybody, especially 
after getting familiar with "index" and seeing it taught on 
many web pages and books.

> I like David Kågedal's suggestion more:
> http://kerneltrap.org/mailarchive/git/2008/10/29/3857134

For people who like a usable threaded interface to read 
the message in context here is its URL.

http://thread.gmane.org/gmane.comp.version-control.git/99332/focus=99401

Yes, I had David's proposal in mind when I wrote my response. 
Even though the fundamental idea is the same, I used --X-vs-Y 
option to avoid the problems David's proposal has in a slightly 
nicer way.

David's proposal introduced two magic tokens STAGE and WORKTREE.

  git diff STAGE WORKTREE   (like "git diff" today)
  git diff HEAD WORKTREE    (like "git diff HEAD" today)
  git diff WORKTREE HEAD    (like "git diff -R HEAD" today)
  git diff HEAD STAGE       (like "git diff --cached" today)
  git diff commit STAGE     (like "git diff --cached commit" today)

This looks nice on surface, but I think the apparent niceness 
is shallow. If of course has a small problem of introducing an 
obvious backward incompatibility. You can't use a branch whose 
name is STAGE anymore, but a deeper problem is that these two 
magic tokens pretend to be refs. But they do so only to the diff 
command. I don't see how you can make them sanely be usable to 
other commands like "git log v1.0.0..WORKTREE".

-- 
Nanako Shiraishi
http://ivory.ap.teacup.com/nanako3/

  reply	other threads:[~2009-11-17 12:06 UTC|newest]

Thread overview: 28+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-10-24  9:44 [PATCH v2 0/2] user-manual: new "getting started" section Felipe Contreras
2009-10-24  9:44 ` [PATCH v2 1/2] user-manual: add global config section Felipe Contreras
2009-10-24  9:44 ` [PATCH v2 2/2] user-manual: simplify the user configuration Felipe Contreras
2009-10-24 13:06 ` [PATCH v2 0/2] user-manual: new "getting started" section Nanako Shiraishi
2009-10-24 14:08   ` Felipe Contreras
2009-10-24 14:14     ` Björn Steinbrink
2009-10-24 14:22       ` Felipe Contreras
2009-10-24 17:51 ` Junio C Hamano
2009-10-24 18:19   ` Junio C Hamano
2009-10-24 20:16     ` Felipe Contreras
2009-10-25  0:26       ` J. Bruce Fields
2009-10-25  3:08       ` Junio C Hamano
2009-10-25  9:43         ` Felipe Contreras
2009-10-25 11:14           ` Jonathan Nieder
2009-11-11 23:15             ` Felipe Contreras
2009-11-12 11:29               ` Michael J Gruber
2009-11-12 20:04                 ` Felipe Contreras
2009-11-13 21:06                 ` Nanako Shiraishi
2009-11-16 22:52                   ` Felipe Contreras
2009-11-17 12:06                     ` Nanako Shiraishi [this message]
2009-11-17 17:28                       ` J. Bruce Fields
2009-11-17 18:25                         ` Junio C Hamano
2009-11-17 22:00                           ` Felipe Contreras
2009-11-17 22:19                             ` Junio C Hamano
2009-11-17 23:06                               ` Felipe Contreras
2009-11-17 23:13                                 ` Junio C Hamano
2009-11-18  0:05                                   ` Felipe Contreras
2009-11-17 17:53                       ` 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

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

  git send-email \
    --in-reply-to=20091117210625.6117@nanako3.lavabit.com \
    --to=nanako3@lavabit$(echo .)com \
    --cc=azure@iki$(echo .)fi \
    --cc=bfields@fieldses$(echo .)org \
    --cc=felipe.contreras@gmail$(echo .)com \
    --cc=git@drmicha$(echo .)warpmail.net \
    --cc=git@vger$(echo .)kernel.org \
    --cc=gitster@pobox$(echo .)com \
    --cc=jrnieder@gmail$(echo .)com \
    --cc=matled@gmx$(echo .)net \
    --cc=peff@peff$(echo .)net \
    --cc=win@wincent$(echo .)com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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