cat-file: add missing [=<format>] to usage/synopsis
authorChristian Couder <christian.couder@gmail.com>
Wed, 1 Jul 2020 10:16:18 +0000 (12:16 +0200)
committerJunio C Hamano <gitster@pobox.com>
Wed, 1 Jul 2020 22:54:05 +0000 (15:54 -0700)
commit0172f7834a31ae7cb9873feaaaa63939352fa3ae
tree3eb1691f8fc7f00a43bbeb0a9a3c3705504e7524
parentaf6b65d45ef179ed52087e80cb089f6b2349f4ec
cat-file: add missing [=<format>] to usage/synopsis

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.

Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
Acked-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-cat-file.txt
builtin/cat-file.c