summaryrefslogtreecommitdiff
path: root/doc/develop
diff options
context:
space:
mode:
authorHeinrich Schuchardt <[email protected]>2025-11-18 21:17:33 +0100
committerHeinrich Schuchardt <[email protected]>2025-11-21 19:25:56 +0100
commitb0be86bbf8b3909727aab505a23cdbf0886c5dd7 (patch)
tree6cc475f4f96e9534ae4f1e0ef349356aae1c5248 /doc/develop
parent3fea6dfd2e0304ec10ce4e260938d729fbf6ebaa (diff)
doc: describe return values of C tests
* Enumerate return values of C tests * Reference assertion macros Reviewed-by: Ilias Apalodimas <[email protected]> Reviewed-by: Simon Glass <[email protected]> Signed-off-by: Heinrich Schuchardt <[email protected]>
Diffstat (limited to 'doc/develop')
-rw-r--r--doc/develop/tests_writing.rst8
1 files changed, 8 insertions, 0 deletions
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