On Sun, May 19, 2013 at 9:46 AM, Junio C Hamano <gits...@pobox.com> wrote:
> Albert Netymk <albertnet...@gmail.com> writes:
>> The man page of 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:
>> 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.
Here's one excerpt from man page of git-diff-index: (this is how one
line looks like)
Compares the content and mode of the blobs found via a tree object
with the content of the current index and, optionally ignoring the
stat state of
`git-diff-index - Compares content and mode of blobs between files on
disk and repository or between the index and repository`
It seems that this one is not longer than one line.
>> 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.
I am a little confused about "somehow more preferrable to compare tree
with working tree through the index". My understanding is that if
`--cached` is not used, the content of index is ignore. This command
does direct comparison between repository and working tree.
I didn't realized that the above statement implies any subjective
preference. If so, provide one objective description, please.
> Patches welcome. Thanks.
I don't know how to submit patches. Besides, the only part that is a
bit misleading is the "NAME" and "DESCRIPTION" section. Could someone
just update them?
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majord...@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html