zephyr/doc/reference
Peter Bigot cbff3e34d7 doc: kernel: workqueue: correct documentation of delayed work API
The delayed work API has been changed to allow cancellation in
conditions not previously documented, but this feature can cause both
submission and cancellation to fail in the general case.  Summarize
the conditions and highlight the importance of checking result codes
for these functions.

Also explicitly note that no kernel API can reliably indicate that a
work item has been completed, and that doing so is the responsibility
of the code that provides the work handler.

Signed-off-by: Peter Bigot <peter.bigot@nordicsemi.no>
2020-10-09 11:48:00 +02:00
..
audio doc: reference: Move i2s reference to Audio section 2020-06-12 10:29:24 -04:00
bluetooth Bluetooth: Mesh: Config Client network transmit set/get API 2020-10-02 11:30:12 +02:00
crypto doc: reference: Clean up and restructure a bit 2020-03-18 11:47:24 +01:00
devicetree doc: dts: simplify DT_INST documentation 2020-05-26 22:32:34 +02:00
display doc: reference: Clean up and restructure a bit 2020-03-18 11:47:24 +01:00
drivers doc: Apply constant qualifier on device instance where relevant 2020-09-02 13:48:13 +02:00
file_system fs: allow external file system implementations 2020-09-03 21:49:34 +02:00
kernel doc: kernel: workqueue: correct documentation of delayed work API 2020-10-09 11:48:00 +02:00
logging doc: update function references to use :c:func: 2020-08-31 09:57:33 -04:00
misc doc: update struct references to use :c:struct: 2020-08-31 09:57:33 -04:00
networking net: lwm2m: Make bootstrap optional 2020-10-06 12:01:13 +03:00
peripherals doc: reference: Add ec host command api hooks 2020-09-27 15:15:49 -05:00
power_management doc: Apply constant qualifier on device instance where relevant 2020-09-02 13:48:13 +02:00
random doc: reference: Clean up and restructure a bit 2020-03-18 11:47:24 +01:00
resource_management sys: onoff: support clients using synchronous transitions 2020-08-14 17:53:39 +02:00
settings doc: provide guidance on recommended settings back end 2020-08-25 09:35:40 +02:00
shell shell: documentation update 2020-10-08 10:12:25 -04:00
storage doc: provide guidance on recommended settings back end 2020-08-25 09:35:40 +02:00
usb USB: Add driver and PID for Bluetooth H4 2020-04-20 21:59:47 +03:00
usermode doc: Apply constant qualifier on device instance where relevant 2020-09-02 13:48:13 +02:00
util api: promote sys/util.h to experimental 2020-06-18 19:38:10 +02:00
index.rst api: promote sys/util.h to experimental 2020-06-18 19:38:10 +02:00
overview.rst doc: reference: Add separate entries for CoAP, LwM2M and MQTT APIs 2020-10-06 12:01:13 +03:00
terminology.rst doc: fix invalid usage of function to :c:macro: 2020-08-31 09:57:33 -04:00