From: "Jean-Noël AVILA" <jn.avila@free.fr>
To: "Jean-Noël Avila via GitGitGadget" <gitgitgadget@gmail.com>,
"Junio C Hamano" <gitster@pobox.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH 1/5] doc: convert git-bisect to synopsis style
Date: Tue, 19 May 2026 23:03:50 +0200 [thread overview]
Message-ID: <3044460.e9J7NaK4W3@piment-oiseau> (raw)
In-Reply-To: <87tss5wjpp.fsf@gitster.g>
On Monday, 18 May 2026 04:10:58 CEST Junio C Hamano wrote:
> 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.
Thank you for pointing out that the test fails with Asciidoctor. On my debian
testing, both asciidoc.py and asciidoctor pass. I can try and revert to
paragraph styling instead of block styling.
next prev parent reply other threads:[~2026-05-19 21:03 UTC|newest]
Thread overview: 10+ 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
2026-05-19 21:03 ` Jean-Noël AVILA [this message]
2026-05-19 20:57 ` Jean-Noël AVILA
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=3044460.e9J7NaK4W3@piment-oiseau \
--to=jn.avila@free.fr \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=gitster@pobox.com \
/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