Re: Recent documentation patches, and an RFC on terminology

From: Adam Brewster <adambrewster@gmail.com>
Date: Apr 24, 2010, 16:56 UTC
Message-ID: <l2oc376da901004240956o1af1abeoea0e10a86d8ef277@mail.gmail.com>
In-Reply-To: <20100423215448.1EF5B479E92@snark.thyrsus.com>

On 4/23/10, Eric Raymond <esr@snark.thyrsus.com> wrote:

Show 6 quoted lines

> I just sent two documentation patches to the list in quick succession.
> In case they arrive out of order: the first, smaller one - modifying
> only the git-status documentation - should be applied before the
> second one (distinguishing between "staging area" and "index"
> throughout the documentation).
>

I didn't get the patch which distinguishes index vs. staging area, but I did get 'Typo fixes and minor cleanups for the big "index"/"staging area patch', so I can see some of what it did.

Based on my limited view, I think it makes things more confusing. I'd rather see references to the index be replaced with "the staging area (a.k.a. the index)" than long winded explanations like "the index is the structure used to store the content of the staging area" or "the staging area used to be called the index".

Show 8 quoted lines

> We may have an opportunity to improve on the term "staging area".  As
> I reflect on it, I think replacing that with the term "depot" might
> not be a bad idea.  In English this word has the general sense of
> "warehouse", and the more specialized connotation of a place where
> freight is temporarily held for transshipment, or where military
> supplies and recruits are mustered before field deployment.  That is,
> a depot is a particular kind of staging area.
>

To me, "depot" has connotations of transportation. A depot is a place to catch a train or a bus.

Staging area describes exactly how we use the index. An area where things are staged (prepared) to be committed.

Show 7 quoted lines

> Since these terms are so similar, why change?
>
> One reason is that --depot would be a shorter and more graceful choice
> than --staging-area as a long-form option.  It has the same letter
> count as "index", so changing command and option names to use it
> wouldn't add more typing.
>

Why not keep index as a synonym for staging area and use --index?

Show 5 quoted lines

> Another reason is that "depot" is slightly more distant from normal
> English vocabulary than "staging area" is.  When you need a word to
> co-opt as a technical term of art, thast's an advantage; it reduces
> the chances of collisions between term-of-art and normal usages.
>

I haven't seen such collisions causing problems.

Adam