cat-file doc: document that -e will return some output
authorÆvar Arnfjörð Bjarmason <avarab@gmail.com>
Wed, 10 Jan 2018 12:55:53 +0000 (12:55 +0000)
committerJunio C Hamano <gitster@pobox.com>
Wed, 10 Jan 2018 23:08:14 +0000 (15:08 -0800)
commit9bd2ce543298c9b2f1a6d1bb8ffef18295ccfec7
treea963d90de9ef70e65930dfc3540b6bbaaa36eea5
parent3013dff8662eae06457fe6e5348dfe2270810ab2
cat-file doc: document that -e will return some output

The -e option added in 7950571ad7 ("A few more options for
git-cat-file", 2005-12-03) has always errored out with message on
stderr saying that the provided object is malformed, like this:

    $ git cat-file -e malformed; echo $?
    fatal: Not a valid object name malformed
    128

A reader of this documentation may be misled into thinking that

    if ! git cat-file -e "$object" [...]

as opposed to:

    if ! git cat-file -e "$object" 2>/dev/null [...]

is sufficient to implement a truly silent test that checks whether
some arbitrary $object string was both valid, and pointed to an
object that exists.

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-cat-file.txt