From: Junio C Hamano <gitster@pobox.com>
Date: Sat, 01 Oct 2022 18:51:59 GMT
Subject: Re: [PATCH v3 24/36] doc txt & -h consistency: make "bundle" consistent
Message-ID: <xmqqbkqv2x80.fsf@gitster.g>
In-Reply-To: <patch-v3-24.36-7f93da79fee-20220930T180415Z-avarab@gmail.com>

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

> Amend the -h output to match that of the *.txt output, the differences
> were fairly small. In the case of "[<options>]" we only have a few of
> them, so let's exhaustively list them as in the *.txt.
>
> Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
> ---
>  builtin/bundle.c | 7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)
>
> diff --git a/builtin/bundle.c b/builtin/bundle.c
> index 1b08700bf9e..544c78a5f3a 100644
> --- a/builtin/bundle.c
> +++ b/builtin/bundle.c
> @@ -12,13 +12,14 @@
>   */
>  
>  #define BUILTIN_BUNDLE_CREATE_USAGE \
> -	N_("git bundle create [<options>] <file> <git-rev-list args>")
> +	N_("git bundle create [-q | --quiet | --progress | --all-progress] [--all-progress-implied]\n" \
> +	   "                  [--version=<version>] <file> <git-rev-list-args>")

This looks like getting a bit on the longer side.  I think keeping
the original would be a far better option IF we can give the list of
options and their explanations like usage_with_options() does, and I
also think it would be the right thing in the longer term.  As an
intermediate state before getting there, I do not think the
postimage of this patch hurts, but is one more thing we need to
maintain and get distracted.  So, I dunno.

>  #define BUILTIN_BUNDLE_VERIFY_USAGE \
> -	N_("git bundle verify [<options>] <file>")
> +	N_("git bundle verify [-q | --quiet] <file>")
>  #define BUILTIN_BUNDLE_LIST_HEADS_USAGE \
>  	N_("git bundle list-heads <file> [<refname>...]")
>  #define BUILTIN_BUNDLE_UNBUNDLE_USAGE \
> -	N_("git bundle unbundle <file> [<refname>...]")
> +	N_("git bundle unbundle [--progress] <file> [<refname>...]")
>  
>  static char const * const builtin_bundle_usage[] = {
>  	BUILTIN_BUNDLE_CREATE_USAGE,