git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Recent documentation patches, and an RFC on terminology

From
EREric Raymond <esr@snark.thyrsus.com>
Date
Apr 23, 2010, 21:54 UTC
Message-ID
<20100423215448.1EF5B479E92@snark.thyrsus.com>

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).

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.

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.

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.

If this proposal is accepted, I can very easly generate a patch to implement it. Teasing apart "index" from "staging area" was actual work, but now that the distinction has been made replacing the latter would be trivial.

-- 
		<a href="http://www.catb.org/~esr/">Eric S. Raymond</a>

The politician attempts to remedy the evil by increasing the very thing
that caused the evil in the first place: legal plunder.
	-- Frederick Bastiat
Next: Björn Steinbrink
Message 1 of 8 in “Recent documentation patches, and an RFC on terminology”
  1. Eric RaymondApr 23, 2010
  2. Björn SteinbrinkApr 23, 2010
  3. Eric RaymondApr 23, 2010
  4. Nicolas PitreApr 23, 2010
  5. Junio C HamanoApr 24, 2010
  6. Nicolas PitreApr 24, 2010
  7. Adam BrewsterApr 24, 2010
  8. AghilesApr 25, 2010

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.