From: Alejandro Colomar <colomar.6.4.3@gmail.com>
To: mtk.manpages@gmail.com
Cc: "G . Branden Robinson" <g.branden.robinson@gmail.com>,
linux-man <linux-man@vger.kernel.org>
Subject: Re: Format inline code
Date: Thu, 12 Nov 2020 22:17:34 +0100 [thread overview]
Message-ID: <bb5f3aad-d766-fb9e-e77a-09009fb7b599@gmail.com> (raw)
In-Reply-To: <CAKgNAkjsnu9+rxdLgZ5VzYxjFf_c1Ed0JUQ8=KHkK6Qw9X4B-Q@mail.gmail.com>
Hi Michael,
After the discovery I made today (See thread '.RS':
https://lore.kernel.org/linux-man/eaee2c6e-cbb7-94b2-f6c4-9039d184e129@gmail.com/T/),
[.RS 4/.RE] is not an option.
It simply doesn't work in some contexts.
I propose using the same as before:
[[
.in +4n
.EX
// Code
.EE
.in
]]
There are some cases using [.nf/.fi] instead of [.EX/.EE].
I would replace those by [.EX/.EE].
However, I would still do the change [.IP] -> [(.RS + .PP)/.RE],
so almost always you'll have [.PP] surrounding code examples,
and you'll only see [.IP] when it is really needed:
in cases where you use its argument ([.IP * n]).
In those cases, you should also use [.IP] for the code
(see perf_event_open.2:1426):
[[
.IP * 2
If
.B PERF_FORMAT_GROUP
was specified to allow reading all events in a group at once:
.IP
.in +4n
.EX
struct read_format {
u64 nr; /* The number of events */
u64 time_enabled; /* if PERF_FORMAT_TOTAL_TIME_ENABLED */
u64 time_running; /* if PERF_FORMAT_TOTAL_TIME_RUNNING */
struct {
u64 value; /* The value of the event */
u64 id; /* if PERF_FORMAT_ID */
} values[nr];
};
.EE
.in
.IP *
If
.B PERF_FORMAT_GROUP
was
.I not
specified:
.IP
.in +4n
.EX
struct read_format {
u64 value; /* The value of the event */
u64 time_enabled; /* if PERF_FORMAT_TOTAL_TIME_ENABLED */
u64 time_running; /* if PERF_FORMAT_TOTAL_TIME_RUNNING */
u64 id; /* if PERF_FORMAT_ID */
};
.EE
.in
]]
This way, inline code, and only inline code, will use [.in],
which will help grepping if it is ever needed.
Your thoughts?
Thanks,
Alex
next prev parent reply other threads:[~2020-11-12 21:17 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-11-05 10:19 Format inline code Alejandro Colomar
2020-11-05 11:36 ` Michael Kerrisk (man-pages)
2020-11-05 14:59 ` Alejandro Colomar
2020-11-05 21:37 ` Michael Kerrisk (man-pages)
2020-11-05 22:01 ` Alejandro Colomar
2020-11-06 9:38 ` Alejandro Colomar
2020-11-06 16:00 ` Michael Kerrisk (man-pages)
2020-11-06 16:36 ` Alejandro Colomar
2020-11-08 12:22 ` Michael Kerrisk (man-pages)
2020-11-12 11:32 ` Alejandro Colomar
2020-11-12 21:17 ` Alejandro Colomar [this message]
2020-11-13 8:28 ` G. Branden Robinson
2020-11-13 9:00 ` Michael Kerrisk (man-pages)
2020-11-13 9:47 ` G. Branden Robinson
2020-11-13 10:11 ` Michael Kerrisk (man-pages)
2020-11-13 10:21 ` Alejandro Colomar
[not found] ` <fbaf2a56-3f2e-e5ce-6ca2-e8f30156947d@gmail.com>
2020-11-12 21:20 ` Alejandro Colomar
2020-11-12 22:55 ` [RFC v1] perf_event_open.2: srcfix + ffix Alejandro Colomar
2020-11-13 9:21 ` Michael Kerrisk (man-pages)
2020-11-13 10:26 ` Alejandro Colomar
2020-11-13 10:39 ` Michael Kerrisk (man-pages)
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=bb5f3aad-d766-fb9e-e77a-09009fb7b599@gmail.com \
--to=colomar.6.4.3@gmail.com \
--cc=g.branden.robinson@gmail.com \
--cc=linux-man@vger.kernel.org \
--cc=mtk.manpages@gmail.com \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).