From: Junio C Hamano <gitster@pobox.com>
To: Britton Kerin <britton.kerin@gmail.com>
Cc: git@vger.kernel.org, Christian Couder <chriscool@tuxfamily.org>,
Matthieu Moy <git@matthieu-moy.fr>
Subject: Re* [BUG] git-bisect man page description of terms command doesn't mention old/new support
Date: Sat, 09 Dec 2023 08:13:49 -0800 [thread overview]
Message-ID: <xmqqzfyjmk02.fsf@gitster.g> (raw)
In-Reply-To: <CAC4O8c9ieZC4SBJf54ZuTfAvnkhGuDaibBQ-m9Zw_n5VhUFPag@mail.gmail.com> (Britton Kerin's message of "Sat, 9 Dec 2023 02:58:37 -0900")
Britton Kerin <britton.kerin@gmail.com> writes:
> It's a very small issue but it seems that git bisect terms does
> support --term-old and --term-new options, however the man page says:
>
> git bisect terms [--term-good | --term-bad]
>
> The description for the start subcommand does document the support for
> the more general terms correctly:
>
> git bisect start [--term-{new,bad}=<term> --term-{old,good}=<term>]
>
> so maybe it's worth fixing the git bisect terms documentation.
In the description, we see
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`.
so you could read that
git bisect terms --term-good
git bisect terms --term-old
are the same thing, and when you squint your eyes, you can probably
guess that
git bisect terms --term-bad
git bisect terms --term-new
are the same. But I agree that the documentation should not force
you to guess. This dates back to 21b55e33 (bisect: add 'git bisect
terms' to view the current terms, 2015-06-29).
------------ >8 ------------ >8 ------------ >8 ------------
Subject: [PATCH] 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.
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
Documentation/git-bisect.txt | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git c/Documentation/git-bisect.txt w/Documentation/git-bisect.txt
index 191b4a42b6..16daa09c78 100644
--- c/Documentation/git-bisect.txt
+++ w/Documentation/git-bisect.txt
@@ -20,7 +20,7 @@ on the subcommand:
[--no-checkout] [--first-parent] [<bad> [<good>...]] [--] [<paths>...]
git bisect (bad|new|<term-new>) [<rev>]
git bisect (good|old|<term-old>) [<rev>...]
- git bisect terms [--term-good | --term-bad]
+ git bisect terms [--term-(good|old) | --term-(bad|new)]
git bisect skip [(<rev>|<range>)...]
git bisect reset [<commit>]
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
next prev parent reply other threads:[~2023-12-09 16:13 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-12-09 11:58 [BUG] git-bisect man page description of terms command doesn't mention old/new support Britton Kerin
2023-12-09 16:13 ` Junio C Hamano [this message]
2023-12-11 12:34 ` Re* " Matthieu Moy
2023-12-11 15:05 ` Junio C Hamano
2024-02-07 21:44 ` [PATCH 0/2] minute "git bisect" doc updates Junio C Hamano
2024-02-07 21:44 ` [PATCH 1/2] bisect: document "terms" subcommand more fully Junio C Hamano
2024-02-08 6:36 ` Kristoffer Haugsbakk
2024-02-08 16:48 ` Junio C Hamano
2024-02-07 21:44 ` [PATCH 2/2] bisect: document command line arguments for "bisect start" Junio C Hamano
2024-02-08 16:18 ` Jean-Noël Avila
2024-02-09 9:39 ` [PATCH 0/2] minute "git bisect" doc updates Christian Couder
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqqzfyjmk02.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=britton.kerin@gmail.com \
--cc=chriscool@tuxfamily.org \
--cc=git@matthieu-moy.fr \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox