From: Alejandro Colomar <colomar.6.4.3@gmail.com>
To: "G. Branden Robinson" <g.branden.robinson@gmail.com>,
"Michael Kerrisk (man-pages)" <mtk.manpages@gmail.com>
Cc: Paul Eggert <eggert@cs.ucla.edu>,
linux-man@vger.kernel.org, gcc-patches@gcc.gnu.org,
libc-alpha@sourceware.org, linux-kernel@vger.kernel.org,
jwakely.gcc@gmail.com, David.Laight@ACULAB.COM
Subject: Re: [PATCH v4 1/2] system_data_types.7: Add 'void *'
Date: Sat, 3 Oct 2020 10:55:17 +0200 [thread overview]
Message-ID: <97b1b0d8-1f87-ac68-2ae9-92c2681ac49a@gmail.com> (raw)
In-Reply-To: <20201003074807.swdpnwaq2rzigadl@localhost.localdomain>
Hi Michael and Branden,
On 2020-10-03 09:48, G. Branden Robinson wrote:
> At 2020-10-03T09:10:14+0200, Michael Kerrisk (man-pages) wrote:
>> On 10/2/20 10:27 PM, Alejandro Colomar wrote:
>>> On 2020-10-02 22:14, Paul Eggert wrote:
>>> > On 10/2/20 11:38 AM, Alejandro Colomar wrote:
>>> >
>>> >> .I void *
>>> >>
>>> >> renders with a space in between.
>>> >
>>> > That's odd, as "man(7)" says "All of the arguments will be
>>> > printed next to each other without intervening spaces". I'd play
>>> > it safe and quote the arg anyway.
>>>
>>> Oops, that's a bug in man(7). Don't worry about it.
>>
>> I'm not sure where that text in man(7) comes from. However, for
>> clarity I would normally also use quotes in this case.
Hi Michael and Branden,
Here is the offending line:
https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/man7/man.7#n172
Thanks,
Alex
>>
>>> Michael, you might want to have a look at it.
>>>
>>> I'll also add Branden, who might have something to say about it.
>>
>> Yes, maybe Branden can add some insight.
>
> The "short" answer[1] is that I think Alex is correct; Paul's caution is
> unwarranted and arises from confusion with the font alternation macros
> of the man(7) macro package. Examples of the latter are .BI and .BR.
> Those set their even-numbered arguments in one font and odd-numbered
> arguments in another, with no space between them. That suppression of
> space is the reason they exist. With the "single-font" macros like .B
> and .I[2], if you don't want space, don't type it.
>
> I could say more, including an annotated explanation of the groff and
> Version 7 Unix man(7) implementations of the I macro, if desired. :)
>
> Regards,
> Branden
>
> [1] since as everyone knows, I struggle with brevity
> [2] I (and others) discourage use of .SM and .SB because they can't be
> distinguished from ordinary roman and bold type, respectively, on
> terminals.
>
next prev parent reply other threads:[~2020-10-03 8:55 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-02 12:16 [PATCH 0/2] Document " Alejandro Colomar
2020-10-02 12:16 ` [PATCH 1/2] system_data_types.7: Add " Alejandro Colomar
2020-10-02 13:15 ` Jonathan Wakely
2020-10-02 13:26 ` David Laight
2020-10-02 12:16 ` [PATCH 2/2] void.3: New link to system_data_types(7) Alejandro Colomar
2020-10-02 15:14 ` [PATCH v4 0/2] Document 'void *' Alejandro Colomar
2020-10-02 19:28 ` [PATCH v5 " Alejandro Colomar
2020-10-02 19:28 ` [PATCH v5 1/2] system_data_types.7: Add " Alejandro Colomar
2020-10-03 8:01 ` Michael Kerrisk (man-pages)
2020-10-02 19:28 ` [PATCH v5 2/2] void.3: New link to system_data_types(7) Alejandro Colomar
2020-10-03 8:01 ` Michael Kerrisk (man-pages)
2020-10-02 15:14 ` [PATCH v4 1/2] system_data_types.7: Add 'void *' Alejandro Colomar
2020-10-02 16:53 ` Paul Eggert
2020-10-02 18:38 ` Alejandro Colomar
2020-10-02 20:14 ` Paul Eggert
2020-10-02 20:27 ` Alejandro Colomar
2020-10-03 7:10 ` Michael Kerrisk (man-pages)
2020-10-03 7:48 ` G. Branden Robinson
2020-10-03 8:55 ` Alejandro Colomar [this message]
2020-10-03 11:47 ` Alejandro Colomar
2020-10-03 11:52 ` Michael Kerrisk (man-pages)
2020-10-02 15:14 ` [PATCH v4 2/2] void.3: New link to system_data_types(7) 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=97b1b0d8-1f87-ac68-2ae9-92c2681ac49a@gmail.com \
--to=colomar.6.4.3@gmail.com \
--cc=David.Laight@ACULAB.COM \
--cc=eggert@cs.ucla.edu \
--cc=g.branden.robinson@gmail.com \
--cc=gcc-patches@gcc.gnu.org \
--cc=jwakely.gcc@gmail.com \
--cc=libc-alpha@sourceware.org \
--cc=linux-kernel@vger.kernel.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 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 read-only IMAP folder(s) and NNTP newsgroup(s).