Re: git-diff-index man page

From: Junio C Hamano <gitster@pobox.com>
Date: May 19, 2013, 07:46 UTC
Message-ID: <7vhahzza2v.fsf@alter.siamese.dyndns.org>
In-Reply-To: <CAKEGsXQDB1=hizNqM6D=uuP6PXT4ytUiTgB5fvO-gVSsPqQkLQ@mail.gmail.com>

Albert Netymk <albertnetymk@gmail.com> writes:

Show 15 quoted lines

> Hello,
>
> The man page of git-diff-index:
> http://git-scm.com/docs/git-diff-index
> states that
> `git-diff-index - Compares content and mode of blobs between the index
> and repository`.
>
> However, in fact this command compares between files on disk and
> repository by default. It's explained clearly in here:
> http://git-scm.com/docs/gitdiffcore
>
> Maybe the man page could be updated to reflect this in NAME section:
> `git-diff-index - Compares content and mode of blobs between files on
> disk and repository or between the index and repository`

Surely; we need to keep it fit on a single line, though.

> In DESCRIPTION section:
> `Compares the content and mode of the blobs found via a tree object
> with the content of the files on disk by default, and could be
> compared with index only using cached option. ...`

Yes, mentioning both mode is a good change. The above exact text may give a false impression (with that "by default") that it is somehow more preferrable to compare tree with working tree through the index, and only weirdos would use "--cached" to compare tree and the index, though.

Patches welcome.  Thanks.