]> git.ipfire.org Git - thirdparty/u-boot.git/commitdiff
doc: add include/test/ut.h to HTML documentation
authorHeinrich Schuchardt <heinrich.schuchardt@canonical.com>
Tue, 18 Nov 2025 20:17:32 +0000 (21:17 +0100)
committerHeinrich Schuchardt <heinrich.schuchardt@canonical.com>
Fri, 21 Nov 2025 18:25:56 +0000 (19:25 +0100)
The asserts in ut.h are often used. Provide online documentation.

Reviewed-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>
Reviewed-by: Simon Glass <sjg@chromium.org>
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
doc/api/index.rst
doc/api/test.rst [new file with mode: 0644]

index d97630e76716b7edddd06e39588cdb6f001265bc..44922a742c3f3a347055ec9e67752dee4031543a 100644 (file)
@@ -27,6 +27,7 @@ U-Boot API documentation
    serial
    setjmp
    sysreset
+   test
    timer
    unicode
    uthread
diff --git a/doc/api/test.rst b/doc/api/test.rst
new file mode 100644 (file)
index 0000000..359cbd0
--- /dev/null
@@ -0,0 +1,11 @@
+.. SPDX-License-Identifier: GPL-2.0-or-later
+.. Copyright (c) 2025 Heinrich Schuchardt
+
+Test Framework
+==============
+
+Assertions and reporting functions
+----------------------------------
+
+.. kernel-doc:: include/test/ut.h
+   :internal: