]> git.ipfire.org Git - thirdparty/git.git/commit
doc: fix accidental literal blocks
authorKristoffer Haugsbakk <code@khaugsbakk.name>
Wed, 8 Oct 2025 11:48:46 +0000 (13:48 +0200)
committerJunio C Hamano <gitster@pobox.com>
Fri, 10 Oct 2025 14:56:09 +0000 (07:56 -0700)
commitb3ac6e737db8635aaed0c355ebaf291b63fb0461
tree375d37c779eb9fb067d7d617660ef016b26f1261
parentc44beea485f0f2feaf460e2ac87fdd5608d63cf0
doc: fix accidental literal blocks

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

† 1: These have not been considered:
     • `Documentation/howto/`
     • `Documentation/technical/`
     • `Documentation/gitprotocol*`

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
Acked-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/config/core.adoc
Documentation/git-config.adoc
Documentation/git-rev-parse.adoc
Documentation/git-shortlog.adoc
Documentation/git-sparse-checkout.adoc