Skip to content

Commit 4d0a8c1

Browse files
cfriedtnashif
authored andcommitted
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 <[email protected]>
1 parent e0956f0 commit 4d0a8c1

File tree

1 file changed

+12
-8
lines changed
  • doc/services/portability/posix/option_groups

1 file changed

+12
-8
lines changed

doc/services/portability/posix/option_groups/index.rst

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -627,18 +627,22 @@ Additional POSIX Options
627627
_POSIX_ASYNCHRONOUS_IO
628628
++++++++++++++++++++++
629629

630+
Functions part of the ``_POSIX_ASYNCHRONOUS_IO`` Option are not implemented in Zephyr but are
631+
provided so that conformant applications can still link. These functions will fail, setting
632+
``errno`` to ``ENOSYS``:ref:`†<posix_undefined_behaviour>`.
633+
630634
.. csv-table:: _POSIX_ASYNCHRONOUS_IO
631635
:header: API, Supported
632636
:widths: 50,10
633637

634-
aio_cancel(),yes (will fail with ``ENOSYS``:ref:`†<posix_undefined_behaviour>`)
635-
aio_error(),yes (will fail with ``ENOSYS``:ref:`†<posix_undefined_behaviour>`)
636-
aio_fsync(),yes (will fail with ``ENOSYS``:ref:`†<posix_undefined_behaviour>`)
637-
aio_read(),yes (will fail with ``ENOSYS``:ref:`†<posix_undefined_behaviour>`)
638-
aio_return(),yes (will fail with ``ENOSYS``:ref:`†<posix_undefined_behaviour>`)
639-
aio_suspend(),yes (will fail with ``ENOSYS``:ref:`†<posix_undefined_behaviour>`)
640-
aio_write(),yes (will fail with ``ENOSYS``:ref:`†<posix_undefined_behaviour>`)
641-
lio_listio(),yes (will fail with ``ENOSYS``:ref:`†<posix_undefined_behaviour>`)
638+
aio_cancel(),yes :ref:`†<posix_undefined_behaviour>`
639+
aio_error(),yes :ref:`†<posix_undefined_behaviour>`
640+
aio_fsync(),yes :ref:`†<posix_undefined_behaviour>`
641+
aio_read(),yes :ref:`†<posix_undefined_behaviour>`
642+
aio_return(),yes :ref:`†<posix_undefined_behaviour>`
643+
aio_suspend(),yes :ref:`†<posix_undefined_behaviour>`
644+
aio_write(),yes :ref:`†<posix_undefined_behaviour>`
645+
lio_listio(),yes :ref:`†<posix_undefined_behaviour>`
642646

643647
.. _posix_option_cputime:
644648

0 commit comments

Comments
 (0)