]> git.ipfire.org Git - thirdparty/git.git/commit
doc: introduce a synopsis typesetting
authorJean-Noël Avila <jn.avila@free.fr>
Tue, 24 Sep 2024 07:08:48 +0000 (07:08 +0000)
committerJunio C Hamano <gitster@pobox.com>
Tue, 24 Sep 2024 17:20:25 +0000 (10:20 -0700)
commit974cdca345cc51fb8623c611a25314f98b2cd3e3
treec10c2b5502d7e9b0deba926bdd11cb128245442c
parentad57f148c6b5f8735b62238dda8f571c582e0e54
doc: introduce a synopsis typesetting

In order to follow the common manpage usage, the synopsis of the
commands needs to be heavily typeset. A first try was performed with
using native markup, but it turned out to make the document source
almost unreadable, difficult to write and prone to mistakes with
unwanted Asciidoc's role attributes.

In order to both simplify the writer's task and obtain a consistant
typesetting in the synopsis, a custom 'synopsis' paragraph type is
created and the processor for backticked text are modified. The
backends of asciidoc and asciidoctor take in charge to correctly add
the required typesetting.

Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/asciidoc.conf
Documentation/asciidoctor-extensions.rb
ci/install-dependencies.sh
t/t0450-txt-doc-vs-help.sh