[PATCH 2/3] doc: pytest: Document the test_bootmenu test

[Simon Glass]

On Thu, 8 May 2025 at 23:42, Tom Rini <trini at konsulko.com> wrote:
>
> Add this test to the documentation. There was already a function comment
> that included the argument, so convert it to the right style to be
> rendered correctly in output.
>
> Signed-off-by: Tom Rini <trini at konsulko.com>
> ---
> Cc: Heinrich Schuchardt <xypron.glpk at gmx.de>
> Cc: Simon Glass <sjg at chromium.org>
> ---
>  doc/develop/pytest/index.rst         | 1 +
>  doc/develop/pytest/test_bootmenu.rst | 8 ++++++++
>  test/py/tests/test_bootmenu.py       | 4 ++--
>  3 files changed, 11 insertions(+), 2 deletions(-)
>  create mode 100644 doc/develop/pytest/test_bootmenu.rst

Reviewed-by: Simon Glass <sjg at chromium.org>

BTW ubman is a little more than the console right now, but I suppose
that doesn't matter.


>
> diff --git a/doc/develop/pytest/index.rst b/doc/develop/pytest/index.rst
> index cd6eb5f038f3..4d949cfd1d2d 100644
> --- a/doc/develop/pytest/index.rst
> +++ b/doc/develop/pytest/index.rst
> @@ -19,6 +19,7 @@ Individual tests
>
>     test_000_version
>     test_bind
> +   test_bootmenu
>     test_bootstage
>     test_efi_loader
>     test_net
> diff --git a/doc/develop/pytest/test_bootmenu.rst b/doc/develop/pytest/test_bootmenu.rst
> new file mode 100644
> index 000000000000..e2ff5c4c201c
> --- /dev/null
> +++ b/doc/develop/pytest/test_bootmenu.rst
> @@ -0,0 +1,8 @@
> +test_bootmenu
> +=============
> +
> +.. automodule:: test_bootmenu
> +   :synopsis:
> +   :member-order: bysource
> +   :members:
> +   :undoc-members:
> diff --git a/test/py/tests/test_bootmenu.py b/test/py/tests/test_bootmenu.py
> index 66f3fb8a1310..be8257fe3e8b 100644
> --- a/test/py/tests/test_bootmenu.py
> +++ b/test/py/tests/test_bootmenu.py
> @@ -8,9 +8,9 @@ import pytest
>  def test_bootmenu(ubman):
>      """Test bootmenu
>
> -    ubman -- U-Boot console
> +    Args:
> +        ubman: U-Boot console
>      """
> -
>      with ubman.temporary_timeout(500):
>          ubman.run_command('setenv bootmenu_default 1')
>          ubman.run_command('setenv bootmenu_0 test 1=echo ok 1')
> --
> 2.43.0
>