HomeFreeBSD

MFC 302899: Add documentation for the sigevent structure.

Description

MFC 302899: Add documentation for the sigevent structure.

  • Add a sigevent(3) manpage to give a general overview of the sigevent structure and the available notification mechanisms.
  • Document that AIO requests contain a nested sigevent structure that can be used to request completion notification.
  • Expand the sigevent details in other manuals to note details such as the extra values stored in a queued signal's information or in a posted kevent.

Details

Provenance
jhbAuthored on
Parents
rS303324: MFC 302899: Add documentation for the sigevent structure.
Branches
Unknown
Tags
Unknown

Event Timeline

wblock added inline comments.
/stable/10/lib/libc/sys/aio_fsync.2
77

"request" is repeated and could be confused. Maybe just "ask for" for the first one?

96

Rearrange this to not be interrupted:

Modifications of the Asynchronous I/O Control Block structure or the
buffer contents are not allowed after the request has been enqueued
but not yet completed.
/stable/10/lib/libc/sys/aio_mlock.2
70

Double "request". Replace the first with "ask for" (or something better, but it's Friday afternoon so I can't think of anything better).

/stable/10/lib/libc/sys/aio_read.2
85

Double "request". There must be a better way to say this.

/stable/10/lib/libc/sys/aio_write.2
91

Double "request". One is a verb, one is a noun.

/stable/9/lib/libc/sys/aio_fsync.2
96

As above, rearrange to make less halting.

/stable/9/lib/libc/sys/aio_read.2
85

Double "request".

/stable/9/lib/libc/sys/aio_write.2
91

Double "request".