zephyr/doc/reference
Peter Bigot 9f68178fe1 doc: reference: terminology: refine API attributes
The original description for isr-ok allowed the function to return an
error if called from an interrupt context, rather than doing its job.
This led to complex descriptions like "isr-ok but not sleep" to
indicate that the function could be called from thread or interrupt
context without visible behavior changes, including returning an
error based on calling context.

Remove the special terminology for cases where a function returns an
error (rather than causing undefined behavior) when invoked from an
interrupt or pre-kernel.  Redefine isr-ok to indicate that the call
does what it's supposed to do regardless of interrupt or thread
context, delegating the description of allowed behaviors to the API
documentation (which should explicitly note when it's allowed to fail
to perform in non-thread context).

This also makes more clear that isr-ok applies to functions regardless
of whether they can cause an invoking thread to context switch.

Signed-off-by: Peter Bigot <peter.bigot@nordicsemi.no>
2020-04-22 17:39:56 +02:00
..
audio doc: reference: Add pages for audio 2020-03-18 11:47:24 +01:00
bluetooth Bluetooth: hci: Add documentation for Read/Set USB Transport Mode 2020-04-20 21:59:47 +03:00
crypto doc: reference: Clean up and restructure a bit 2020-03-18 11:47:24 +01:00
devicetree include: devicetree.h: API for /chosen zephyr,foo 2020-04-13 09:14:21 -05:00
display doc: reference: Clean up and restructure a bit 2020-03-18 11:47:24 +01:00
drivers doc: reference: Clean up and restructure a bit 2020-03-18 11:47:24 +01:00
file_system doc: reference: Clean up and restructure a bit 2020-03-18 11:47:24 +01:00
kernel sys: add generic asynchronous notification infrastructure 2020-04-06 16:41:41 +02:00
logging doc: reference: Clean up and restructure a bit 2020-03-18 11:47:24 +01:00
misc sys: add generic asynchronous notification infrastructure 2020-04-06 16:41:41 +02:00
networking doc: net: Add information about GSM 07.10 muxing support 2020-04-17 10:15:54 +03:00
peripherals drivers: dac: Add API for DAC peripherals 2020-04-20 17:41:48 +02:00
power_management doc: reference: Clean up and restructure a bit 2020-03-18 11:47:24 +01:00
random doc: reference: Clean up and restructure a bit 2020-03-18 11:47:24 +01:00
resource_management sys: onoff: redesign to meet changed needs 2020-04-22 16:52:47 +02:00
settings doc: reference: Clean up and restructure a bit 2020-03-18 11:47:24 +01:00
shell doc: reference: Clean up and restructure a bit 2020-03-18 11:47:24 +01:00
storage doc: dts: revisit documentation 2020-03-24 10:11:20 -05:00
usb USB: Add driver and PID for Bluetooth H4 2020-04-20 21:59:47 +03:00
usermode doc: syscalls: expand docs on data copying 2020-04-01 23:34:02 -04:00
index.rst sys: add generic asynchronous notification infrastructure 2020-04-06 16:41:41 +02:00
overview.rst drivers: dac: Add API for DAC peripherals 2020-04-20 17:41:48 +02:00
terminology.rst doc: reference: terminology: refine API attributes 2020-04-22 17:39:56 +02:00