[PATCH 01/30] doc: Tidy up testing section

[Heinrich Schuchardt]

On 28.01.21 16:11, Simon Glass wrote:
> Tweak this so the output looks a little better.
>
> Signed-off-by: Simon Glass <sjg at chromium.org>
> ---
>
>  doc/develop/testing.rst | 17 +++++++++--------
>  1 file changed, 9 insertions(+), 8 deletions(-)
>
> diff --git a/doc/develop/testing.rst b/doc/develop/testing.rst
> index 4bc9ca3a6ae..7a395ee9d83 100644
> --- a/doc/develop/testing.rst
> +++ b/doc/develop/testing.rst
> @@ -8,14 +8,14 @@ tested and what tests you should write when adding a new feature.
>  Running tests
>  -------------
>
> -To run most tests on sandbox, type this:
> +To run most tests on sandbox, type this::
>
>      make check
>
>  in the U-Boot directory. Note that only the pytest suite is run using this
>  command.
>
> -Some tests take ages to run. To run just the quick ones, type this:
> +Some tests take ages to run. To run just the quick ones, type this::
>
>      make qcheck
>
> @@ -35,9 +35,9 @@ either on sandbox or on real hardware. It relies on the U-Boot console to
>  inject test commands and check the result. It is slower to run than C code,
>  but provides the ability to unify lots of tests and summarise their results.
>
> -You can run the tests on sandbox with:
> +You can run the tests on sandbox with::
>
> -	./test/py/test.py --bd sandbox --build
> +   ./test/py/test.py --bd sandbox --build
>
>  This will produce HTML output in build-sandbox/test-log.html
>
> @@ -58,10 +58,11 @@ Ad-hoc tests
>
>  There are several ad-hoc tests which run outside the pytest environment:
>
> -   test/fs	- File system test (shell script)
> -   test/image	- FIT and legacy image tests (shell script and Python)
> -   test/stdint	- A test that stdint.h can be used in U-Boot (shell script)
> -   trace	- Test for the tracing feature (shell script)
> +   - **test/fs**	- File system test (shell script)
> +   - **test/image**	- FIT and legacy image tests (shell script and Python)
> +   - **test/stdint**	- A test that stdint.h can be used in U-Boot (shell
> +     script)
> +   - **trace**	- Test for the tracing feature (shell script)

Proper reStructered text style would be

test/fs
    File system test (shell script)

test/image
    FIT and legacy image tests (shell script and Python)

The first line of each paragraph will be in bold.

Best regards

Heinrich

>
>  TODO: Move these into pytest.
>
>