[PATCH 4/4] doc: describe return values of C tests

Heinrich Schuchardt heinrich.schuchardt at canonical.com
Tue Nov 18 21:17:33 CET 2025


* Enumerate return values of C tests
* Reference assertion macros

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt at canonical.com>
---
 doc/develop/tests_writing.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/doc/develop/tests_writing.rst b/doc/develop/tests_writing.rst
index b6972489d4c..1a020caa411 100644
--- a/doc/develop/tests_writing.rst
+++ b/doc/develop/tests_writing.rst
@@ -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
 
 
-- 
2.51.0



More information about the U-Boot mailing list