Re: [PATCH] Doc: fix misleading asciidoc formating

From: Jean-Noël Avila <jn.avila@free.fr>
Date: Mar 6, 2019, 08:07 UTC
Message-ID: <43445278-ec9f-f3f4-89bf-cf99906fc617@free.fr>
In-Reply-To: <xmqqy35ssx7v.fsf@gitster-ct.c.googlers.com>

On 2019-03-06, Junio Hamano, Jeff King wrote:> Jeff King <peff@peff.net> writes

Show 13 quoted lines

> 
>> TBH, I still have mixed feelings on rendering these technical docs with
>> asciidoc at all. It seems like few enough people bother to render them
>> that bugs persist for a long time. It kind of seems like make-work
>> getting them to format correctly.
> 
> I thought about resisting when some people started pushing for
> rendering everything under the Sun, but went with the flow as I
> lacked the energy to fight every battle in sight.
> 
> Good to see somebody shares a similar sense of trade-off, better
> late than never ;-).
>

TBH, I discovered this while diving into the rendering on manpages for the localized version because asciidoctor issued a warning, and pushed this patch for "cultural" knowledge (sometimes, automatic linefeed triggers unintended behaviors). But, as Peff noted, this may not be a good idea to render these documents at all on git-scm.com.

In this case, there's no point in tracking rendering issues outside genuine manpages.