From: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com> To: git@vger.kernel.org Cc: "Junio C Hamano" <gitster@pobox.com>, "H . Peter Anvin" <hpa@zytor.com>, "Ævar Arnfjörð Bjarmason" <avarab@gmail.com> Subject: [PATCH 1/2] cat-file doc: document that -e will return some output Date: Wed, 10 Jan 2018 12:55:53 +0000 [thread overview] Message-ID: <20180110125554.12582-2-avarab@gmail.com> (raw) In-Reply-To: <20180110125554.12582-1-avarab@gmail.com> 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" [...] 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(-) diff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt index fb09cd69d6..f90f09b03f 100644 --- a/Documentation/git-cat-file.txt +++ b/Documentation/git-cat-file.txt @@ -42,8 +42,9 @@ OPTIONS <object>. -e:: - Suppress all output; instead exit with zero status if <object> - exists and is a valid object. + Exit with zero status if <object> exists and is a valid + object. If <object> is of an invalid format exit with non-zero and + emits an error on stderr. -p:: Pretty-print the contents of <object> based on its type. @@ -168,7 +169,7 @@ If `-t` is specified, one of the <type>. If `-s` is specified, the size of the <object> in bytes. -If `-e` is specified, no output. +If `-e` is specified, no output, unless the <object> is malformed. If `-p` is specified, the contents of <object> are pretty-printed. -- 2.15.1.424.g9478a66081
next prev parent reply other threads:[~2018-01-10 12:58 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 ` Ævar Arnfjörð Bjarmason [this message] 2018-01-10 21:38 ` [PATCH 1/2] cat-file doc: document that -e will return some output Junio C Hamano 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=20180110125554.12582-2-avarab@gmail.com \ --to=avarab@gmail.com \ --cc=git@vger.kernel.org \ --cc=gitster@pobox.com \ --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).