git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH] doc/git-bisect: clarify `git bisect run` syntax

From
CGcousteau via GitGitGadget <gitgitgadget@gmail.com>
Date
Oct 22, 2023, 20:02 UTC
Message-ID
<pull.1602.git.1698004968582.gitgitgadget@gmail.com>
From: Javier Mora <cousteaulecommandant@gmail.com>

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.
Signed-off-by: Javier Mora <cousteaulecommandant@gmail.com>
---
    doc/git-bisect: clarify git bisect run syntax
    
    I saw someone in IRC wondering about the syntax for git bisect run for a
    command with arguments, and found that its short description at the
    beginning of the manpage is not very clear (although it gets clarified
    later when it is properly described). It describes the syntax as git
    bisect run <cmd>... which is a bit confusing; it should say git bisect
    run <cmd> [<arg>...], otherwise it somehow looks like you have to "enter
    one or more commands", and that each command is a single argument.
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1602%2Fcousteaulecommandant%2Fman-git-bisect-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1602/cousteaulecommandant/man-git-bisect-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/1602
 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 7872dba3aef..19bbed49238 100644
--- a/Documentation/git-bisect.txt
+++ b/Documentation/git-bisect.txt
@@ -26,7 +26,7 @@ on the subcommand:
  git bisect (visualize|view)
  git bisect replay <logfile>
  git bisect log
- git bisect run <cmd>...
+ git bisect run <cmd> [<arg>...]
  git bisect help
 
 This command uses a binary search algorithm to find which commit in

base-commit: ceadf0f3cf51550166a387ec8508bb55e7883057
-- 
gitgitgadget
Next: Eric Sunshine
Message 1 of 12 in “doc/git-bisect: clarify `git bisect run` syntax”
  1. doc/git-bisect: clarify `git bisect run` syntaxcousteau via GitGitGadget, Oct 22, 2023
  2. Eric SunshineOct 22, 2023
  3. Junio C HamanoOct 23, 2023
  4. Patrick SteinhardtOct 23, 2023
  5. Javier MoraOct 23, 2023
  6. Junio C HamanoOct 23, 2023
  7. Junio C HamanoOct 23, 2023
  8. doc/git-bisect: clarify `git bisect run` syntaxcousteau via GitGitGadget, Oct 23, 2023
  9. Eric SunshineOct 23, 2023
  10. Javier MoraOct 23, 2023
  11. Eric SunshineOct 23, 2023
  12. Junio C HamanoOct 24, 2023

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.