doc: Update ut documentation

Update documentation for the 'ut' command, since it has changed a
little.

Signed-off-by: Simon Glass <sjg@chromium.org>
This commit is contained in:
Simon Glass
2025-01-20 14:26:06 -07:00
committed by Tom Rini
parent fc7968c118
commit 229d145f26

View File

@@ -11,7 +11,7 @@ Synopsis
:: ::
ut [-r<runs>] [-f] [-I<n>:<one_test>] [<suite> [<test>]] ut [-r<runs>] [-fs] [-I<n>:<one_test>] [<suite> [<test>]]
<runs> Number of times to run each test <runs> Number of times to run each test
-f Force 'manual' tests to run as well -f Force 'manual' tests to run as well
@@ -30,7 +30,7 @@ includes a near-complete set of emulators, no code-size limits, many CONFIG
options enabled and runs easily in CI without needing QEMU. It is also possible options enabled and runs easily in CI without needing QEMU. It is also possible
to run some tests on real boards. to run some tests on real boards.
For a list of available test suites, type `ut` by itself. For a list of available test suites, type `ut info -s`.
Each test is normally run once, although those marked with `UTF_DM` are Each test is normally run once, although those marked with `UTF_DM` are
run with livetree and flattree where possible. To run a test more than once, run with livetree and flattree where possible. To run a test more than once,
@@ -56,36 +56,44 @@ write unit tests.
Example Example
------- -------
Show information about tests::
=> ut info
Test suites: 23
Total tests: 833
List available unit-test suites:: List available unit-test suites::
=> ut => ut info -s
ut - unit tests Test suites: 23
Total tests: 833
Usage: Tests Suite Purpose
ut [-r] [-f] [<suite>] - run unit tests ----- ------------ -------------------------
-r<runs> Number of times to run each test 1 addrmap very basic test of addrmap command
-f Force 'manual' tests to run as well 4 bdinfo bdinfo (board info) command
<suite> Test suite to run, or all 14 bloblist bloblist implementation
7 bootm bootm command
66 bootstd standard boot implementation
2 cmd various commands
14 common tests for common/ directory
502 dm driver model
6 env environment
1 exit shell exit and variables
19 fdt fdt command
10 fdt_overlay device tree overlays
1 font font command
20 hush hush behaviour
115 lib library functions
2 loadm loadm command parameters and loading memory blob
18 log logging functions
1 mbr mbr command
1 measurement TPM-based measured boot
13 mem memory-related commands
1 pci_mps PCI Express Maximum Payload Size
11 setexpr setexpr command
4 upl Universal payload support
Suites:
all - execute all enabled tests
addrmap - very basic test of addrmap command
bloblist - bloblist implementation
bootstd - standard boot implementation
compression - compressors and bootm decompression
dm - driver model
env - environment
fdt - fdt command
loadm - loadm command parameters and loading memory blob
lib - library functions
log - logging functions
mem - memory-related commands
overlay - device tree overlays
print - printing things to the console
setexpr - setexpr command
str - basic test of string functions
time - very basic test of time functions
unicode - Unicode functions
Run one of the suites:: Run one of the suites::
@@ -112,9 +120,3 @@ Run just a single test in a suite::
=> ut bloblist bloblist_test_grow => ut bloblist bloblist_test_grow
Test: bloblist_test_grow: bloblist.c Test: bloblist_test_grow: bloblist.c
Failures: 0 Failures: 0
Show information about tests::
=> ut info
Test suites: 21
Total tests: 642