summaryrefslogtreecommitdiff
path: root/doc/api/uthread.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api/uthread.rst')
-rw-r--r--doc/api/uthread.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/api/uthread.rst b/doc/api/uthread.rst
new file mode 100644
index 00000000000..8b25cc1ff80
--- /dev/null
+++ b/doc/api/uthread.rst
@@ -0,0 +1,19 @@
+.. SPDX-License-Identifier: GPL-2.0-or-later
+
+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: