summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorJerome Forissier <[email protected]>2025-04-18 16:09:38 +0200
committerTom Rini <[email protected]>2025-04-23 13:19:44 -0600
commit67b1b1ae197f6ab12e2bcf7ab0b995f671779745 (patch)
tree5fbe15bb1223f14e27854945bd44effb4e80db67 /doc/api
parent2325621fff219ee3b80641f714545f8b33013c0c (diff)
test: lib: add uthread test
Add a thread framework test to the lib tests. Update the API documentation to use the test as an example. Signed-off-by: Jerome Forissier <[email protected]> Acked-by: Ilias Apalodimas <[email protected]>
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/uthread.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/api/uthread.rst b/doc/api/uthread.rst
index 21233ff6b22..8b25cc1ff80 100644
--- a/doc/api/uthread.rst
+++ b/doc/api/uthread.rst
@@ -4,4 +4,16 @@ Uthread API
===========
.. kernel-doc:: include/uthread.h
+ :doc: Overview
+
+.. kernel-doc:: include/uthread.h
:internal:
+
+Example
+-------
+
+Here is an example of how to use this API:
+
+.. literalinclude:: ../../test/lib/uthread.c
+ :language: c
+ :linenos: