All of lore.kernel.org
 help / color / mirror / Atom feed
From: "G. Branden Robinson" <g.branden.robinson@gmail.com>
To: Alejandro Colomar <colomar.6.4.3@gmail.com>
Cc: mtk.manpages@gmail.com, linux-man@vger.kernel.org,
	libc-alpha@sourceware.org
Subject: Re: [PATCH v2 1/3] system_data_types.7: ffix
Date: Mon, 28 Sep 2020 23:06:00 +1000	[thread overview]
Message-ID: <20200928130558.4qi6jitfwxg6ccm7@localhost.localdomain> (raw)
In-Reply-To: <20200928090322.2058-1-colomar.6.4.3@gmail.com>

[-- Attachment #1: Type: text/plain, Size: 1158 bytes --]

Hi Alex!

At 2020-09-28T11:03:23+0200, Alejandro Colomar wrote:
> Normally, text under a section header starts in the next line after
> the header, without a blank line.  Follow that pattern.

I think your terminology could confuse some people.  A section heading
in a man page is what is typeset by the .SH macro.  For instance, ".SH
Name", ".SH See also", and so forth[1].

In the below, "aiocb" (in italics) is properly termed a "paragraph tag",
hence the mnemonic for the macro right before it: "TP" for "tagged
paragraph".

Just FYI.

[...]
> diff --git a/man7/system_data_types.7 b/man7/system_data_types.7
> index 361e8d411..ff0403df9 100644
> --- a/man7/system_data_types.7
> +++ b/man7/system_data_types.7
> @@ -66,7 +66,7 @@ system_data_types \- overview of system data types
>  .TP
>  .I aiocb
>  .RS
> -.PP
> +.br
>  Include:
>  .IR <aio.h> .
>  .PP
> @@ -101,7 +101,7 @@ See also:

Regards,
Branden

[1] Often section headings are written in full capitals in man page
source documents, which loses information.  The next release of groff
will feature support for mixed-case section headings with optional
full-caps rendering under user control.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

  parent reply	other threads:[~2020-09-28 13:06 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-27 21:13 [PATCH 1/3] system_data_types.7: ffix Alejandro Colomar
2020-09-27 21:13 ` [PATCH 2/3] system_data_types.7: Add 'FILE' Alejandro Colomar
2020-09-28  6:04   ` Michael Kerrisk (man-pages)
2020-09-28  9:06     ` [PATCH v2 " Alejandro Colomar
2020-09-29 13:15       ` Alejandro Colomar
2020-09-29 13:35         ` Michael Kerrisk (man-pages)
2020-09-27 21:13 ` [PATCH 3/3] FILE.3: New link to system_data_types(7) Alejandro Colomar
2020-09-28  5:59 ` [PATCH 1/3] system_data_types.7: ffix Michael Kerrisk (man-pages)
2020-09-28  9:03   ` [PATCH v2 " Alejandro Colomar
2020-09-28 10:34     ` Michael Kerrisk (man-pages)
2020-09-28 10:37       ` Alejandro Colomar
2020-09-28 11:13       ` G. Branden Robinson
2020-09-28 13:06     ` G. Branden Robinson [this message]
2020-09-28 13:44       ` Alejandro Colomar
2020-09-30 10:43         ` G. Branden Robinson
2020-09-30 21:32           ` Alejandro Colomar
2020-10-01  7:37             ` Michael Kerrisk (man-pages)
2020-10-01  7:52               ` Alejandro Colomar
2020-10-01  9:36                 ` Michael Kerrisk (man-pages)
2020-09-28 10:40   ` [PATCH " G. Branden Robinson
2020-09-28 10:51     ` Alejandro Colomar
2020-09-28 12:49       ` G. Branden Robinson

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=20200928130558.4qi6jitfwxg6ccm7@localhost.localdomain \
    --to=g.branden.robinson@gmail.com \
    --cc=colomar.6.4.3@gmail.com \
    --cc=libc-alpha@sourceware.org \
    --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 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.