Re: [PATCH] doc: fix accidental literal blocks

From: Jeff King <peff@peff.net>
Date: Oct 10, 2025, 05:02 UTC
Message-ID: <20251010050207.GA1897715@coredump.intra.peff.net>
In-Reply-To: <7a955ecb1b5.1759923933.git.code@khaugsbakk.name>

On Wed, Oct 08, 2025 at 01:48:46PM +0200, kristofferhaugsbakk@fastmail.com wrote:

Show 9 quoted lines

> Make sure that normal paragraphs in most user-facing docs[1] don’t
> use literal blocks. This can easily happen if you try to maintain
> indentation in order to continue a block; that might work in
> e.g. Markdown variants, but not in AsciiDoc.
> 
> The fixes are straightforward, i.e. just deindent the block and maybe
> add line continuations. The only exception is git-sparse-checkout(1)
> where we also replace indentation used for *intended* literal blocks
> with `----`.

I gave a quick look over the results of doc-diff before and after, and all of the changes look good to me.

-Peff