Skip to content

Commit 4bd5b2c

Browse files
committed
doc: posix: mark posix signals supported with undefined behaviour
Mark the POSIX_SIGNALS Option Group as supported to the extent possible under Zephyr, as Zephyr does not yet support processes. Signed-off-by: Chris Friedt <[email protected]>
1 parent 9616c43 commit 4bd5b2c

File tree

2 files changed

+20
-12
lines changed

2 files changed

+20
-12
lines changed

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@ The *Minimal Realtime System Profile* (PSE51) includes all of the
5050

5151
:ref:`POSIX_C_LANG_JUMP <posix_option_group_c_lang_jump>`, yes,
5252
:ref:`POSIX_C_LANG_SUPPORT <posix_option_group_c_lang_support>`, yes,
53-
:ref:`POSIX_DEVICE_IO <posix_option_group_device_io>`, yes, :kconfig:option:`CONFIG_POSIX_DEVICE_IO`
54-
:ref:`POSIX_SIGNALS <posix_option_group_signals>`,, :kconfig:option:`CONFIG_POSIX_SIGNALS`
53+
:ref:`POSIX_DEVICE_IO <posix_option_group_device_io>`,yes, :kconfig:option:`CONFIG_POSIX_DEVICE_IO`
54+
:ref:`POSIX_SIGNALS <posix_option_group_signals>`, yes, :kconfig:option:`CONFIG_POSIX_SIGNALS` :ref:`†<posix_undefined_behaviour>`
5555
:ref:`POSIX_SINGLE_PROCESS <posix_option_group_single_process>`, yes, :kconfig:option:`CONFIG_POSIX_SINGLE_PROCESS`
5656
:ref:`XSI_THREADS_EXT <posix_option_group_xsi_threads_ext>`, yes, :kconfig:option:`CONFIG_XSI_THREADS_EXT`
5757

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

+18-10
Original file line numberDiff line numberDiff line change
@@ -244,26 +244,34 @@ POSIX_SIGNALS
244244
Signal services are a basic mechanism within POSIX-based systems and are
245245
required for error and event handling.
246246

247+
.. note::
248+
As processes are not yet supported in Zephyr, the ISO C functions ``abort()``, ``signal()``,
249+
and ``raise()``, as well as the other POSIX functions listed below, may exhibit undefined
250+
behaviour. The POSIX functions ``kill()``, ``pause()``, ``sigaction()``, ``sigpending()``,
251+
``sigsuspend()``, and ``sigwait()`` are implemented to ensure that conformant applications can
252+
link, but they are expected to fail, setting errno to ``ENOSYS``
253+
:ref:`†<posix_undefined_behaviour>`.
254+
247255
.. csv-table:: POSIX_SIGNALS
248256
:header: API, Supported
249257
:widths: 50,10
250258

251-
abort(),yes
252-
alarm(),
253-
kill(),
254-
pause(),
255-
raise(),
256-
sigaction(),
259+
abort(),yes :ref:`†<posix_undefined_behaviour>`
260+
alarm(),yes :ref:`†<posix_undefined_behaviour>`
261+
kill(),yes :ref:`†<posix_undefined_behaviour>`
262+
pause(),yes :ref:`†<posix_undefined_behaviour>`
263+
raise(),yes :ref:`†<posix_undefined_behaviour>`
264+
sigaction(),yes :ref:`†<posix_undefined_behaviour>`
257265
sigaddset(),yes
258266
sigdelset(),yes
259267
sigemptyset(),yes
260268
sigfillset(),yes
261269
sigismember(),yes
262-
signal(),
263-
sigpending(),
270+
signal(),yes :ref:`†<posix_undefined_behaviour>`
271+
sigpending(),yes :ref:`†<posix_undefined_behaviour>`
264272
sigprocmask(),yes
265-
sigsuspend(),
266-
sigwait(),
273+
sigsuspend(),yes :ref:`†<posix_undefined_behaviour>`
274+
sigwait(),yes :ref:`†<posix_undefined_behaviour>`
267275
strsignal(),yes
268276

269277
.. _posix_option_group_device_io:

0 commit comments

Comments
 (0)