* [PATCH 8/9] system_data_types.7: Document siginfo_t
From: Alejandro Colomar @ 2020-09-18 17:04 UTC (permalink / raw)
To: mtk.manpages; +Cc: linux-man, libc-alpha, Alejandro Colomar
In-Reply-To: <20200918170442.94920-1-colomar.6.4.3@gmail.com>
Note: There are a few members off this structure that are
not required by POSIX (XSI extensions, and such).
I simply chose to not document them at all.
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---
man7/system_data_types.7 | 35 ++++++++++++++++++++++++++++++++---
1 file changed, 32 insertions(+), 3 deletions(-)
diff --git a/man7/system_data_types.7 b/man7/system_data_types.7
index f7d25bec9..b705ed5ae 100644
--- a/man7/system_data_types.7
+++ b/man7/system_data_types.7
@@ -213,6 +213,35 @@ See also:
See also the
.I aiocb
structure in this page.
+.\"------------------------------------- siginfo_t --------------------/
+.TP
+.I siginfo_t
+.IP
+Include:
+.IR <signal.h> ;
+or
+.IR <sys/wait.h> .
+.IP
+.EX
+typedef struct {
+ int si_signo; /* Signal number */
+ int si_code; /* Signal code */
+
+ pid_t si_pid; /* Sending process ID */
+ uid_t si_uid; /* Real user ID of sending process */
+ void *si_addr; /* Address of faulting instruction */
+ int si_status; /* Exit value or signal */
+
+ union sigval si_value; /* Signal value */
+} siginfo_t;
+.EE
+.\".IP
+.\" FIXME: Add a description?
+.IP
+Conforming to: POSIX.1-2001 and later.
+.IP
+See also:
+.BR regexec (3)
.\"------------------------------------- sigval -----------------------/
.TP
.I sigval
@@ -239,9 +268,9 @@ See also:
See also the
.I sigevent
structure
-.\"and the
-.\".I siginfo_t FIXME
-.\"type
+and the
+.I siginfo_t
+type
in this page.
.\"------------------------------------- size_t -----------------------/
.TP
--
2.28.0
^ permalink raw reply related
* [PATCH 7/9] aiocb.3: New link to new documented type in system_data_types(7)
From: Alejandro Colomar @ 2020-09-18 17:04 UTC (permalink / raw)
To: mtk.manpages; +Cc: linux-man, libc-alpha, Alejandro Colomar
In-Reply-To: <20200918170442.94920-1-colomar.6.4.3@gmail.com>
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---
man3/aiocb.3 | 1 +
1 file changed, 1 insertion(+)
create mode 100644 man3/aiocb.3
diff --git a/man3/aiocb.3 b/man3/aiocb.3
new file mode 100644
index 000000000..db50c0f09
--- /dev/null
+++ b/man3/aiocb.3
@@ -0,0 +1 @@
+.so man7/system_data_types.7
--
2.28.0
^ permalink raw reply related
* [PATCH 6/9] system_data_types.7: Document aiocb
From: Alejandro Colomar @ 2020-09-18 17:04 UTC (permalink / raw)
To: mtk.manpages; +Cc: linux-man, libc-alpha, Alejandro Colomar
In-Reply-To: <20200918170442.94920-1-colomar.6.4.3@gmail.com>
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---
man7/system_data_types.7 | 40 ++++++++++++++++++++++++++++++++++++----
1 file changed, 36 insertions(+), 4 deletions(-)
diff --git a/man7/system_data_types.7 b/man7/system_data_types.7
index 8c0c78954..f7d25bec9 100644
--- a/man7/system_data_types.7
+++ b/man7/system_data_types.7
@@ -61,6 +61,38 @@ system_data_types \- overview of system data types
.\" * Notes (optional)
.\"
.\" * See also
+.\"------------------------------------- aiocb ------------------------/
+.TP
+.I aiocb
+.IP
+Include:
+.IR <aio.h> .
+.IP
+.EX
+struct aiocb {
+ int aio_fildes; /* File descriptor */
+ off_t aio_offset; /* File offset */
+ volatile void *aio_buf; /* Location of buffer */
+ size_t aio_nbytes; /* Length of transfer */
+ int aio_reqprio; /* Request priority offset */
+ struct sigevent aio_sigevent; /* Signal number and value */
+ int aio_lio_opcode;/* Operation to be performed */
+};
+.EE
+.\".IP
+.\" FIXME: Add a description?
+.IP
+Conforming to: POSIX.1-2001 and later.
+.IP
+See also:
+.BR aio_cancel (3),
+.BR aio_error (3),
+.BR aio_fsync (3),
+.BR aio_read (3),
+.BR aio_return (3),
+.BR aio_suspend (3),
+.BR aio_write (3),
+.BR lio_listio (3)
.\"------------------------------------- ptrdiff_t --------------------/
.TP
.I ptrdiff_t
@@ -177,10 +209,10 @@ See also:
.BR getaddrinfo_a (3),
.BR lio_listio (3),
.BR mq_notify (3)
-.\".IP
-.\"See also the
-.\".I aiocb FIXME
-.\"structure in this page.
+.IP
+See also the
+.I aiocb
+structure in this page.
.\"------------------------------------- sigval -----------------------/
.TP
.I sigval
--
2.28.0
^ permalink raw reply related
* [PATCH 5/9] system_data_types.7: srcfix: cosmetic: Visually sparate types
From: Alejandro Colomar @ 2020-09-18 17:04 UTC (permalink / raw)
To: mtk.manpages; +Cc: linux-man, libc-alpha, Alejandro Colomar
In-Reply-To: <20200918170442.94920-1-colomar.6.4.3@gmail.com>
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---
man7/system_data_types.7 | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/man7/system_data_types.7 b/man7/system_data_types.7
index 53c289e31..8c0c78954 100644
--- a/man7/system_data_types.7
+++ b/man7/system_data_types.7
@@ -61,6 +61,7 @@ system_data_types \- overview of system data types
.\" * Notes (optional)
.\"
.\" * See also
+.\"------------------------------------- ptrdiff_t --------------------/
.TP
.I ptrdiff_t
.IP
@@ -81,6 +82,7 @@ See also the
and
.I ssize_t
types in this page.
+.\"------------------------------------- regmatch_t -------------------/
.TP
.I regmatch_t
.IP
@@ -103,6 +105,7 @@ Conforming to: POSIX.1-2001 and later.
.IP
See also:
.BR regexec (3)
+.\"------------------------------------- regoff_t ---------------------/
.TP
.I regoff_t
.IP
@@ -132,6 +135,7 @@ structure and the
and
.I ssize_t
types in this page.
+.\"------------------------------------- sigevent ---------------------/
.TP
.I sigevent
.IP
@@ -177,6 +181,7 @@ See also:
.\"See also the
.\".I aiocb FIXME
.\"structure in this page.
+.\"------------------------------------- sigval -----------------------/
.TP
.I sigval
.IP
@@ -206,6 +211,7 @@ structure
.\".I siginfo_t FIXME
.\"type
in this page.
+.\"------------------------------------- size_t -----------------------/
.TP
.I size_t
.IP
@@ -301,6 +307,7 @@ See also the
and
.I ssize_t
types in this page.
+.\"------------------------------------- ssize_t ----------------------/
.TP
.I ssize_t
.IP
@@ -343,6 +350,7 @@ See also the
and
.I size_t
types in this page.
+.\"------------------------------------- suseconds_t ------------------/
.TP
.I suseconds_t
.IP
@@ -362,6 +370,7 @@ Conforming to: POSIX.1-2001 and later.
See also the
.I timeval
structure in this page.
+.\"------------------------------------- time_t -----------------------/
.TP
.I time_t
.IP
@@ -402,6 +411,7 @@ See also:
.BR time (2),
.BR ctime (3),
.BR difftime (3)
+.\"------------------------------------- timer_t ----------------------/
.TP
.I timer_t
.IP
@@ -422,6 +432,7 @@ See also:
.BR timer_delete (2),
.BR timer_getoverrun (2),
.BR timer_settime (2)
+.\"------------------------------------- timespec ---------------------/
.TP
.I timespec
.IP
@@ -457,6 +468,7 @@ See also:
.BR nanosleep (2),
.BR timerfd_gettime (2),
.BR timer_gettime (2)
+.\"------------------------------------- timeval ----------------------/
.TP
.I timeval
.IP
--
2.28.0
^ permalink raw reply related
* [PATCH 4/9] sigevent.3: New link to new documented type in system_data_types(7)
From: Alejandro Colomar @ 2020-09-18 17:04 UTC (permalink / raw)
To: mtk.manpages; +Cc: linux-man, libc-alpha, Alejandro Colomar
In-Reply-To: <20200918170442.94920-1-colomar.6.4.3@gmail.com>
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---
man3/sigevent.3 | 1 +
1 file changed, 1 insertion(+)
create mode 100644 man3/sigevent.3
diff --git a/man3/sigevent.3 b/man3/sigevent.3
new file mode 100644
index 000000000..db50c0f09
--- /dev/null
+++ b/man3/sigevent.3
@@ -0,0 +1 @@
+.so man7/system_data_types.7
--
2.28.0
^ permalink raw reply related
* [PATCH 3/9] system_data_types.7: Document sigevent
From: Alejandro Colomar @ 2020-09-18 17:04 UTC (permalink / raw)
To: mtk.manpages; +Cc: linux-man, libc-alpha, Alejandro Colomar
In-Reply-To: <20200918170442.94920-1-colomar.6.4.3@gmail.com>
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---
man7/system_data_types.7 | 57 ++++++++++++++++++++++++++++++++++++----
1 file changed, 52 insertions(+), 5 deletions(-)
diff --git a/man7/system_data_types.7 b/man7/system_data_types.7
index 48871e4eb..53c289e31 100644
--- a/man7/system_data_types.7
+++ b/man7/system_data_types.7
@@ -133,6 +133,51 @@ and
.I ssize_t
types in this page.
.TP
+.I sigevent
+.IP
+Include:
+.IR <signal.h> ;
+or
+.I <aio.h>
+or
+.I <mqueue.h>
+or
+.IR <time.h> .
+.IP
+.EX
+struct sigevent {
+ int sigev_notify; /* Notification type */
+ int sigev_signo; /* Signal number */
+ union sigval sigev_value; /* Signal value */
+ void (*sigev_notify_function)(union sigval);
+ /* Notification function */
+ pthread_attr_t *sigev_notify_attributes;
+ /* Notification attributes */
+};
+.EE
+.\".IP
+.\" FIXME: Add a description?
+.IP
+Conforming to: POSIX.1-2001 and later.
+.IP
+Notes:
+.I <aio.h>
+and
+.I <time.h>
+define
+.I sigevent
+since POSIX.1-2008.
+.IP
+See also:
+.BR timer_create (2),
+.BR getaddrinfo_a (3),
+.BR lio_listio (3),
+.BR mq_notify (3)
+.\".IP
+.\"See also the
+.\".I aiocb FIXME
+.\"structure in this page.
+.TP
.I sigval
.IP
Include:
@@ -153,12 +198,14 @@ See also:
.BR pthread_sigqueue (3),
.BR sigqueue (3),
.BR sigevent (7)
-.\".IP
-.\"See also the
-.\".I sigevent FIXME
-.\"structure and the
+.IP
+See also the
+.I sigevent
+structure
+.\"and the
.\".I siginfo_t FIXME
-.\"type in this page.
+.\"type
+in this page.
.TP
.I size_t
.IP
--
2.28.0
^ permalink raw reply related
* [PATCH 2/9] system_data_types.7: srcfix: Add FIXME note: Add descriptions
From: Alejandro Colomar @ 2020-09-18 17:04 UTC (permalink / raw)
To: mtk.manpages; +Cc: linux-man, libc-alpha, Alejandro Colomar
In-Reply-To: <20200918170442.94920-1-colomar.6.4.3@gmail.com>
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---
man7/system_data_types.7 | 2 ++
1 file changed, 2 insertions(+)
diff --git a/man7/system_data_types.7 b/man7/system_data_types.7
index 5352f3ef2..48871e4eb 100644
--- a/man7/system_data_types.7
+++ b/man7/system_data_types.7
@@ -96,6 +96,8 @@ typedef struct {
* the end of substring */
} regmatch_t;
.EE
+.\".IP
+.\" FIXME: Add a description?
.IP
Conforming to: POSIX.1-2001 and later.
.IP
--
2.28.0
^ permalink raw reply related
* [PATCH 0/9] Document aiocb, sigevent, siginfo_t
From: Alejandro Colomar @ 2020-09-18 17:04 UTC (permalink / raw)
To: mtk.manpages; +Cc: linux-man, libc-alpha, Alejandro Colomar
Hello Michael,
Here is a bigger patchset documenting a few types + a few fixes.
(apply after regmatch_t patches).
Cheers,
Alex
P.S.: Eso es todo por hoy :)
Alejandro Colomar (9):
system_data_types.7: ffix
system_data_types.7: srcfix: Add FIXME note: Add descriptions
system_data_types.7: Document sigevent
sigevent.3: New link to new documented type in system_data_types(7)
system_data_types.7: srcfix: cosmetic: Visually sparate types
system_data_types.7: Document aiocb
aiocb.3: New link to new documented type in system_data_types(7)
system_data_types.7: Document siginfo_t
siginfo_t.3: New link to new documented type in system_data_types(7)
man3/aiocb.3 | 1 +
man3/sigevent.3 | 1 +
man3/siginfo_t.3 | 1 +
man7/system_data_types.7 | 138 ++++++++++++++++++++++++++++++++++++---
4 files changed, 133 insertions(+), 8 deletions(-)
create mode 100644 man3/aiocb.3
create mode 100644 man3/sigevent.3
create mode 100644 man3/siginfo_t.3
--
2.28.0
^ permalink raw reply
* [PATCH 1/9] system_data_types.7: ffix
From: Alejandro Colomar @ 2020-09-18 17:04 UTC (permalink / raw)
To: mtk.manpages; +Cc: linux-man, libc-alpha, Alejandro Colomar
In-Reply-To: <20200918170442.94920-1-colomar.6.4.3@gmail.com>
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---
man7/system_data_types.7 | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/man7/system_data_types.7 b/man7/system_data_types.7
index eb4718491..5352f3ef2 100644
--- a/man7/system_data_types.7
+++ b/man7/system_data_types.7
@@ -232,9 +232,9 @@ Notes:
.IR <iconv.h> ,
.IR <mqueue.h> ,
.IR <pwd.h> ,
-.IR <signal.h>
+.I <signal.h>
and
-.IR <sys/socket.h>
+.I <sys/socket.h>
define
.I size_t
since POSIX.1-2008.
--
2.28.0
^ permalink raw reply related
* Re: [PATCH 1/2] system_data_types.7: Document size_t
From: Alejandro Colomar @ 2020-09-18 15:53 UTC (permalink / raw)
To: Florian Weimer, Alejandro Colomar via Libc-alpha; +Cc: mtk.manpages, linux-man
In-Reply-To: <87tuvv5f24.fsf@oldenburg2.str.redhat.com>
Hello Florian,
On 2020-09-18 16:34, Florian Weimer wrote:
> * Alejandro Colomar via Libc-alpha:
>
>> +Used for a count of bytes. It is the result of the
>> +.I sizeof
>> +operator.
>> +According to the C language standard,
>> +it shall be an unsigned integer type
>> +capable of storing values in the range [0,
>> +.BR SIZE_MAX ].
>
> Thanks for working on this.
:-)
> Maybe add that this commonly maps to unsigned int or unsigned long, and
I thought the same in the beginning,
but then Michael convinced me to not do it.
On 2020-09-13 22:20, Michael Kerrisk (man-pages) wrote:
>>>> Is it a 32-bit or 64-bit or may vary? Is it signed or unsigned?
>>> POSIX doesn't specify, I think.>
>>> One other thing the page should show of course is definition of the
>>> structure types.
>> Yes.
>>
>>
>> timer_t <time.h> or <sys/types.h>
>> POSIX timer ID.
>>
>> typedef void *timer_t;
> Here I would *not* show these kinds of typedefs. The point is
> that these types should be treated as being somewhat unknown
> (e.g., for casts in printf()). Here, I think instead maybe we
> just have a statement that POSIX makes no specific requirements
> for the representation of this type.
I think I prefer to leave it opaque, showing only the requirements
that POSIX and C make.
There's really not much gain (basically uint and ulong cover most of the
possibilities; and still it's not a guarantee).
And readers might write non-portable code because of reading that.
On 2020-09-18 16:34, Florian Weimer wrote:
> that the length modifier for printf and scanf is z, commently used as
> %zu or %zx (%zd is for ssize_t).
Good idea.
Would you prefer that, or just refer to printf(3) in See also?.
>
> Florian
>
Thanks,
Alex
^ permalink raw reply
* Re: [PATCH 1/2] system_data_types.7: Document size_t
From: Florian Weimer @ 2020-09-18 14:34 UTC (permalink / raw)
To: Alejandro Colomar via Libc-alpha
Cc: mtk.manpages, Alejandro Colomar, linux-man
In-Reply-To: <20200918112755.21428-2-colomar.6.4.3@gmail.com>
* Alejandro Colomar via Libc-alpha:
> +Used for a count of bytes. It is the result of the
> +.I sizeof
> +operator.
> +According to the C language standard,
> +it shall be an unsigned integer type
> +capable of storing values in the range [0,
> +.BR SIZE_MAX ].
Thanks for working on this.
Maybe add that this commonly maps to unsigned int or unsigned long, and
that the length modifier for printf and scanf is z, commently used as
%zu or %zx (%zd is for ssize_t).
Florian
--
Red Hat GmbH, https://de.redhat.com/ , Registered seat: Grasbrunn,
Commercial register: Amtsgericht Muenchen, HRB 153243,
Managing Directors: Charles Cachera, Brian Klemm, Laurie Krebs, Michael O'Neill
^ permalink raw reply
* [PATCH 3/3] regmatch_t.3: New page for new documented type in system_data_types(7)
From: Alejandro Colomar @ 2020-09-18 13:29 UTC (permalink / raw)
To: mtk.manpages; +Cc: linux-man, libc-alpha, Alejandro Colomar
In-Reply-To: <20200918132943.55424-1-colomar.6.4.3@gmail.com>
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---
man3/regmatch_t.3 | 1 +
1 file changed, 1 insertion(+)
create mode 100644 man3/regmatch_t.3
diff --git a/man3/regmatch_t.3 b/man3/regmatch_t.3
new file mode 100644
index 000000000..db50c0f09
--- /dev/null
+++ b/man3/regmatch_t.3
@@ -0,0 +1 @@
+.so man7/system_data_types.7
--
2.28.0
^ permalink raw reply related
* [PATCH 2/3] system_data_types.7: Document regmatch_t
From: Alejandro Colomar @ 2020-09-18 13:29 UTC (permalink / raw)
To: mtk.manpages; +Cc: linux-man, libc-alpha, Alejandro Colomar
In-Reply-To: <20200918132943.55424-1-colomar.6.4.3@gmail.com>
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---
man7/system_data_types.7 | 23 +++++++++++++++++++++--
1 file changed, 21 insertions(+), 2 deletions(-)
diff --git a/man7/system_data_types.7 b/man7/system_data_types.7
index 2ccbfe817..d3dee2747 100644
--- a/man7/system_data_types.7
+++ b/man7/system_data_types.7
@@ -82,6 +82,25 @@ and
.I ssize_t
types in this page.
.TP
+.I regmatch_t
+.IP
+Include:
+.IR <regex.h> .
+.IP
+.EX
+typedef struct {
+ regoff_t rm_so; /* Byte offset from start of string
+ * to start of substring */
+ regoff_t rm_eo; /* Byte offset from start of string of the
+ * first character after the end of substring */
+} regmatch_t;
+.EE
+.IP
+Conforming to: POSIX.1-2001 and later.
+.IP
+See also:
+.BR regexec (3)
+.TP
.I regoff_t
.IP
Include:
@@ -104,8 +123,8 @@ type or a
type.
.IP
See also the
-.\".I regmatch_t FIXME
-.\"structure and the
+.I regmatch_t
+structure and the
.I ptrdiff_t
and
.I ssize_t
--
2.28.0
^ permalink raw reply related
* [PATCH 1/3] system_data_types.7: ffix
From: Alejandro Colomar @ 2020-09-18 13:29 UTC (permalink / raw)
To: mtk.manpages; +Cc: linux-man, libc-alpha, Alejandro Colomar
In-Reply-To: <20200918132943.55424-1-colomar.6.4.3@gmail.com>
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---
man7/system_data_types.7 | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/man7/system_data_types.7 b/man7/system_data_types.7
index 16dcb7d66..2ccbfe817 100644
--- a/man7/system_data_types.7
+++ b/man7/system_data_types.7
@@ -65,7 +65,7 @@ system_data_types \- overview of system data types
.I ptrdiff_t
.IP
Include:
-.I <stddef.h>.
+.IR <stddef.h> .
.IP
Used for a count of elements, and array indices.
It is the result of subtracting two pointers.
@@ -85,7 +85,7 @@ types in this page.
.I regoff_t
.IP
Include:
-.I <regex.h>.
+.IR <regex.h> .
.IP
According to POSIX, it shall be a signed integer type
capable of storing the largest value that can be stored in either a
--
2.28.0
^ permalink raw reply related
* [PATCH 0/3] Document regmatch_t (and a ffix)
From: Alejandro Colomar @ 2020-09-18 13:29 UTC (permalink / raw)
To: mtk.manpages; +Cc: linux-man, libc-alpha, Alejandro Colomar
Hi Michael,
Documentation for regmatch_t + a ffix patch.
(apply after regoff_t patches).
Thanks,
Alex
Alejandro Colomar (3):
system_data_types.7: ffix
system_data_types.7: Document regmatch_t
regmatch_t.3: New page for new documented type in system_data_types(7)
man3/regmatch_t.3 | 1 +
man7/system_data_types.7 | 27 +++++++++++++++++++++++----
2 files changed, 24 insertions(+), 4 deletions(-)
create mode 100644 man3/regmatch_t.3
--
2.28.0
^ permalink raw reply
* [PATCH 4/4] system_data_types.7: srcfix: Add FIXME notes
From: Alejandro Colomar @ 2020-09-18 12:45 UTC (permalink / raw)
To: mtk.manpages; +Cc: linux-man, libc-alpha, Alejandro Colomar
In-Reply-To: <20200918124554.46308-1-colomar.6.4.3@gmail.com>
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---
man7/system_data_types.7 | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/man7/system_data_types.7 b/man7/system_data_types.7
index d96703b1d..16dcb7d66 100644
--- a/man7/system_data_types.7
+++ b/man7/system_data_types.7
@@ -133,9 +133,9 @@ See also:
.BR sigevent (7)
.\".IP
.\"See also the
-.\".I sigevent
+.\".I sigevent FIXME
.\"structure and the
-.\".I siginfo_t
+.\".I siginfo_t FIXME
.\"type in this page.
.TP
.I size_t
--
2.28.0
^ permalink raw reply related
* [PATCH 3/4] regoff_t.3: New link to new documented type in system_data_types(7)
From: Alejandro Colomar @ 2020-09-18 12:45 UTC (permalink / raw)
To: mtk.manpages; +Cc: linux-man, libc-alpha, Alejandro Colomar
In-Reply-To: <20200918124554.46308-1-colomar.6.4.3@gmail.com>
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---
man3/regoff_t.3 | 1 +
1 file changed, 1 insertion(+)
create mode 100644 man3/regoff_t.3
diff --git a/man3/regoff_t.3 b/man3/regoff_t.3
new file mode 100644
index 000000000..db50c0f09
--- /dev/null
+++ b/man3/regoff_t.3
@@ -0,0 +1 @@
+.so man7/system_data_types.7
--
2.28.0
^ permalink raw reply related
* [PATCH 1/4] system_data_types.7: wfix
From: Alejandro Colomar @ 2020-09-18 12:45 UTC (permalink / raw)
To: mtk.manpages; +Cc: linux-man, libc-alpha, Alejandro Colomar
In-Reply-To: <20200918124554.46308-1-colomar.6.4.3@gmail.com>
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---
man7/system_data_types.7 | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/man7/system_data_types.7 b/man7/system_data_types.7
index dba80cf6f..8969ee966 100644
--- a/man7/system_data_types.7
+++ b/man7/system_data_types.7
@@ -350,7 +350,7 @@ struct timespec {
};
.EE
.IP
-Describes times in seconds and nanoseconds.
+Describes elapsed time in seconds and nanoseconds.
.IP
Conforming to: C11 and later; POSIX.1-2001 and later.
.IP
@@ -379,7 +379,7 @@ struct timeval {
};
.EE
.IP
-Describes times in seconds and microseconds.
+Describes elapsed time in seconds and microseconds.
.IP
Conforming to: POSIX.1-2001 and later.
.IP
--
2.28.0
^ permalink raw reply related
* [PATCH 0/4] Document regoff_t (and a few minor patches)
From: Alejandro Colomar @ 2020-09-18 12:45 UTC (permalink / raw)
To: mtk.manpages; +Cc: linux-man, libc-alpha, Alejandro Colomar
Hi Michael,
Documentation for regoff_t + a few minor patches.
(apply after ptrdiff_t patches)
I removed the reference from ptrdiff_t to regoff_t, as it is not really
relevant to ptrdiff_t.
I see this is fast, so maybe I'll start sending bigger patchsets.
That way it'll be easier for you to apply them sorted.
Cheers,
Alex.
Alejandro Colomar (4):
system_data_types.7: wfix
system_data_types.7: Document regoff_t
regoff_t.3: New link to new documented type in system_data_types(7)
system_data_types.7: srcfix: Add FIXME notes
man3/regoff_t.3 | 1 +
man7/system_data_types.7 | 38 +++++++++++++++++++++++++++++++++-----
2 files changed, 34 insertions(+), 5 deletions(-)
create mode 100644 man3/regoff_t.3
--
2.28.0
^ permalink raw reply
* [PATCH 2/4] system_data_types.7: Document regoff_t
From: Alejandro Colomar @ 2020-09-18 12:45 UTC (permalink / raw)
To: mtk.manpages; +Cc: linux-man, libc-alpha, Alejandro Colomar
In-Reply-To: <20200918124554.46308-1-colomar.6.4.3@gmail.com>
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---
man7/system_data_types.7 | 30 +++++++++++++++++++++++++++++-
1 file changed, 29 insertions(+), 1 deletion(-)
diff --git a/man7/system_data_types.7 b/man7/system_data_types.7
index 8969ee966..d96703b1d 100644
--- a/man7/system_data_types.7
+++ b/man7/system_data_types.7
@@ -77,12 +77,40 @@ capable of storing values in the range
Conforming to: C99 and later; POSIX.1-2001 and later.
.IP
See also the
-.\".I regoff_t , FIXME: uncomment when regoff_t is documented.
.I size_t
and
.I ssize_t
types in this page.
.TP
+.I regoff_t
+.IP
+Include:
+.I <regex.h>.
+.IP
+According to POSIX, it shall be a signed integer type
+capable of storing the largest value that can be stored in either a
+.I ptrdiff_t
+type or a
+.I ssize_t
+type.
+.IP
+Conforming to: POSIX.1-2001 and later.
+.IP
+Notes: Prior to POSIX.1-2008, the type was capable of storing
+the largest value that can be stored in either an
+.I off_t
+type or a
+.I ssize_t
+type.
+.IP
+See also the
+.\".I regmatch_t FIXME
+.\"structure and the
+.I ptrdiff_t
+and
+.I ssize_t
+types in this page.
+.TP
.I sigval
.IP
Include:
--
2.28.0
^ permalink raw reply related
* [PATCH 4/4] ptrdiff_t.3: New link to new documented type in system_data_types(7)
From: Alejandro Colomar @ 2020-09-18 12:04 UTC (permalink / raw)
To: mtk.manpages; +Cc: linux-man, libc-alpha, Alejandro Colomar
In-Reply-To: <20200918120440.30281-1-colomar.6.4.3@gmail.com>
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---
man3/ptrdiff_t.3 | 1 +
1 file changed, 1 insertion(+)
create mode 100644 man3/ptrdiff_t.3
diff --git a/man3/ptrdiff_t.3 b/man3/ptrdiff_t.3
new file mode 100644
index 000000000..db50c0f09
--- /dev/null
+++ b/man3/ptrdiff_t.3
@@ -0,0 +1 @@
+.so man7/system_data_types.7
--
2.28.0
^ permalink raw reply related
* [PATCH 3/4] system_data_types.7: Document ptrdiff_t
From: Alejandro Colomar @ 2020-09-18 12:04 UTC (permalink / raw)
To: mtk.manpages; +Cc: linux-man, libc-alpha, Alejandro Colomar
In-Reply-To: <20200918120440.30281-1-colomar.6.4.3@gmail.com>
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---
man7/system_data_types.7 | 25 ++++++++++++++++++++++++-
1 file changed, 24 insertions(+), 1 deletion(-)
diff --git a/man7/system_data_types.7 b/man7/system_data_types.7
index 5ef470386..8969ee966 100644
--- a/man7/system_data_types.7
+++ b/man7/system_data_types.7
@@ -62,6 +62,27 @@ system_data_types \- overview of system data types
.\"
.\" * See also
.TP
+.I ptrdiff_t
+.IP
+Include:
+.I <stddef.h>.
+.IP
+Used for a count of elements, and array indices.
+It is the result of subtracting two pointers.
+According to the C language standard, it shall be a signed integer type
+capable of storing values in the range
+.BR "" [ PTRDIFF_MIN ,
+.BR PTRDIFF_MAX ].
+.IP
+Conforming to: C99 and later; POSIX.1-2001 and later.
+.IP
+See also the
+.\".I regoff_t , FIXME: uncomment when regoff_t is documented.
+.I size_t
+and
+.I ssize_t
+types in this page.
+.TP
.I sigval
.IP
Include:
@@ -221,8 +242,10 @@ See also:
.BR write (2)
.IP
See also the
+.I ptrdiff_t
+and
.I size_t
-type in this page.
+types in this page.
.TP
.I suseconds_t
.IP
--
2.28.0
^ permalink raw reply related
* [PATCH 2/4] system_data_types.7: wfix: sort referenced types
From: Alejandro Colomar @ 2020-09-18 12:04 UTC (permalink / raw)
To: mtk.manpages; +Cc: linux-man, libc-alpha, Alejandro Colomar
In-Reply-To: <20200918120440.30281-1-colomar.6.4.3@gmail.com>
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---
man7/system_data_types.7 | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/man7/system_data_types.7 b/man7/system_data_types.7
index 72afe9e81..5ef470386 100644
--- a/man7/system_data_types.7
+++ b/man7/system_data_types.7
@@ -179,9 +179,9 @@ See also:
.BR offsetof (3)
.IP
See also the
-.I ssize_t
-and
.I ptrdiff_t
+and
+.I ssize_t
types in this page.
.TP
.I ssize_t
--
2.28.0
^ permalink raw reply related
* [PATCH 1/4] system_data_types.7: srcfix: Remove TODO comment
From: Alejandro Colomar @ 2020-09-18 12:04 UTC (permalink / raw)
To: mtk.manpages; +Cc: linux-man, libc-alpha, Alejandro Colomar
In-Reply-To: <20200918120440.30281-1-colomar.6.4.3@gmail.com>
Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---
man7/system_data_types.7 | 3 ---
1 file changed, 3 deletions(-)
diff --git a/man7/system_data_types.7 b/man7/system_data_types.7
index 041e7e243..72afe9e81 100644
--- a/man7/system_data_types.7
+++ b/man7/system_data_types.7
@@ -27,9 +27,6 @@
.SH NAME
system_data_types \- overview of system data types
.SH DESCRIPTION
-.\" TODO:
-.\" * Add types
-.\" * Curate "See also"
.\" Layout:
.\" A list of type names (the struct/union keyword will be omitted).
.\" Each entry will have the following parts:
--
2.28.0
^ permalink raw reply related
* [PATCH 0/4] Document ptrdiff_t (and a few minor patches)
From: Alejandro Colomar @ 2020-09-18 12:04 UTC (permalink / raw)
To: mtk.manpages; +Cc: linux-man, libc-alpha, Alejandro Colomar
Hi Michael,
Documentation for ptrdiff_t + a few minor patches.
(apply after size_t patches)
Cheers,
Alex.
Alejandro Colomar (4):
system_data_types.7: srcfix: Remove TODO comment
system_data_types.7: wfix: sort referenced types
system_data_types.7: Document ptrdiff_t
ptrdiff_t.3: New link to new documented type in system_data_types(7)
man3/ptrdiff_t.3 | 1 +
man7/system_data_types.7 | 32 ++++++++++++++++++++++++++------
2 files changed, 27 insertions(+), 6 deletions(-)
create mode 100644 man3/ptrdiff_t.3
--
2.28.0
^ permalink raw reply
page: next (older) | prev (newer) | latest
- recent:[subjects (threaded)|topics (new)|topics (active)]
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox