michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: posix: options: make column size consistent

Browse source 
For some reason, when the "Supported" coumn of the posix option
documentation included large strings, it would distort the size
of the entire table.

Move blurbs about undefined behaviour and failing with ENOSYS
to a paragraph above the table, so that all tables have a
homogeneous size.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
This commit is contained in:
Chris Friedt 2024-07-19 11:09:24 -04:00 • committed by Alberto Escolar
commit 3ec76e82eb
1 changed files with 8 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

12
doc/services/portability/posix/option_groups/index.rst
View file

@ -367,7 +367,7 @@ to ``ENOSYS`` :ref:`†<posix_undefined_behaviour>`.
setsockopt(),yes setsockopt(),yes
shutdown(),yes shutdown(),yes
socket(),yes socket(),yes
sockatmark(),yes (will fail with ``ENOSYS``:ref:`†<posix_undefined_behaviour>`) sockatmark(),yes :ref:`†<posix_undefined_behaviour>`
socketpair(),yes socketpair(),yes
.. _posix_option_group_pipe: .. _posix_option_group_pipe:
@ -743,6 +743,10 @@ _POSIX_MONOTONIC_CLOCK
_POSIX_PRIORITY_SCHEDULING _POSIX_PRIORITY_SCHEDULING
++++++++++++++++++++++++++ ++++++++++++++++++++++++++
As processes are not yet supported in Zephyr, the functions ``sched_rr_get_interval()``,
``sched_setparam()``, and ``sched_setscheduler()`` are expected to fail setting ``errno``
to ``ENOSYS``:ref:`†<posix_undefined_behaviour>`.
.. csv-table:: _POSIX_PRIORITY_SCHEDULING .. csv-table:: _POSIX_PRIORITY_SCHEDULING
:header: API, Supported :header: API, Supported
:widths: 50,10 :widths: 50,10
@ -751,9 +755,9 @@ _POSIX_PRIORITY_SCHEDULING
sched_get_priority_min(),yes sched_get_priority_min(),yes
sched_getparam(),yes sched_getparam(),yes
sched_getscheduler(),yes sched_getscheduler(),yes
sched_rr_get_interval(),yes (will fail with ``ENOSYS``:ref:`†<posix_undefined_behaviour>`) sched_rr_get_interval(),yes :ref:`†<posix_undefined_behaviour>`
sched_setparam(),yes (will fail with ``ENOSYS``:ref:`†<posix_undefined_behaviour>`) sched_setparam(),yes :ref:`†<posix_undefined_behaviour>`
sched_setscheduler(),yes (will fail with ``ENOSYS``:ref:`†<posix_undefined_behaviour>`) sched_setscheduler(),yes :ref:`†<posix_undefined_behaviour>`
sched_yield(),yes sched_yield(),yes
.. _posix_option_raw_sockets: .. _posix_option_raw_sockets: