zephyr/doc/reference/kernel
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
..
data_passing docs: ref: kernel: clarify data_item structure in message queues 2020-09-17 14:17:47 -05:00
memory doc: do not use :c:macro: for NULL 2020-08-31 09:57:33 -04:00
other doc: fix invalid usage of function to :c:macro: 2020-08-31 09:57:33 -04:00
scheduling doc: update function references to use :c:func: 2020-08-31 09:57:33 -04:00
smp doc/kernel/smp: Add initialization diagram 2019-11-14 19:13:27 -05:00
synchronization doc: update struct references to use :c:struct: 2020-08-31 09:57:33 -04:00
threads doc: kernel: workqueue: correct documentation of delayed work API 2020-10-09 11:48:00 +02:00
timing doc: do not use :c:macro: for NULL 2020-08-31 09:57:33 -04:00
index.rst doc: Add k_heap/sys_heap docs 2020-05-07 17:17:52 -07:00