From: Jeff King <peff@peff•net>
To: kristofferhaugsbakk@fastmail•com
Cc: git@vger•kernel.org, Kristoffer Haugsbakk <code@khaugsbakk•name>
Subject: Re: [PATCH] doc: fix accidental literal blocks
Date: Fri, 10 Oct 2025 01:02:07 -0400 [thread overview]
Message-ID: <20251010050207.GA1897715@coredump.intra.peff.net> (raw)
In-Reply-To: <7a955ecb1b5.1759923933.git.code@khaugsbakk.name>
On Wed, Oct 08, 2025 at 01:48:46PM +0200, kristofferhaugsbakk@fastmail•com wrote:
> 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
next prev parent reply other threads:[~2025-10-10 5:02 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-10-08 11:48 [PATCH] doc: fix accidental literal blocks kristofferhaugsbakk
2025-10-10 5:02 ` Jeff King [this message]
2025-10-10 9:35 ` Kristoffer Haugsbakk
2025-10-10 9:37 ` [PATCH v2] " kristofferhaugsbakk
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=20251010050207.GA1897715@coredump.intra.peff.net \
--to=peff@peff$(echo .)net \
--cc=code@khaugsbakk$(echo .)name \
--cc=git@vger$(echo .)kernel.org \
--cc=kristofferhaugsbakk@fastmail$(echo .)com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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