git@vger.kernel.org list mirror (unofficial, one of many)
 help / color / mirror / code / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Cc: git@vger.kernel.org, "H . Peter Anvin" <hpa@zytor.com>
Subject: Re: [PATCH 1/2] cat-file doc: document that -e will return some output
Date: Wed, 10 Jan 2018 13:38:51 -0800	[thread overview]
Message-ID: <xmqqtvvtz95g.fsf@gitster.mtv.corp.google.com> (raw)
In-Reply-To: <20180110125554.12582-2-avarab@gmail.com> (=?utf-8?B?IsOGdmFy?= =?utf-8?B?IEFybmZqw7Zyw7A=?= Bjarmason"'s message of "Wed, 10 Jan 2018 12:55:53 +0000")

Ævar Arnfjörð Bjarmason  <avarab@gmail.com> writes:

> 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, currently:
>
>     $ git cat-file -e malformed; echo $?
>     fatal: Not a valid object name malformed
>     128
>
> A careful reader of this documentation would be mislead into thinking
> the could write:
>
>     if ! git cat-file -e "$object" [...]

It is arguable if such a reader is careful or careless.  I'd rather drop
s/careful // there ;-)

> As opposed to:
>
>     if ! git cat-file -e "$object" 2>/dev/null [...]
>
> To check 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>
> ---
>  Documentation/git-cat-file.txt | 7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)

  reply	other threads:[~2018-01-10 21:38 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-01-10 12:55 [PATCH 0/2] the cat-file -e option doesn't work as documented Ævar Arnfjörð Bjarmason
2018-01-10 12:55 ` [PATCH 1/2] cat-file doc: document that -e will return some output Ævar Arnfjörð Bjarmason
2018-01-10 21:38   ` Junio C Hamano [this message]
2018-01-10 22:09     ` Junio C Hamano
2018-01-10 12:55 ` [PATCH 2/2] cat-file: -e should not emit output on stderr Ævar Arnfjörð Bjarmason
2018-01-10 20:43 ` [PATCH 0/2] the cat-file -e option doesn't work as documented Junio C Hamano
2018-01-10 20:50   ` Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqqtvvtz95g.fsf@gitster.mtv.corp.google.com \
    --to=gitster@pobox.com \
    --cc=avarab@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=hpa@zytor.com \
    --subject='Re: [PATCH 1/2] cat-file doc: document that -e will return some output' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Code repositories for project(s) associated with this inbox:

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).