From 47ac5f6e1a0125965f6907dc55c130615cf131e1 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Wed, 7 Feb 2024 13:44:35 -0800 Subject: bisect: document "terms" subcommand more fully The documentation for "git bisect terms", although it did not hide any information, was a bit incomplete and forced readers to fill in the blanks to get the complete picture. Acked-by: Matthieu Moy Signed-off-by: Junio C Hamano --- Documentation/git-bisect.txt | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/Documentation/git-bisect.txt b/Documentation/git-bisect.txt index fbb39fbdf5..3d813f9c77 100644 --- a/Documentation/git-bisect.txt +++ b/Documentation/git-bisect.txt @@ -20,7 +20,7 @@ on the subcommand: [--no-checkout] [--first-parent] [ [...]] [--] [...] git bisect (bad|new|) [] git bisect (good|old|) [...] - git bisect terms [--term-good | --term-bad] + git bisect terms [--term-(good|old) | --term-(bad|new)] git bisect skip [(|)...] git bisect reset [] git bisect (visualize|view) @@ -165,8 +165,10 @@ To get a reminder of the currently used terms, use git bisect terms ------------------------------------------------ -You can get just the old (respectively new) term with `git bisect terms ---term-old` or `git bisect terms --term-good`. +You can get just the old term with `git bisect terms --term-old` +or `git bisect terms --term-good`; `git bisect terms --term-new` +and `git bisect terms --term-bad` can be used to learn how to call +the commits more recent than the sought change. If you would like to use your own terms instead of "bad"/"good" or "new"/"old", you can choose any names you like (except existing bisect -- cgit 1.2.3-korg From 841dbd40a350b6bde402ca36a56c815f13f20480 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Wed, 7 Feb 2024 13:44:36 -0800 Subject: bisect: document command line arguments for "bisect start" The syntax commonly used for alternatives is --opt-(a|b), not --opt-{a,b}. List bad/new and good/old consistently in this order, to be consistent with the description for "git bisect terms". Clarify to either or to make them consistent with the description of "git bisect (good|bad)" subcommands. Suggested-by: Matthieu Moy Signed-off-by: Junio C Hamano --- 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 3d813f9c77..73f889b97b 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-(bad|new)= --term-(good|old)=] [--no-checkout] [--first-parent] [ [...]] [--] [...] git bisect (bad|new|) [] git bisect (good|old|) [...] -- cgit 1.2.3-korg