summaryrefslogtreecommitdiff
path: root/doc/develop
diff options
context:
space:
mode:
authorTom Rini <trini@konsulko.com>2025-05-07 17:23:01 -0600
committerHeinrich Schuchardt <heinrich.schuchardt@canonical.com>2025-05-11 12:52:56 +0200
commit58b2f0895bcbe24aad86c14813911f04b35cc5fb (patch)
tree1089cfdb63f110e8f11db5bbd85e98c22eb3106c /doc/develop
parent45d325ba0993f60b7b81bae1efde0bc324d49400 (diff)
doc: pytest: Document the test_bootstage test
Add this test to the documentation. We need to move the import to follow the main comment so that it renders correctly, and add a code-block annotation to the example and indent it correctly. Next, neither of the functions had comments themselves, so document them now. Signed-off-by: Tom Rini <trini@konsulko.com> Reviewed-by: Simon Glass <sjg@chromium.org>
Diffstat (limited to 'doc/develop')
-rw-r--r--doc/develop/pytest/index.rst1
-rw-r--r--doc/develop/pytest/test_bootstage.rst8
2 files changed, 9 insertions, 0 deletions
diff --git a/doc/develop/pytest/index.rst b/doc/develop/pytest/index.rst
index e2131a2f4a6..5bcda1f0952 100644
--- a/doc/develop/pytest/index.rst
+++ b/doc/develop/pytest/index.rst
@@ -18,5 +18,6 @@ Individual tests
:maxdepth: 1
test_000_version
+ test_bootstage
test_net
test_net_boot
diff --git a/doc/develop/pytest/test_bootstage.rst b/doc/develop/pytest/test_bootstage.rst
new file mode 100644
index 00000000000..f8f10e96a42
--- /dev/null
+++ b/doc/develop/pytest/test_bootstage.rst
@@ -0,0 +1,8 @@
+test_bootstage
+==============
+
+.. automodule:: test_bootstage
+ :synopsis:
+ :member-order: bysource
+ :members:
+ :undoc-members: