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

Re: A few usability question about git diff --cached

From
PCPaolo Ciarrocchi <paolo.ciarrocchi@gmail.com>
Date
Oct 4, 2007, 13:39 UTC
Message-ID
<4d8e3fd30710040639x62d7b9cbr688aca141849212c@mail.gmail.com>
In-Reply-To
<7vy7ej9g38.fsf@gitster.siamese.dyndns.org>
On 10/4/07, Junio C Hamano <gitster@pobox.com> wrote:
Show 12 quoted lines
> Miklos Vajna <vmiklos@frugalware.org> writes:
>
> > On Thu, Oct 04, 2007 at 02:27:41PM +0200, Paolo Ciarrocchi <paolo.ciarrocchi@gmail.com> wrote:
> >> Why do we have the option "--cached" and not "--index"?
> >
> > according to glossary.txt, 'cache' is an obsolete for 'index'. probably
> > this is the reason
> >
> > probably cache.h will be never renamed to index.h, i don't know if diff
> > --cached will be ever renamed to diff --index
>
> Probably never.
Ouch!
Show 16 quoted lines
> Some commands support both --index and --cached and have
> different meanings.  For them,
>
>  * --index means work on both index and work tree;
>  * --cached means work only on index and ignore work tree.
>
> In the case of "diff --cached", the latter is exactly what's
> happening.  We do not say "git diff-index --index $commit"
> because "git diff-index" (and by extension, when you give only
> one commit to "git diff" as parameter) is all about a commit vs
> your uncommitted changes, so having you say "--index" is just
> silly.  "git diff --cached" is just a shorthand for "git diff
> --cached HEAD".  Because --cached would make sense to no other
> form of diff, its presense by definition means you are talking
> about the one-tree form of diff i.e. compare a commit with your
> uncommitted changes.

I see. But the problem is real. If we cannot solve the problem changing the code of git we'll need to avoid this kind of misunderstanding having "better" documentation.

As soon as I'll find some spare time I'll propose a patch to "A tutorial introduction to git (for version 1.5.1 or newer)".

Thanks!
Regards,
-- 
Paolo
http://paolo.ciarrocchi.googlepages.com/
http://ubuntista.blogspot.com
Previous: Junio C HamanoNext: Wincent Colaiuta
Message 9 of 20 in “A few usability question about git diff --cached”
  1. Paolo CiarrocchiOct 4, 2007
  2. Wincent ColaiutaOct 4, 2007
  3. Miles BaderOct 5, 2007
  4. Wincent ColaiutaOct 5, 2007
  5. Miles BaderOct 5, 2007
  6. Miklos VajnaOct 4, 2007
  7. Paolo CiarrocchiOct 4, 2007
  8. Junio C HamanoOct 4, 2007
  9. Paolo CiarrocchiOct 4, 2007
  10. Wincent ColaiutaOct 4, 2007
  11. Johannes SchindelinOct 4, 2007
  12. Junio C HamanoOct 4, 2007
  13. David KastrupOct 4, 2007
  14. Matthieu MoyOct 4, 2007
  15. J. Bruce FieldsOct 4, 2007
  16. Matthieu MoyOct 4, 2007
  17. J. Bruce FieldsOct 4, 2007
  18. Matthieu MoyOct 5, 2007
  19. David TweedOct 5, 2007
  20. Wincent ColaiutaOct 4, 2007

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.