doc: pytest: Document the test_bootmenu test

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@konsulko.com>
Reviewed-by: Simon Glass <sjg@chromium.org>

diff --git a/doc/develop/pytest/index.rst b/doc/develop/pytest/index.rst
index cd6eb5f..4d949cf 100644 (file)
--- 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 (file)
index 0000000..e2ff5c4
--- /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 66f3fb8..be8257f 100644 (file)
--- 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')