]> git.ipfire.org Git - thirdparty/util-linux.git/commitdiff
getopt.1.adoc: render synopsis rules on separate lines
authorJohannes Altmanninger <aclopte@gmail.com>
Sun, 6 Feb 2022 06:11:58 +0000 (07:11 +0100)
committerKarel Zak <kzak@redhat.com>
Mon, 7 Feb 2022 09:52:05 +0000 (10:52 +0100)
AsciiDoc ignores single line breaks, so the synopsis of

*getopt* _variant1_
*getopt* _variant2_

will render as one line in the manpage.

Fix this by adding a blank line in between two rules, like we do
elsewhere.  This means that the manpage also has blank lines.

*getopt* _variant1_

*getopt* _variant2_

Alternative solution: we could avoid the blank lines like below,
but that'd be inconsistent with our other manpages.

*getopt* _variant1_ +
*getopt* _variant2_ +

or, equivalently, use the verse[*] directive

[verse]
*getopt* _variant1_
*getopt* _variant2_

[*]: https://docs.asciidoctor.org/asciidoc/latest/blocks/verses/

Signed-off-by: Johannes Altmanninger <aclopte@gmail.com>
misc-utils/getopt.1.adoc

index 434d069269bcfaab5858dbbe9a87274f1efda4b7..50fff4a3f7d6c61c58b63d71c04103ad1eac0db0 100644 (file)
@@ -14,7 +14,9 @@ getopt - parse command options (enhanced)
 == SYNOPSIS
 
 *getopt* _optstring_ _parameters_
+
 *getopt* [options] [*--*] _optstring_ _parameters_
+
 *getopt* [options] *-o*|*--options* _optstring_ [options] [*--*] _parameters_
 
 == DESCRIPTION