From bb42dc971074ebe83697943b364350e19e4c0911 Mon Sep 17 00:00:00 2001 From: Ruoyu Zhong Date: Tue, 28 Oct 2025 22:27:41 +0000 Subject: bisect: update usage and docs to match each other Update the usage string of `git bisect` and documentation to match each other. While at it, also: 1. Move the synopsis of `git bisect` subcommands to the synopsis section, so that the test `t0450-txt-doc-vs-help.sh` can pass. 2. Document the `git bisect next` subcommand, which exists in the code but is missing from the documentation. See also: [1]. [1]: https://lore.kernel.org/git/3DA38465-7636-4EEF-B074-53E4628F5355@gmail.com/ Suggested-by: Ben Knoble Signed-off-by: Ruoyu Zhong Signed-off-by: Junio C Hamano --- Documentation/git-bisect.adoc | 43 ++++++++++++++++++++++++++----------------- 1 file changed, 26 insertions(+), 17 deletions(-) (limited to 'Documentation') diff --git a/Documentation/git-bisect.adoc b/Documentation/git-bisect.adoc index 58dbb74a15..b0078dda0e 100644 --- a/Documentation/git-bisect.adoc +++ b/Documentation/git-bisect.adoc @@ -9,26 +9,22 @@ git-bisect - Use binary search to find the commit that introduced a bug SYNOPSIS -------- [verse] -'git bisect' +'git bisect' start [--term-(bad|new)= --term-(good|old)=] + [--no-checkout] [--first-parent] [ [...]] [--] [...] +'git bisect' (bad|new|) [] +'git bisect' (good|old|) [...] +'git bisect' terms [--term-(good|old) | --term-(bad|new)] +'git bisect' skip [(|)...] +'git bisect' next +'git bisect' reset [] +'git bisect' (visualize|view) +'git bisect' replay +'git bisect' log +'git bisect' run [...] +'git bisect' help DESCRIPTION ----------- -The command takes various subcommands, and different options depending -on the subcommand: - - git bisect start [--term-(bad|new)= --term-(good|old)=] - [--no-checkout] [--first-parent] [ [...]] [--] [...] - git bisect (bad|new|) [] - git bisect (good|old|) [...] - git bisect terms [--term-(good|old) | --term-(bad|new)] - git bisect skip [(|)...] - git bisect reset [] - git bisect (visualize|view) - git bisect replay - git bisect log - git bisect run [...] - git bisect help - This command uses a binary search algorithm to find which commit in your project's history introduced a bug. You use it by first telling it a "bad" commit that is known to contain the bug, and a "good" @@ -295,6 +291,19 @@ $ git bisect skip v2.5 v2.5..v2.6 This tells the bisect process that the commits between `v2.5` and `v2.6` (inclusive) should be skipped. +Bisect next +~~~~~~~~~~~ + +Normally, after marking a revision as good or bad, Git automatically +computes and checks out the next revision to test. However, if you need to +explicitly request the next bisection step, you can use: + +------------ +$ git bisect next +------------ + +You might use this to resume the bisection process after interrupting it +by checking out a different revision. Cutting down bisection by giving more parameters to bisect start ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- cgit v1.2.3