* [PATCH 1/1] doc: use singular form of repeatable path arg [not found] <20231227205340.9886-1-britton.kerin@gmail.com> @ 2023-12-27 20:53 ` Britton Leo Kerin 2023-12-27 22:29 ` Eric Sunshine 0 siblings, 1 reply; 3+ messages in thread From: Britton Leo Kerin @ 2023-12-27 20:53 UTC (permalink / raw) To: git; +Cc: Britton Leo Kerin, Britton L Kerin 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(-) 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 ^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH 1/1] doc: use singular form of repeatable path arg 2023-12-27 20:53 ` [PATCH 1/1] doc: use singular form of repeatable path arg Britton Leo Kerin @ 2023-12-27 22:29 ` Eric Sunshine 2023-12-28 0:10 ` Junio C Hamano 0 siblings, 1 reply; 3+ messages in thread From: Eric Sunshine @ 2023-12-27 22:29 UTC (permalink / raw) To: Britton Leo Kerin; +Cc: git, Britton L Kerin 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> > --- > 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. ^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH 1/1] doc: use singular form of repeatable path arg 2023-12-27 22:29 ` Eric Sunshine @ 2023-12-28 0:10 ` Junio C Hamano 0 siblings, 0 replies; 3+ messages in thread From: Junio C Hamano @ 2023-12-28 0:10 UTC (permalink / raw) To: Eric Sunshine; +Cc: Britton Leo Kerin, git, Britton L Kerin Eric Sunshine <sunshine@sunshineco.com> writes: > 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? >> --- >> 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. > 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. ^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2023-12-28 0:10 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
[not found] <20231227205340.9886-1-britton.kerin@gmail.com>
2023-12-27 20:53 ` [PATCH 1/1] doc: use singular form of repeatable path arg Britton Leo Kerin
2023-12-27 22:29 ` Eric Sunshine
2023-12-28 0:10 ` Junio C Hamano
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox