[PATCH 3/4] doc: add include/test/ut.h to HTML documentation
Ilias Apalodimas
ilias.apalodimas at linaro.org
Thu Nov 20 13:24:31 CET 2025
On Tue, 18 Nov 2025 at 22:17, Heinrich Schuchardt
<heinrich.schuchardt at canonical.com> wrote:
>
> The asserts in ut.h are often used. Provide online documentation.
>
> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt at canonical.com>
Reviewed-by: Ilias Apalodimas <ilias.apalodimas at linaro.org>
> ---
> doc/api/index.rst | 1 +
> doc/api/test.rst | 11 +++++++++++
> 2 files changed, 12 insertions(+)
> create mode 100644 doc/api/test.rst
>
> diff --git a/doc/api/index.rst b/doc/api/index.rst
> index d97630e7671..44922a742c3 100644
> --- a/doc/api/index.rst
> +++ b/doc/api/index.rst
> @@ -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
> index 00000000000..359cbd0617d
> --- /dev/null
> +++ b/doc/api/test.rst
> @@ -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:
> --
> 2.51.0
>
More information about the U-Boot
mailing list