Re: [PATCH 1/5] doc: convert git-bisect to synopsis style

From: Jean-Noël AVILA <jn.avila@free.fr>
Date: May 19, 2026, 21:03 UTC
Message-ID: <3044460.e9J7NaK4W3@piment-oiseau>
In-Reply-To: <87tss5wjpp.fsf@gitster.g>

On Monday, 18 May 2026 04:10:58 CEST Junio C Hamano wrote:

Show 27 quoted lines

> 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.