From: Johannes Altmanninger <aclopte@gmail.com>
To: util-linux@vger.kernel.org
Cc: Johannes Altmanninger <aclopte@gmail.com>
Subject: [PATCH 4/4] getopt.1.adoc: render synopsis rules on separate lines
Date: Sun, 6 Feb 2022 07:11:58 +0100 [thread overview]
Message-ID: <20220206061158.752262-4-aclopte@gmail.com> (raw)
In-Reply-To: <20220206061158.752262-1-aclopte@gmail.com>
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 | 2 ++
1 file changed, 2 insertions(+)
diff --git a/misc-utils/getopt.1.adoc b/misc-utils/getopt.1.adoc
index 6cbdd5174..7a80b141e 100644
--- a/misc-utils/getopt.1.adoc
+++ b/misc-utils/getopt.1.adoc
@@ -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
--
2.35.1.301.gcdacdcff8b.dirty
next prev parent reply other threads:[~2022-02-06 6:12 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-02-06 6:11 [PATCH 1/4] newgrp.1.adoc: use bold font for command name in synopsis Johannes Altmanninger
2022-02-06 6:11 ` [PATCH 2/4] mount.8.adoc: use bold font for literal text " Johannes Altmanninger
2022-02-06 6:11 ` [PATCH 3/4] kill.1.adoc: clarify syntax of -SIG argument " Johannes Altmanninger
2022-02-06 6:11 ` Johannes Altmanninger [this message]
2022-02-07 18:42 ` [PATCH 4/4] getopt.1.adoc: render synopsis rules on separate lines Mario Blättermann
2022-02-07 10:00 ` [PATCH 1/4] newgrp.1.adoc: use bold font for command name in synopsis Karel Zak
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=20220206061158.752262-4-aclopte@gmail.com \
--to=aclopte@gmail.com \
--cc=util-linux@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.