linux-man.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Alejandro Colomar (man-pages)" <alx.manpages@gmail.com>
To: "Pali Rohár" <pali@kernel.org>
Cc: Michael Kerrisk <mtk.manpages@gmail.com>, linux-man@vger.kernel.org
Subject: Re: [PATCH] termios.3: Use bold style for Bnn and EXTn macro constants
Date: Thu, 29 Jul 2021 13:21:40 +0200	[thread overview]
Message-ID: <430eaca8-3ea9-5df9-8db5-5d94bcb06815@gmail.com> (raw)
In-Reply-To: <20210725225453.7341-1-pali@kernel.org>

Hi Pali,

On 7/26/21 12:54 AM, Pali Rohár wrote:
> Signed-off-by: Pali Rohár <pali@kernel.org>
> ---
>   man3/termios.3 | 5 +++--
>   1 file changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/man3/termios.3 b/man3/termios.3
> index 01c20994424d..e603879e18d4 100644
> --- a/man3/termios.3
> +++ b/man3/termios.3
> @@ -1068,8 +1068,9 @@ and
>   are nonstandard, but available on the BSDs.
>   .SH NOTES
>   UNIX\ V7 and several later systems have a list of baud rates
> -where after the fourteen values B0, ..., B9600 one finds the
> -two constants EXTA, EXTB ("External A" and "External B").
> +where after the fourteen values \fBB0\fP, ..., \fBB9600\fP

Could you please use .B and/or .BR instead of inline \fB...\fP?

See this extract from man-pages(7):

        Any  reference  to  the  subject of the current manual page
        should be written with the name in bold followed by a  pair
        of parentheses in Roman (normal) font.  For example, in the
        fcntl(2) man page, references to the subject  of  the  page
        would  be  written as: fcntl().  The preferred way to write
        this in the source file is:

            .BR fcntl ()

        (Using this format, rather than the  use  of  "\fB...\fP()"
        makes  it  easier to write tools that parse man page source
        files.)


Thanks,

Alex

> +one finds the two constants \fBEXTA\fP, \fBEXTB\fP
> +("External A" and "External B").
>   Many systems extend the list with much higher baud rates.
>   .PP
>   The effect of a nonzero \fIduration\fP with
> 


-- 
Alejandro Colomar
Linux man-pages comaintainer; https://www.kernel.org/doc/man-pages/
http://www.alejandro-colomar.es/

  reply	other threads:[~2021-07-29 11:21 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-07-25 22:54 [PATCH] termios.3: Use bold style for Bnn and EXTn macro constants Pali Rohár
2021-07-29 11:21 ` Alejandro Colomar (man-pages) [this message]
2021-07-29 17:23   ` Pali Rohár
2021-07-29 23:04     ` G. Branden Robinson
2021-07-29 23:41       ` Alejandro Colomar (man-pages)
2021-07-30  0:21         ` Pali Rohár
2021-07-30  0:53           ` G. Branden Robinson
2021-07-30 10:32 ` [PATCH v2] " Pali Rohár
2021-07-30 18:17   ` Alejandro Colomar (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=430eaca8-3ea9-5df9-8db5-5d94bcb06815@gmail.com \
    --to=alx.manpages@gmail.com \
    --cc=linux-man@vger.kernel.org \
    --cc=mtk.manpages@gmail.com \
    --cc=pali@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 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).