Bug 210469 - aio_xxx(3) manpages do not detail struct aiocb
Summary: aio_xxx(3) manpages do not detail struct aiocb
Status: Open
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Only Me
Assignee: freebsd-bugs (Nobody)
Keywords: easy, patch
Depends on:
Reported: 2016-06-22 16:02 UTC by Martin S. Weber
Modified: 2021-10-01 06:33 UTC (History)
2 users (show)

See Also:

aio_read(2) and aio_write(2) patch (2.25 KB, patch)
2021-09-26 00:38 UTC, Felix Johnson
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Martin S. Weber 2016-06-22 16:02:00 UTC
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)
Comment 1 Felix Johnson freebsd_triage 2021-09-26 00:38:23 UTC
Created attachment 228181 [details]
aio_read(2) and aio_write(2) patch

Update aio_write(2) and aio_read(2) to document struct aiocb (bug #210469),
mention lio_listio(2) in the SEE ALSO section (bug #210467),
and remove references to private members of struct aiocb (bug #210468).