From: "Michael Kerrisk (man-pages)" <mtk.manpages@gmail.com>
To: Alejandro Colomar <colomar.6.4.3@gmail.com>,
Dave Martin <Dave.Martin@arm.com>
Cc: mtk.manpages@gmail.com, linux-man@vger.kernel.org,
libc-alpha@sourceware.org, g.branden.robinson@gmail.com
Subject: Re: [PATCH v2] system_data_types.7: Improve "Include" wording and format, and explain it in NOTES
Date: Tue, 29 Sep 2020 17:06:27 +0200 [thread overview]
Message-ID: <7b4bcd7f-8e60-943d-b127-6926a53a29d3@gmail.com> (raw)
In-Reply-To: <3dae4d7f-3c08-4f1c-47ce-8815255ca24c@gmail.com>
> > Can we not just annotate each header listed with the originating
> > standard, say:
> >
> > <stddef.h> (C)
> >
> > <sys/types.h> (POSIX)
> > ... (POSIX)
> > ...
>
> That may be a good idea; I've thought about doing that in the past;
> but also thought that it's still too much noise.
> Let's see what others think about it.
My thought is that maybe we can add this kind of info later,
providing we find a concise way to do it. But, for now, already
the info in the page is useful as is, and I don't want to stop
the momentum of Alex's work. So, for now, I think let's carry
on the current style.
> The downside is that it adds a lot of lines,
> being harder to read for types with too many headers (e.g., size_t).
That is also my concern.
Thanks,
Michael
--
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
next prev parent reply other threads:[~2020-09-29 15:06 UTC|newest]
Thread overview: 34+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-18 11:27 [PATCH 0/2] Document size_t Alejandro Colomar
2020-09-18 11:27 ` [PATCH 1/2] system_data_types.7: " Alejandro Colomar
2020-09-18 14:34 ` Florian Weimer
2020-09-18 15:53 ` Alejandro Colomar
2020-09-18 17:27 ` Florian Weimer
2020-09-18 17:42 ` Paul Eggert
2020-09-18 17:53 ` Florian Weimer
2020-09-30 15:50 ` Joseph Myers
2020-09-18 20:13 ` Michael Kerrisk (man-pages)
2020-09-28 13:41 ` Dave Martin
2020-09-28 13:48 ` Alejandro Colomar
2020-09-28 13:55 ` G. Branden Robinson
2020-09-28 14:15 ` Dave Martin
2020-09-28 14:51 ` Alejandro Colomar
2020-09-28 15:16 ` [RFC] system_data_types.7: wfix + ffix Alejandro Colomar
2020-09-29 10:37 ` Dave Martin
2020-09-29 11:34 ` Michael Kerrisk (man-pages)
2020-09-29 12:10 ` Alejandro Colomar
2020-09-29 14:22 ` [PATCH v2] system_data_types.7: Improve "Include" wording and format, and explain it in NOTES Alejandro Colomar
2020-09-29 14:43 ` Dave Martin
2020-09-29 14:52 ` Alejandro Colomar
2020-09-29 15:06 ` Michael Kerrisk (man-pages) [this message]
2020-09-29 15:13 ` Dave Martin
2020-09-29 15:21 ` Alejandro Colomar
2020-09-29 15:10 ` Dave Martin
2020-09-29 11:57 ` [RFC] system_data_types.7: wfix + ffix Alejandro Colomar
2020-09-30 17:16 ` [PATCH 1/2] system_data_types.7: Document size_t Joseph Myers
2020-09-29 11:11 ` Michael Kerrisk (man-pages)
2020-09-28 14:47 ` Alejandro Colomar
2020-09-18 11:27 ` [PATCH 2/2] size_t.3: New link to new documented type in system_data_types(7) Alejandro Colomar
2020-09-18 20:14 ` Michael Kerrisk (man-pages)
2020-09-18 20:13 ` [PATCH 0/2] Document size_t Michael Kerrisk (man-pages)
2020-09-18 21:28 ` Alejandro Colomar
2020-09-18 21:32 ` Florian Weimer
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=7b4bcd7f-8e60-943d-b127-6926a53a29d3@gmail.com \
--to=mtk.manpages@gmail.com \
--cc=Dave.Martin@arm.com \
--cc=colomar.6.4.3@gmail.com \
--cc=g.branden.robinson@gmail.com \
--cc=libc-alpha@sourceware.org \
--cc=linux-man@vger.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