threads / patch / 60664

patchdoc: use singular form of repeatable path arg

Subject: [PATCH 1/1] doc: use singular form of repeatable path arg

## tl;dr

3 messages between Dec 27, 2023 and Dec 28, 2023. Diffs are folded; open one to read it.

replies: 2people: 3as markdown or json

Britton Leo Kerin· Dec 27, 2023, 20:53 UTC · lore

This is more correct because the <path>... doc syntax already indicates that the arg is "array-type". It's how other tools do it. Finally, the later document text mentions 'path' arguments, while it doesn't mention 'paths'.

Signed-off-by: Britton L Kerin <britton.kergin@gmail.com>
---
 Documentation/git-bisect.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Show changes to Documentation/git-bisect.txt +1 −1
diff --git a/Documentation/git-bisect.txt b/Documentation/git-bisect.txt
index 191b4a42b6..58821f7e11 100644
--- a/Documentation/git-bisect.txt
+++ b/Documentation/git-bisect.txt
@@ -17,7 +17,7 @@ The command takes various subcommands, and different options depending
 on the subcommand:
 
  git bisect start [--term-(new|bad)=<term-new> --term-(old|good)=<term-old>]
-		  [--no-checkout] [--first-parent] [<bad> [<good>...]] [--] [<paths>...]
+		  [--no-checkout] [--first-parent] [<bad> [<good>...]] [--] [<path>...]
  git bisect (bad|new|<term-new>) [<rev>]
  git bisect (good|old|<term-old>) [<rev>...]
  git bisect terms [--term-good | --term-bad]

-- 
2.43.0
Eric Sunshine· Dec 27, 2023, 22:29 UTC · re: Britton Leo Kerin · lore

Re: [PATCH 1/1] doc: use singular form of repeatable path arg

On Wed, Dec 27, 2023 at 3:55 PM Britton Leo Kerin <britton.kerin@gmail.com> wrote:

> This is more correct because the <path>... doc syntax already indicates
> that the arg is "array-type".  It's how other tools do it.  Finally, the
> later document text mentions 'path' arguments, while it doesn't mention
> 'paths'.
Yep, makes sense.
Show 7 quoted lines
> Signed-off-by: Britton L Kerin <britton.kergin@gmail.com>
> ---
> diff --git a/Documentation/git-bisect.txt b/Documentation/git-bisect.txt
> @@ -17,7 +17,7 @@ The command takes various subcommands, and different options depending
>   git bisect start [--term-(new|bad)=<term-new> --term-(old|good)=<term-old>]
> -                 [--no-checkout] [--first-parent] [<bad> [<good>...]] [--] [<paths>...]
> +                 [--no-checkout] [--first-parent] [<bad> [<good>...]] [--] [<path>...]
Looking good.

In builtin/bisect.c, the "usage" string says "[<pathspec>...]" rather than "[<path>...]". Perhaps it makes sense to unify these?

Also, there are a few more documentation files that could use the "<paths>" to "<path>..." fixup (though not always in the synopsis). A 'grep' indicates that git-checkout.txt, git-diff.txt, and git-rev-list-options.txt also mention "<paths>". Those may be outside the scope of this patch, although they could easily be included, as well, or made part of a patch series if you feel inclined.

Junio C Hamano· Dec 28, 2023, 00:10 UTC · re: Eric Sunshine · lore

Re: [PATCH 1/1] doc: use singular form of repeatable path arg

Eric Sunshine <sunshine@sunshineco.com> writes:
Show 10 quoted lines
> On Wed, Dec 27, 2023 at 3:55 PM Britton Leo Kerin
> <britton.kerin@gmail.com> wrote:
>> This is more correct because the <path>... doc syntax already indicates
>> that the arg is "array-type".  It's how other tools do it.  Finally, the
>> later document text mentions 'path' arguments, while it doesn't mention
>> 'paths'.
>
> Yep, makes sense.
>
>> Signed-off-by: Britton L Kerin <britton.kergin@gmail.com>

Micronit. This should be identical to how From: line identifies the author. s/L/Leo/ should be sufficient, I presume?

Show 11 quoted lines
>> ---
>> diff --git a/Documentation/git-bisect.txt b/Documentation/git-bisect.txt
>> @@ -17,7 +17,7 @@ The command takes various subcommands, and different options depending
>>   git bisect start [--term-(new|bad)=<term-new> --term-(old|good)=<term-old>]
>> -                 [--no-checkout] [--first-parent] [<bad> [<good>...]] [--] [<paths>...]
>> +                 [--no-checkout] [--first-parent] [<bad> [<good>...]] [--] [<path>...]
>
> Looking good.
>
> In builtin/bisect.c, the "usage" string says "[<pathspec>...]" rather
> than "[<path>...]". Perhaps it makes sense to unify these?

Yup, and that would be a good thing to do in a single patch, and also it would be a good place to stop. Further clean-up you suggested below are very much worth doing, but it probably is good to leave out of this single focused fix we are reviewing here and instead be done as separate patch(es).

Thanks.
Show 6 quoted lines
> Also, there are a few more documentation files that could use the
> "<paths>" to "<path>..." fixup (though not always in the synopsis). A
> 'grep' indicates that git-checkout.txt, git-diff.txt, and
> git-rev-list-options.txt also mention "<paths>". Those may be outside
> the scope of this patch, although they could easily be included, as
> well, or made part of a patch series if you feel inclined.

← back to recent threads