From 4d0a8c1e8b8316ec5071a3fcc98cd292d3bc4e6d Mon Sep 17 00:00:00 2001 From: Chris Friedt Date: Sat, 8 Jun 2024 16:02:30 -0400 Subject: [PATCH] doc: posix: async-io: clean up async-io documentation 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 --- .../portability/posix/option_groups/index.rst | 20 +++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/doc/services/portability/posix/option_groups/index.rst b/doc/services/portability/posix/option_groups/index.rst index 2e42a6d7f25..e67523ae3d7 100644 --- a/doc/services/portability/posix/option_groups/index.rst +++ b/doc/services/portability/posix/option_groups/index.rst @@ -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:`†`. + .. csv-table:: _POSIX_ASYNCHRONOUS_IO :header: API, Supported :widths: 50,10 - aio_cancel(),yes (will fail with ``ENOSYS``:ref:`†`) - aio_error(),yes (will fail with ``ENOSYS``:ref:`†`) - aio_fsync(),yes (will fail with ``ENOSYS``:ref:`†`) - aio_read(),yes (will fail with ``ENOSYS``:ref:`†`) - aio_return(),yes (will fail with ``ENOSYS``:ref:`†`) - aio_suspend(),yes (will fail with ``ENOSYS``:ref:`†`) - aio_write(),yes (will fail with ``ENOSYS``:ref:`†`) - lio_listio(),yes (will fail with ``ENOSYS``:ref:`†`) + aio_cancel(),yes :ref:`†` + aio_error(),yes :ref:`†` + aio_fsync(),yes :ref:`†` + aio_read(),yes :ref:`†` + aio_return(),yes :ref:`†` + aio_suspend(),yes :ref:`†` + aio_write(),yes :ref:`†` + lio_listio(),yes :ref:`†` .. _posix_option_cputime: