From: Jeff King <peff@peff.net>
To: Christian Couder <christian.couder@gmail.com>
Cc: git@vger.kernel.org, Junio C Hamano <gitster@pobox.com>,
Christian Couder <chriscool@tuxfamily.org>
Subject: Re: [PATCH] cat-file: add missing [=<format>] to usage/synopsis
Date: Wed, 1 Jul 2020 11:03:13 -0400 [thread overview]
Message-ID: <20200701150313.GA6726@coredump.intra.peff.net> (raw)
In-Reply-To: <20200701101618.28761-1-chriscool@tuxfamily.org>
On Wed, Jul 01, 2020 at 12:16:18PM +0200, Christian Couder wrote:
> When displaying cat-file usage, the fact that a <format> can
> be specified is only visible when lookling at the --batch and
> --batch-check options which are shown like this:
>
> --batch[=<format>] show info and content of objects fed from the standard input
> --batch-check[=<format>]
> show info about objects fed from the standard input
>
> It seems more coherent and improves discovery to also show it
> on the usage line.
>
> In the documentation the DESCRIPTION tells us that "The output
> format can be overridden using the optional <format> argument",
> but we can't see the <format> argument in the SYNOPSIS above
> the description which is confusing.
Thanks, this makes sense and the patch looks good to me (it does make
the line very long, but the one above is much longer anyway).
-Peff
prev parent reply other threads:[~2020-07-01 15:03 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-07-01 10:16 [PATCH] cat-file: add missing [=<format>] to usage/synopsis Christian Couder
2020-07-01 15:03 ` Jeff King [this message]
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200701150313.GA6726@coredump.intra.peff.net \
--to=peff@peff.net \
--cc=chriscool@tuxfamily.org \
--cc=christian.couder@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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 NNTP newsgroup(s).