]> git.ipfire.org Git - thirdparty/git.git/commit
git-cat-file.txt: fix list continuations rendering literally
authorMartin Ågren <martin.agren@gmail.com>
Wed, 18 Jan 2023 08:27:49 +0000 (09:27 +0100)
committerJunio C Hamano <gitster@pobox.com>
Wed, 18 Jan 2023 16:24:39 +0000 (08:24 -0800)
commit8534bb4cb1329612bb749dcb7a6f27181d3becbd
treebdde98ef8f8c5c787134f2158cb3bfa4c34c29aa
parenta797c0ea042af697d82ad475b9f354c4a33a9047
git-cat-file.txt: fix list continuations rendering literally

With Asciidoctor, all of the '+' introduced in a797c0ea04 ("cat-file:
add mailmap support to --batch-check option", 2022-12-20) render
literally rather than functioning as list continuations. With asciidoc,
this renders just fine. It's not too surprising that there is room for
ambiguity and surprises here, since we have lists within lists.

Simply replacing all of these '+' with empty lines makes this render
fine using both tools. Except, in the third hunk, where after this inner
'*' list ends, we want to continue with more contents of the outer list
item (`--batch-command=<format>`). We can solve any ambiguity here and
make this clear to both tools by wrapping the inner list in an open
block (using "--").

For consistency, let's wrap all three of these inner lists from
a797c0ea04 in open blocks. This also future-proofs us a little -- if we
ever gain more contents after any of those first two lists, as we did
already in a797c0ea04 for the third list, we're prepared and should
render fine with both asciidoc and Asciidoctor from the start.

Signed-off-by: Martin Ågren <martin.agren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-cat-file.txt