From: Junio C Hamano <gitster@pobox.com>
Date: Sat, 01 Oct 2022 18:48:19 GMT
Subject: Re: [PATCH v3 23/36] doc txt & -h consistency: make "read-tree" consistent
Message-ID: <xmqqh70n2xe4.fsf@gitster.g>
In-Reply-To: <patch-v3-23.36-01e20b8e452-20220930T180415Z-avarab@gmail.com>

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

> The C version was right to use "()" in place of "[]", let's update

Incomplete description: use () in place of [] around what?

> the *.txt version accordingly, and furthermore list the *.c options in
> the same order as the *.txt.

Good.

> Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
> ---
>  Documentation/git-read-tree.txt | 2 +-
>  builtin/read-tree.c             | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt
> index b9bfdc0a319..7567955bad8 100644
> --- a/Documentation/git-read-tree.txt
> +++ b/Documentation/git-read-tree.txt
> @@ -9,7 +9,7 @@ git-read-tree - Reads tree information into the index
>  SYNOPSIS
>  --------
>  [verse]
> -'git read-tree' [[-m [--trivial] [--aggressive] | --reset | --prefix=<prefix>]
> +'git read-tree' [(-m [--trivial] [--aggressive] | --reset | --prefix=<prefix>)
>  		[-u | -i]] [--index-output=<file>] [--no-sparse-checkout]
>  		(--empty | <tree-ish1> [<tree-ish2> [<tree-ish3>]])
>  
> diff --git a/builtin/read-tree.c b/builtin/read-tree.c
> index b3a389e1b1f..f4cbe460b97 100644
> --- a/builtin/read-tree.c
> +++ b/builtin/read-tree.c
> @@ -39,7 +39,7 @@ static int list_tree(struct object_id *oid)
>  
>  static const char * const read_tree_usage[] = {
>  	N_("git read-tree [(-m [--trivial] [--aggressive] | --reset | --prefix=<prefix>)\n"
> -	   "              [-u | -i]] [--no-sparse-checkout] [--index-output=<file>]\n"
> +	   "              [-u | -i]] [--index-output=<file>] [--no-sparse-checkout]\n"
>  	   "              (--empty | <tree-ish1> [<tree-ish2> [<tree-ish3>]])"),
>  	NULL
>  };