[Bug 210469] aio_xxx(3) manpages do not detail struct aiocb

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

[Bug 210469] aio_xxx(3) manpages do not detail struct aiocb

bugzilla-noreply
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=210469

            Bug ID: 210469
           Summary: aio_xxx(3) manpages do not detail struct aiocb
           Product: Documentation
           Version: Latest
          Hardware: Any
                OS: Any
            Status: New
          Severity: Affects Only Me
          Priority: ---
         Component: Documentation
          Assignee: [hidden email]
          Reporter: [hidden email]

compare aio_write(3) to poll(2). While the former mentions the structure
members scattered through the text, poll(2) gives a (view of the public
interface of) struct pollfd. This is helpful information as it prevents you
from hunting header files just to see the members of the struct you ought to
touch and is generally IMO preferable to just scattering member mentions
through the prose of the description.
Suggest documenting the (public API portion of) struct aiocb in aio_xxx(3)

--
You are receiving this mail because:
You are the assignee for the bug.
_______________________________________________
[hidden email] mailing list
https://lists.freebsd.org/mailman/listinfo/freebsd-doc
To unsubscribe, send any mail to "[hidden email]"