diff mbox series

[3/9] system_data_types.7: Document sigevent

Message ID	20200918170442.94920-4-colomar.6.4.3@gmail.com
State	Not applicable
Headers	DMARC-Filter: OpenDMARC Filter v1.3.2 sourceware.org A8BAE3972456 To: mtk.manpages@gmail.com Subject: [PATCH 3/9] system_data_types.7: Document sigevent Date: Fri, 18 Sep 2020 19:04:37 +0200 Message-Id: <20200918170442.94920-4-colomar.6.4.3@gmail.com> In-Reply-To: <20200918170442.94920-1-colomar.6.4.3@gmail.com> References: <20200918170442.94920-1-colomar.6.4.3@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Precedence: list From: Alejandro Colomar via Libc-alpha <libc-alpha@sourceware.org> Reply-To: Alejandro Colomar <colomar.6.4.3@gmail.com> Cc: Alejandro Colomar <colomar.6.4.3@gmail.com>, linux-man@vger.kernel.org, libc-alpha@sourceware.org Errors-To: libc-alpha-bounces@sourceware.org Sender: "Libc-alpha" <libc-alpha-bounces@sourceware.org>
Series	Document aiocb, sigevent, siginfo_t \| [0/9] Document aiocb, sigevent, siginfo_t [1/9] system_data_types.7: ffix [2/9] system_data_types.7: srcfix: Add FIXME note: Add descriptions [3/9] system_data_types.7: Document sigevent [4/9] sigevent.3: New link to new documented type in system_data_types(7) [5/9] system_data_types.7: srcfix: cosmetic: Visually sparate types [6/9] system_data_types.7: Document aiocb [7/9] aiocb.3: New link to new documented type in system_data_types(7) [8/9] system_data_types.7: Document siginfo_t [9/9] siginfo_t.3: New link to new documented type in system_data_types(7)

Commit Message

Alejandro Colomar Sept. 18, 2020, 5:04 p.m. UTC

  Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---
 man7/system_data_types.7 | 57 ++++++++++++++++++++++++++++++++++++----
 1 file changed, 52 insertions(+), 5 deletions(-)

Comments

Michael Kerrisk \(man-pages\) Sept. 18, 2020, 9:09 p.m. UTC | #1

Hello Alex,

On 9/18/20 7:04 PM, Alejandro Colomar wrote:
> Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
> ---
>  man7/system_data_types.7 | 57 ++++++++++++++++++++++++++++++++++++----
>  1 file changed, 52 insertions(+), 5 deletions(-)


Thanks, Alex. Patch applied. I added a line re description, 
deferring to sigevent(7).

Cheers,

Michael


> 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
>

Alejandro Colomar Sept. 18, 2020, 9:36 p.m. UTC | #2

On 2020-09-18 23:09, Michael Kerrisk (man-pages) wrote:
> Hello Alex,
> 
> On 9/18/20 7:04 PM, Alejandro Colomar wrote:
>> Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
>> ---
>>   man7/system_data_types.7 | 57 ++++++++++++++++++++++++++++++++++++----
>>   1 file changed, 52 insertions(+), 5 deletions(-)
> 
> 
> Thanks, Alex. Patch applied. I added a line re description,
> deferring to sigevent(7).
> 
> Cheers,
> 
> Michael

Thanks, Michael.

Cheers,

Alex

diff mbox series

Patch

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