[PATCH 08/11] test: Add Args docstrings to img setup functions

Simon Glass sjg at chromium.org
Mon May 18 00:51:06 CEST 2026


The image-setup functions in test/py/img/ have terse docstrings from
their original location in test_ut.py

Add an Args block describing the ubman parameter so each function is
self-documenting.

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

 test/py/img/android.py  | 6 +++++-
 test/py/img/armbian.py  | 3 +++
 test/py/img/cedit.py    | 6 +++++-
 test/py/img/chromeos.py | 6 +++++-
 test/py/img/efi.py      | 6 +++++-
 5 files changed, 23 insertions(+), 4 deletions(-)

diff --git a/test/py/img/android.py b/test/py/img/android.py
index 2ea964f5520..77c5d33c8f0 100644
--- a/test/py/img/android.py
+++ b/test/py/img/android.py
@@ -11,7 +11,11 @@ from test_android import test_abootimg
 
 
 def setup_android_image(ubman):
-    """Create a 20MB disk image with Android partitions"""
+    """Create a 20MB disk image with Android partitions
+
+    Args:
+        ubman (ConsoleBase): Console to use
+    """
     Partition = collections.namedtuple('part', 'start,size,name')
     parts = {}
     disk_data = None
diff --git a/test/py/img/armbian.py b/test/py/img/armbian.py
index 40a890d57f6..1bcba3fae63 100644
--- a/test/py/img/armbian.py
+++ b/test/py/img/armbian.py
@@ -14,6 +14,9 @@ def setup_bootmenu_image(ubman):
     """Create a 20MB disk image with a single ext4 partition
 
     This is modelled on Armbian 22.08 Jammy
+
+    Args:
+        ubman (ConsoleBase): Console to use
     """
     mmc_dev = 4
 
diff --git a/test/py/img/cedit.py b/test/py/img/cedit.py
index 4b53275d259..1a995bc9768 100644
--- a/test/py/img/cedit.py
+++ b/test/py/img/cedit.py
@@ -9,7 +9,11 @@ import utils
 
 
 def setup_cedit_file(ubman):
-    """Set up a .dtb file for use with testing expo and configuration editor"""
+    """Set up a .dtb file for use with testing expo and configuration editor
+
+    Args:
+        ubman (ConsoleBase): Console to use
+    """
     infname = os.path.join(ubman.config.source_dir,
                            'test/boot/files/expo_layout.dts')
     inhname = os.path.join(ubman.config.source_dir,
diff --git a/test/py/img/chromeos.py b/test/py/img/chromeos.py
index a533fd5ae33..6e7cd562c0e 100644
--- a/test/py/img/chromeos.py
+++ b/test/py/img/chromeos.py
@@ -10,7 +10,11 @@ import utils
 
 
 def setup_cros_image(ubman):
-    """Create a 20MB disk image with ChromiumOS partitions"""
+    """Create a 20MB disk image with ChromiumOS partitions
+
+    Args:
+        ubman (ConsoleBase): Console to use
+    """
     Partition = collections.namedtuple('part', 'start,size,name')
     parts = {}
     disk_data = None
diff --git a/test/py/img/efi.py b/test/py/img/efi.py
index 1327a2be6ce..4cb0bb95a59 100644
--- a/test/py/img/efi.py
+++ b/test/py/img/efi.py
@@ -10,7 +10,11 @@ from img.common import mkdir_cond
 
 
 def setup_efi_image(ubman):
-    """Create a 20MB disk image with an EFI app on it"""
+    """Create a 20MB disk image with an EFI app on it
+
+    Args:
+        ubman (ConsoleBase): Console to use
+    """
     devnum = 1
     fsh = FsHelper(ubman.config, 'vfat', 18, 'flash')
     fsh.setup()
-- 
2.43.0



More information about the U-Boot mailing list