linux-man.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Alejandro Colomar <colomar.6.4.3@gmail.com>
To: "Michael Kerrisk (man-pages)" <mtk.manpages@gmail.com>,
	"G. Branden Robinson" <g.branden.robinson@gmail.com>
Cc: linux-man <linux-man@vger.kernel.org>
Subject: Format inline code
Date: Thu, 5 Nov 2020 11:19:11 +0100	[thread overview]
Message-ID: <f4a93b8c-8136-113b-d39d-72df43381fd9@gmail.com> (raw)

Hey Michael,

I tried to reply to the old thread where we talked about it,
but I couldn't find it.
I think it was in a thread of some patch for system_data_types,
so I didn't know how to filter for it :/

So let's start a clean thread for that.

Currently, man-pages(7) proposes:

=================
.PP
.in +4n
.EX
int
main(int argc, char *argv[])
{
     return 0;
}
.EE
.in
.PP
=================

I think you said that it doesn't always work.

I don't agree with that:
If you correctly use .RS/.RE instead of misusing .IP,
I think it will work always.

I mean, if you have a block that is indented,
I propose to use .RS/.RE for the whole block,
instead of .IP for every paragraph
(if you use .IP, then yes,
that construct needs to be modified to use it too).
An implementation of what I mean is system_data_types.7.

If you think it would still fail in some scenario,
please show me.

Another problem of that construct is that it uses naked .in.
I agree with it.

How about the following?:

=================
.PP
.RS +4n
.EX
int
main(int argc, char *argv[])
{
     return 0;
}
.EE
.RE
.PP
=================

I don't know if that syntax is correct,
but I tried it, and it seems to work.

AFAIK, it will _always_ work
as long as blocks are correctly indented using .RS/.RE,
and it uses man macros only.

Any thoughts?


Thanks,

Alex

             reply	other threads:[~2020-11-05 10:19 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-11-05 10:19 Alejandro Colomar [this message]
2020-11-05 11:36 ` Format inline code 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
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=f4a93b8c-8136-113b-d39d-72df43381fd9@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).