From 3f02785de9f6db28fec17e7100f70665e725b7c5 Mon Sep 17 00:00:00 2001 From: Javier Mora Date: Mon, 23 Oct 2023 19:23:10 +0000 Subject: doc/git-bisect: clarify `git bisect run` syntax The description of the `git bisect run` command syntax at the beginning of the manpage is `git bisect run ...`, which isn't quite clear about what `` is or what the `...` mean; one could think that it is the whole (quoted) command line with all arguments in a single string, or that it supports multiple commands, or that it doesn't accept commands with arguments at all. Change to `git bisect run [...]` to clarify the syntax, in both the manpage and the `git bisect -h` command output. Additionally, change `--term-{new,bad}` et al to `--term-(new|bad)` for consistency with the synopsis syntax conventions. Signed-off-by: Javier Mora Signed-off-by: Junio C Hamano --- Documentation/git-bisect.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'Documentation') diff --git a/Documentation/git-bisect.txt b/Documentation/git-bisect.txt index 7872dba3ae..191b4a42b6 100644 --- a/Documentation/git-bisect.txt +++ b/Documentation/git-bisect.txt @@ -16,7 +16,7 @@ DESCRIPTION The command takes various subcommands, and different options depending on the subcommand: - git bisect start [--term-{new,bad}= --term-{old,good}=] + git bisect start [--term-(new|bad)= --term-(old|good)=] [--no-checkout] [--first-parent] [ [...]] [--] [...] git bisect (bad|new|) [] git bisect (good|old|) [...] @@ -26,7 +26,7 @@ on the subcommand: git bisect (visualize|view) git bisect replay git bisect log - git bisect run ... + git bisect run [...] git bisect help This command uses a binary search algorithm to find which commit in -- cgit v1.3-5-g45d5