]> git.ipfire.org Git - thirdparty/git.git/commit - builtin/bisect.c
doc/git-bisect: clarify `git bisect run` syntax
authorJavier Mora <cousteaulecommandant@gmail.com>
Mon, 23 Oct 2023 19:23:10 +0000 (19:23 +0000)
committerJunio C Hamano <gitster@pobox.com>
Mon, 23 Oct 2023 20:04:47 +0000 (13:04 -0700)
commit3f02785de9f6db28fec17e7100f70665e725b7c5
tree30e2bb7ba8a5d4a3f8bdaedc0f475eaddb893d73
parentceadf0f3cf51550166a387ec8508bb55e7883057
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 <cmd>...`, which isn't quite clear
about what `<cmd>` 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 <cmd> [<arg>...]` 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 <cousteaulecommandant@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-bisect.txt
builtin/bisect.c