Re: [PATCH] pull: add angle brackets to usage string

From: Junio C Hamano <gitster@pobox.com>
Date: Oct 16, 2015, 16:36 UTC
Message-ID: <xmqqwpumg480.fsf@gitster.mtv.corp.google.com>
In-Reply-To: <1444962133-1266-1-git-send-email-alexhenrie24@gmail.com>

Alex Henrie <alexhenrie24@gmail.com> writes:

> Signed-off-by: Alex Henrie <alexhenrie24@gmail.com>
> ---

Makes sense, as all the other <placeholders> in the usage string are bracketted.

Does it make sense to do this for contrib/examples, which is the historical record, though? The first one I found with

    $ less contrib/examples/*

was this:

    #!/bin/sh

    OPTIONS_KEEPDASHDASH=t
    OPTIONS_SPEC="\
    git-checkout [options] [<branch>] [<paths>...]

and the next one (clean) follows the same pattern.

I'd discard the part of the patch for contrib/ and queue.

Thanks.

Show 30 quoted lines

>  builtin/pull.c               | 2 +-
>  contrib/examples/git-pull.sh | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/builtin/pull.c b/builtin/pull.c
> index a39bb0a..bf3fd3f 100644
> --- a/builtin/pull.c
> +++ b/builtin/pull.c
> @@ -66,7 +66,7 @@ static int parse_opt_rebase(const struct option *opt, const char *arg, int unset
>  }
>  
>  static const char * const pull_usage[] = {
> -	N_("git pull [options] [<repository> [<refspec>...]]"),
> +	N_("git pull [<options>] [<repository> [<refspec>...]]"),
>  	NULL
>  };
>  
> diff --git a/contrib/examples/git-pull.sh b/contrib/examples/git-pull.sh
> index 6b3a03f..bcf362e 100755
> --- a/contrib/examples/git-pull.sh
> +++ b/contrib/examples/git-pull.sh
> @@ -8,7 +8,7 @@ SUBDIRECTORY_OK=Yes
>  OPTIONS_KEEPDASHDASH=
>  OPTIONS_STUCKLONG=Yes
>  OPTIONS_SPEC="\
> -git pull [options] [<repository> [<refspec>...]]
> +git pull [<options>] [<repository> [<refspec>...]]
>  
>  Fetch one or more remote refs and integrate it/them with the current HEAD.
>  --