public inbox for linux-man@vger.kernel.org
 help / color / mirror / Atom feed
From: Alejandro Colomar <colomar.6.4.3@gmail.com>
To: "Michael Kerrisk (man-pages)" <mtk.manpages@gmail.com>
Cc: linux-man@vger.kernel.org
Subject: man-pages.7: Simplify indentation of structure definitions, shell session logs, and so on
Date: Mon, 21 Sep 2020 09:32:14 +0200	[thread overview]
Message-ID: <f70c7f62-9d61-71aa-67cf-43501a29bccc@gmail.com> (raw)
In-Reply-To: <61f4e2a4-d468-ceba-2ccf-ce0c061aa20b@gmail.com>

Hello Michael,


Indentation of structure definitions, shell session logs, and so on

When  structure definitions, shell session logs, and so on are included
in running text, indent them by 4 spaces (i.e.,  a  block  enclosed  by
.in +4n and .in), format them using the .EX and EE macros, and surround
them with suitable paragraph markers (either .PP or .IP).  For example:

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


That could be simplified to the following, right?:

                .IP
                .EX
                int
                main(int argc, char *argv[])
                {
                    return 0;
                }
                .EE
                .PP

Or is there any difference?


Thanks,

Alex

  reply	other threads:[~2020-09-21  7:32 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-20 21:40 [PATCH] system_data_types.7: Add note about length modifiers and conversions to [u]intmax_t, and corresponding example Alejandro Colomar
2020-09-21  5:39 ` Michael Kerrisk (man-pages)
2020-09-21  7:32   ` Alejandro Colomar [this message]
2020-09-21  7:49     ` man-pages.7: Simplify indentation of structure definitions, shell session logs, and so on Michael Kerrisk (man-pages)
2020-09-21 14:15       ` G. Branden Robinson
2020-09-24  8:15         ` Michael Kerrisk (man-pages)
2020-09-27  6:03           ` G. Branden Robinson
2020-09-29 13:12             ` Michael Kerrisk (man-pages)
2020-09-29 20:15         ` Michael Kerrisk (man-pages)
2020-09-30 12:02           ` G. Branden Robinson
2020-09-30 12:54             ` G. Branden Robinson
2020-10-01  7:33               ` Michael Kerrisk (man-pages)
2020-10-26  7:00                 ` Michael Kerrisk (man-pages)
2020-09-21  8:19   ` [PATCH v2] system_data_types.7: Add note about length modifiers and conversions to [u]intmax_t, and corresponding example Alejandro Colomar
2020-09-21  8:29     ` Alejandro Colomar
2020-09-21 10:38     ` Michael Kerrisk (man-pages)
2020-09-21 13:32       ` [PATCH v3] " Alejandro Colomar
2020-09-21 14:13         ` Michael Kerrisk (man-pages)
2020-09-21 14:39           ` Alejandro Colomar

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=f70c7f62-9d61-71aa-67cf-43501a29bccc@gmail.com \
    --to=colomar.6.4.3@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