[PATCH v3 06/41] doc: Document how sandbox_spl_tests are run

[Pratyush Yadav]

On 03/02/21 05:44AM, 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 v3:
> - Reword the SPL tests section for clarity
> 
> 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 | 81 +++++++++++++++++++++++++++++++++++
>  2 files changed, 86 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..f05de2f2b7a 100644
> --- a/doc/develop/tests_sandbox.rst
> +++ b/doc/develop/tests_sandbox.rst
> @@ -77,3 +77,84 @@ 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 they run (only in the SPL phase, of course) if the
> +-u flag is given::
> +
> +   ./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
> +   ...
> +
> +It is not possible to run SPL tests in U-Boot proper, firstly because they are
> +not built into U-Boot proper and secondly because the environment is very
> +different, e.g. some SPL tests rely on of-pldata which is only available in SPL.

s/of-pldata/of-platdata/

Other than this,

Acked-by: Pratyush Yadav <p.yadav at ti.com>

-- 
Regards,
Pratyush Yadav
Texas Instruments Inc.