From: Heinrich Schuchardt Date: Tue, 18 Nov 2025 20:17:33 +0000 (+0100) Subject: doc: describe return values of C tests X-Git-Tag: v2026.01-rc3~5^2~2 X-Git-Url: http://git.openpandora.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b0be86bbf8b3909727aab505a23cdbf0886c5dd7;p=pandora-u-boot.git doc: describe return values of C tests * Enumerate return values of C tests * Reference assertion macros Reviewed-by: Ilias Apalodimas Reviewed-by: Simon Glass Signed-off-by: Heinrich Schuchardt --- 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