From: Junio C Hamano <gitster@pobox.com>
To: "Jean-Noël Avila via GitGitGadget" <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org, "Jean-Noël Avila" <jn.avila@free.fr>
Subject: Re: [PATCH 1/5] doc: convert git-bisect to synopsis style
Date: Mon, 18 May 2026 11:10:58 +0900 [thread overview]
Message-ID: <87tss5wjpp.fsf@gitster.g> (raw)
In-Reply-To: <xmqq4ik5d0le.fsf@gitster.g> (Junio C. Hamano's message of "Mon, 18 May 2026 09:26:37 +0900")
Junio C Hamano <gitster@pobox.com> writes:
>> +[synopsis]
>> ------------------------------------------------
>> $ git bisect reset <commit>
>> ------------------------------------------------
>
> and
>
>> +[synopsis]
>> ------------------------------------------------
>> git bisect old [<rev>]
>> ------------------------------------------------
>
> were a bit surprising and confusing. They are not exactly command
> syntax definitions (which is the SYNOPSIS section is about), but
> examples of usage. The one with '$' command line prompt feels
> particularly confusing, as the prompt is not something that the
> end-user gives, unlike what we write in the synopsis section.
>
> Other than that, this is quite exciting.
Well, my local test with asciidoctor did not barf, but it seems that
the documentation pipeline run in GitHub Actions CI is unhappy.
https://github.com/git/git/actions/runs/26008649802/job/76444895183#step:4:4846
I do not know what the differences among the three environments
(counting your development environment---only one of which fails)
are offhand.
next prev parent reply other threads:[~2026-05-18 2:11 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-05-17 20:26 [PATCH 0/5] doc: convert another batch of files to synopsis style Jean-Noël Avila via GitGitGadget
2026-05-17 20:26 ` [PATCH 1/5] doc: convert git-bisect " Jean-Noël Avila via GitGitGadget
2026-05-18 0:26 ` Junio C Hamano
2026-05-18 2:10 ` Junio C Hamano [this message]
2026-05-17 20:26 ` [PATCH 2/5] doc: convert git-grep synopsis and options to new style Jean-Noël Avila via GitGitGadget
2026-05-17 20:26 ` [PATCH 3/5] doc: convert git-am " Jean-Noël Avila via GitGitGadget
2026-05-17 20:26 ` [PATCH 4/5] doc: convert git-apply " Jean-Noël Avila via GitGitGadget
2026-05-17 20:26 ` [PATCH 5/5] doc: convert git-imap-send " Jean-Noël Avila via GitGitGadget
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=87tss5wjpp.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=jn.avila@free.fr \
/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