doc: describe return values of C tests

* Enumerate return values of C tests
* Reference assertion macros

Reviewed-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>
Reviewed-by: Simon Glass <sjg@chromium.org>
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
This commit is contained in:
Heinrich Schuchardt
2025-11-18 21:17:33 +01:00
parent 3fea6dfd2e
commit b0be86bbf8

View File

@@ -228,6 +228,14 @@ Note that the MEM_TEST() macros is defined at the top of the file.
Example commit: 9fe064646d2 ("bloblist: Support relocating to a larger space") [1]
* A successful test returns 0.
* A skipped test returns -EAGAIN.
* Any other value signals a failure.
Include ``test/ut.h`` defines a number of macros to check values and to return
from the test function if the assertion fails. See :doc:`../api/test`
for details.
[1] https://gitlab.denx.de/u-boot/u-boot/-/commit/9fe064646d2