doc: describe return values of C tests

xypron · xypron · commit b0be86bbf8b3 · 2025-11-21T19:25:56.000+01:00
* Enumerate return values of C tests
* Reference assertion macros

Reviewed-by: Ilias Apalodimas &lt;ilias.apalodimas@linaro.org&gt;
Reviewed-by: Simon Glass &lt;sjg@chromium.org&gt;
Signed-off-by: Heinrich Schuchardt &lt;heinrich.schuchardt@canonical.com&gt;
diff --git 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
 
 
