From: Alejandro Colomar <colomar.6.4.3@gmail.com>
To: mtk.manpages@gmail.com, g.branden.robinson@gmail.com,
Dave.Martin@arm.com
Cc: Alejandro Colomar <colomar.6.4.3@gmail.com>,
linux-man@vger.kernel.org, libc-alpha@sourceware.org
Subject: [RFC] system_data_types.7: wfix + ffix
Date: Mon, 28 Sep 2020 17:16:47 +0200 [thread overview]
Message-ID: <20200928151646.20271-1-colomar.6.4.3@gmail.com> (raw)
In-Reply-To: <b49c082f-06fb-aeed-d6c0-6ab619215d43@gmail.com>
The previous format/wording for the includes wasn't very clear.
Improve it a bit following Branden's proposal.
Reported-by: G. Branden Robinson <g.branden.robinson@gmail.com>
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---
Hi,
What do you think about this?
Would you change something?
Thanks,
Alex
man7/system_data_types.7 | 285 ++++++++++++++++-----------------------
1 file changed, 113 insertions(+), 172 deletions(-)
diff --git a/man7/system_data_types.7 b/man7/system_data_types.7
index 16930985e..dc4a3bae4 100644
--- a/man7/system_data_types.7
+++ b/man7/system_data_types.7
@@ -33,20 +33,21 @@ system_data_types \- overview of system data types
.\" Each entry will have the following parts:
.\" * Include
.\" The headers will be in the following order:
+.\" "Include:"
.\" 1) The main header that shall define the type
-.\" according to the C Standard,
-.\" and
-.\" the main header that shall define the type
-.\" according to POSIX,
-.\" in alphabetical order.
-.\" ;
-.\" 2) All other headers that shall define the type
+.\" according to the C Standard.
+.\" ["or"]
+.\" 2) The main header that shall define the type
+.\" according to POSIX.
+.\" [". Alternatively,"]
+.\" 3) All other headers that shall define the type
.\" as described in the previous header(s)
.\" according to the C Standard or POSIX,
.\" in alphabetical order.
.\" *) All headers that define the type
.\" *if* the type is not defined by C nor POSIX,
.\" in alphabetical order.
+.\" "."
.\"
.\" * Definition (no "Definition" header)
.\" Only struct/union types will have definition;
@@ -203,8 +204,8 @@ See also:
.RS
.br
Include:
-.IR <stdio.h> ;
-or
+.IR <stdio.h> .
+Alternatively,
.IR <wchar.h> .
.PP
An object type used for streams.
@@ -268,19 +269,14 @@ type in this page.
.RS
.br
Include:
-.IR <sys/types.h> ;
-or
-.I <grp.h>
-or
-.I <pwd.h>
-or
-.I <signal.h>
-or
-.I <stropts.h>
-or
-.I <sys/ipc.h>
-or
-.I <sys/stat.h>
+.IR <sys/types.h> .
+Alternatively,
+.IR <grp.h> ,
+.IR <pwd.h> ,
+.IR <signal.h> ,
+.IR <stropts.h> ,
+.IR <sys/ipc.h> ,
+.IR <sys/stat.h> ,
or
.IR <unistd.h> .
.PP
@@ -305,8 +301,8 @@ See also:
.RS
.br
Include:
-.IR <sys/types.h> ;
-or
+.IR <sys/types.h> .
+Alternatively,
.IR <sys/resource.h> .
.PP
A type used to hold a general identifier.
@@ -450,29 +446,19 @@ See also:
.RS
.br
Include
-.IR <sys/types.h> ;
-or
-.I <fcntl.h>
-or
-.I <sched.h>
-or
-.I <signal.h>
-or
-.I <spawn.h>
-or
-.I <sys/msg.h>
-or
-.I <sys/sem.h>
-or
-.I <sys/shm.h>
-or
-.I <sys/wait.h>
-or
-.I <termios.h>
-or
-.I <time.h>
-or
-.I <unistd.h>
+.IR <sys/types.h> .
+Alternatively,
+.IR <fcntl.h> ,
+.IR <sched.h> ,
+.IR <signal.h> ,
+.IR <spawn.h> ,
+.IR <sys/msg.h> ,
+.IR <sys/sem.h> ,
+.IR <sys/shm.h> ,
+.IR <sys/wait.h> ,
+.IR <termios.h> ,
+.IR <time.h> ,
+.IR <unistd.h> ,
or
.IR <utmpx.h> .
.PP
@@ -602,11 +588,10 @@ types in this page.
.RS
.br
Include:
-.IR <signal.h> ;
-or
-.I <aio.h>
-or
-.I <mqueue.h>
+.IR <signal.h> .
+Alternatively,
+.IR <aio.h> ,
+.IR <mqueue.h> ,
or
.IR <time.h> .
.PP
@@ -651,8 +636,8 @@ structure in this page.
.RS
.br
Include:
-.IR <signal.h> ;
-or
+.IR <signal.h> .
+Alternatively,
.IR <sys/wait.h> .
.PP
.EX
@@ -687,9 +672,9 @@ See also:
.RS
.br
Include:
-.IR <signal.h> ;
-or
-.I <spawn.h>
+.IR <signal.h> .
+Alternatively,
+.IR <spawn.h> ,
or
.IR <sys/select.h> .
.PP
@@ -750,55 +735,32 @@ in this page.
Include:
.I <stddef.h>
or
-.IR <sys/types.h> ;
-or
-.I <aio.h>
-or
-.I <glob.h>
-or
-.I <grp.h>
-or
-.I <iconv.h>
-or
-.I <monetary.h>
-or
-.I <mqueue.h>
-or
-.I <ndbm.h>
-or
-.I <pwd.h>
-or
-.I <regex.h>
-or
-.I <search.h>
-or
-.I <signal.h>
-or
-.I <stdio.h>
-or
-.I <stdlib.h>
-or
-.I <string.h>
-or
-.I <strings.h>
-or
-.I <sys/mman.h>
-or
-.I <sys/msg.h>
-or
-.I <sys/sem.h>
-or
-.I <sys/shm.h>
-or
-.I <sys/socket.h>
-or
-.I <sys/uio.h>
-or
-.I <time.h>
-or
-.I <unistd.h>
-or
-.I <wchar.h>
+.IR <sys/types.h> .
+Alternatively,
+.IR <aio.h> ,
+.IR <glob.h> ,
+.IR <grp.h> ,
+.IR <iconv.h> ,
+.IR <monetary.h> ,
+.IR <mqueue.h> ,
+.IR <ndbm.h> ,
+.IR <pwd.h> ,
+.IR <regex.h> ,
+.IR <search.h> ,
+.IR <signal.h> ,
+.IR <stdio.h> ,
+.IR <stdlib.h> ,
+.IR <string.h> ,
+.IR <strings.h> ,
+.IR <sys/mman.h> ,
+.IR <sys/msg.h> ,
+.IR <sys/sem.h> ,
+.IR <sys/shm.h> ,
+.IR <sys/socket.h> ,
+.IR <sys/uio.h> ,
+.IR <time.h> ,
+.IR <unistd.h> ,
+.IR <wchar.h> ,
or
.IR <wordexp.h> .
.PP
@@ -871,21 +833,15 @@ types in this page.
.RS
.br
Include:
-.IR <sys/types.h> ;
-or
-.I <aio.h>
-or
-.I <monetary.h>
-or
-.I <mqueue.h>
-or
-.I <stdio.h>
-or
-.I <sys/msg.h>
-or
-.I <sys/socket.h>
-or
-.I <sys/uio.h>
+.IR <sys/types.h> .
+Alternatively,
+.IR <aio.h> ,
+.IR <monetary.h> ,
+.IR <mqueue.h> ,
+.IR <stdio.h> ,
+.IR <sys/msg.h> ,
+.IR <sys/socket.h> ,
+.IR <sys/uio.h> ,
or
.IR <unistd.h> .
.PP
@@ -947,9 +903,9 @@ types in this page.
.RS
.br
Include:
-.IR <sys/types.h> ;
-or
-.I <sys/select.h>
+.IR <sys/types.h> .
+Alternatively,
+.IR <sys/select.h> ,
or
.IR <sys/time.h> .
.PP
@@ -974,23 +930,17 @@ structure in this page.
.RS
.br
Include:
-.I <sys/types.h>
-or
-.IR <time.h> ;
-or
-.I <sched.h>
-or
-.I <sys/msg.h>
-or
-.I <sys/select.h>
-or
-.I <sys/sem.h>
-or
-.I <sys/shm.h>
-or
-.I <sys/stat.h>
+.I <time.h>
or
-.I <sys/time.h>
+.IR <sys/types.h> .
+Alternatively,
+.IR <sched.h> ,
+.IR <sys/msg.h> ,
+.IR <sys/select.h> ,
+.IR <sys/sem.h> ,
+.IR <sys/shm.h> ,
+.IR <sys/stat.h> ,
+.IR <sys/time.h> ,
or
.IR <utime.h> .
.PP
@@ -1017,8 +967,8 @@ See also:
.RS
.br
Include:
-.IR <sys/types.h> ;
-or
+.IR <sys/types.h> .
+Alternatively,
.IR <time.h> .
.PP
Used for timer ID returned by
@@ -1040,17 +990,13 @@ See also:
.RS
.br
Include:
-.IR <time.h> ;
-or
-.I <aio.h>
-or
-.I <mqueue.h>
-or
-.I <sched.h>
-or
-.I <signal.h>
-or
-.I <sys/select.h>
+.IR <time.h> .
+Alternatively,
+.IR <aio.h> ,
+.IR <mqueue.h> ,
+.IR <sched.h> ,
+.IR <signal.h> ,
+.IR <sys/select.h> ,
or
.IR <sys/stat.h> .
.PP
@@ -1078,11 +1024,10 @@ See also:
.RS
.br
Include:
-.IR <sys/time.h> ;
-or
-.I <sys/resource.h>
-or
-.I <sys/select.h>
+.IR <sys/time.h> .
+Alternatively,
+.IR <sys/resource.h> ,
+.IR <sys/select.h> ,
or
.IR <utmpx.h> .
.PP
@@ -1111,17 +1056,13 @@ See also:
.RS
.br
Include:
-.IR <sys/types.h> ;
-or
-.I <pwd.h>
-or
-.I <signal.h>
-or
-.I <stropts.h>
-or
-.I <sys/ipc.h>
-or
-.I <sys/stat.h>
+.IR <sys/types.h> .
+Alternatively,
+.IR <pwd.h> ,
+.IR <signal.h> ,
+.IR <stropts.h> ,
+.IR <sys/ipc.h> ,
+.IR <sys/stat.h> ,
or
.IR <unistd.h> .
.PP
@@ -1145,9 +1086,9 @@ See also:
.RS
.br
Include:
-.IR <stdarg> ;
-or
-.I <stdio.h>
+.IR <stdarg> .
+Alternatively,
+.IR <stdio.h> ,
or
.IR <wchar.h> .
.PP
--
2.28.0
next prev parent reply other threads:[~2020-09-28 15:17 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 ` Alejandro Colomar [this message]
2020-09-29 10:37 ` [RFC] system_data_types.7: wfix + ffix 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)
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=20200928151646.20271-1-colomar.6.4.3@gmail.com \
--to=colomar.6.4.3@gmail.com \
--cc=Dave.Martin@arm.com \
--cc=g.branden.robinson@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 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).