Skip to content

Commit

Permalink
doc: posix: async-io: clean up async-io documentation
Browse files Browse the repository at this point in the history
The async-io documentation was in need of some beautification.

Rather than repeating the same thing inside of the table, just
mention that the whole option is expected to fail enosys.

At this time, there does not seem to be sufficient need for
implementing async io, so it is only present so that conforming
applications can still link properly.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
  • Loading branch information
Chris Friedt authored and nashif committed Jun 16, 2024
1 parent e0956f0 commit 4d0a8c1
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions doc/services/portability/posix/option_groups/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -627,18 +627,22 @@ Additional POSIX Options
_POSIX_ASYNCHRONOUS_IO
++++++++++++++++++++++

Functions part of the ``_POSIX_ASYNCHRONOUS_IO`` Option are not implemented in Zephyr but are
provided so that conformant applications can still link. These functions will fail, setting
``errno`` to ``ENOSYS``:ref:`†<posix_undefined_behaviour>`.

.. csv-table:: _POSIX_ASYNCHRONOUS_IO
:header: API, Supported
:widths: 50,10

aio_cancel(),yes (will fail with ``ENOSYS``:ref:`†<posix_undefined_behaviour>`)
aio_error(),yes (will fail with ``ENOSYS``:ref:`†<posix_undefined_behaviour>`)
aio_fsync(),yes (will fail with ``ENOSYS``:ref:`†<posix_undefined_behaviour>`)
aio_read(),yes (will fail with ``ENOSYS``:ref:`†<posix_undefined_behaviour>`)
aio_return(),yes (will fail with ``ENOSYS``:ref:`†<posix_undefined_behaviour>`)
aio_suspend(),yes (will fail with ``ENOSYS``:ref:`†<posix_undefined_behaviour>`)
aio_write(),yes (will fail with ``ENOSYS``:ref:`†<posix_undefined_behaviour>`)
lio_listio(),yes (will fail with ``ENOSYS``:ref:`†<posix_undefined_behaviour>`)
aio_cancel(),yes :ref:`†<posix_undefined_behaviour>`
aio_error(),yes :ref:`†<posix_undefined_behaviour>`
aio_fsync(),yes :ref:`†<posix_undefined_behaviour>`
aio_read(),yes :ref:`†<posix_undefined_behaviour>`
aio_return(),yes :ref:`†<posix_undefined_behaviour>`
aio_suspend(),yes :ref:`†<posix_undefined_behaviour>`
aio_write(),yes :ref:`†<posix_undefined_behaviour>`
lio_listio(),yes :ref:`†<posix_undefined_behaviour>`

.. _posix_option_cputime:

Expand Down

0 comments on commit 4d0a8c1

Please sign in to comment.