[PATCH v2 05/40] doc: Document how sandbox_spl_tests are run

[Pratyush Yadav]

On 30/01/21 08:32PM, Simon Glass wrote:
> Add a few notes about the sandbox_spl tests, since they are special.
> 
> Signed-off-by: Simon Glass <sjg at chromium.org>
> ---
> 
> Changes in v2:
> - Add a note that SPL tests can in fact be run individualy
> - Document how to run all C tests with 'ut all'
> - Fix 'get list' typo
> 
>  doc/develop/testing.rst       |  5 +++
>  doc/develop/tests_sandbox.rst | 77 +++++++++++++++++++++++++++++++++++
>  2 files changed, 82 insertions(+)
> 
> diff --git a/doc/develop/testing.rst b/doc/develop/testing.rst
> index 87c90eee271..b181c2e2e41 100644
> --- a/doc/develop/testing.rst
> +++ b/doc/develop/testing.rst
> @@ -58,6 +58,11 @@ also select particular tests with -k::
>  
>     ./test/py/test.py --bd sandbox_flattree --build -k hello
>  
> +There are some special tests that run in SPL. For this you need the sandbox_spl
> +build::
> +
> +   ./test/py/test.py --bd sandbox_spl --build -k test_spl
> +
>  See test/py/README.md for more information about the pytest suite.
>  
>  See :doc:`tests_sandbox` for how to run tests directly (not through pytest).
> diff --git a/doc/develop/tests_sandbox.rst b/doc/develop/tests_sandbox.rst
> index 85bbd4f6734..fdde76872ee 100644
> --- a/doc/develop/tests_sandbox.rst
> +++ b/doc/develop/tests_sandbox.rst
> @@ -77,3 +77,80 @@ You can easily use gdb on these tests, without needing --gdbserver::
>  
>  You can then single-step and look at variables as needed.
>  
> +
> +Running sandbox_spl tests directly
> +----------------------------------
> +
> +SPL is the phase before U-Boot proper. It is present in the sandbox_spl build,
> +so you can run SPL like this::
> +
> +   ./spl/u-boot-spl
> +
> +SPL tests are special in that run in the SPL phase, if the -u flag is given::

This sentence is not clear at all. Firstly, you probably meant "in that 
they run ...". Secondly, the comma before if makes it very confusing. 
Can SPL tests run in non-SPL phase if "-u" is not given? What happens if 
I don't give "-u" and execute the u-boot-spl binary?

> +
> +   ./spl/u-boot-spl -u
> +
> +   U-Boot SPL 2021.01-00723-g43c77b51be5-dirty (Jan 24 2021 - 16:38:24 -0700)
> +   Running 5 driver model tests
> +   Test: dm_test_of_plat_base: of_platdata.c (flat tree)
> +   Test: dm_test_of_plat_dev: of_platdata.c (flat tree)
> +   Test: dm_test_of_plat_parent: of_platdata.c (flat tree)
> +   Test: dm_test_of_plat_phandle: of_platdata.c (flat tree)
> +   Test: dm_test_of_plat_props: of_platdata.c (flat tree)
> +   Failures: 0
> +
> +
> +   U-Boot 2021.01-00723-g43c77b51be5-dirty (Jan 24 2021 - 16:38:24 -0700)
> +
> +   DRAM:  128 MiB
> +   ...
> +
> +

-- 
Regards,
Pratyush Yadav
Texas Instruments Inc.