diff mbox series

[08/13] lib/oe/kernel: convert comments to docstrings and improve

Message ID 20261116-oe-lib-docstrings-v1-8-0c894f6a1064@bootlin.com
State New
Headers show
Series Improve or add oe.* library docstrings | expand

Commit Message

Antonin Godard Nov. 16, 2026, 4:09 p.m. UTC
Most functions in this module were comments. Move them to docstrings so
we can use this data in documentation modules such as Sphinx. Improve
the docstrings by detailing the parameters and return value.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 meta/lib/oe/kernel.py | 22 ++++++++++++++++------
 1 file changed, 16 insertions(+), 6 deletions(-)
diff mbox series

Patch

diff --git a/meta/lib/oe/kernel.py b/meta/lib/oe/kernel.py
index 624eace10e..5c94a5df90 100644
--- a/meta/lib/oe/kernel.py
+++ b/meta/lib/oe/kernel.py
@@ -7,10 +7,13 @@ 
 import os
 import re
 
-# Return a value for the ARCH environment variable for kernel compilation (including
-# modules). return value must match one of the architecture directories
-# in the kernel source "arch" directory
 def map_kernel_arch(d):
+    """
+    Take ``d`` (the :term:`datastore`) to get the value of :term:`TARGET_ARCH`
+    and return a value for the ``ARCH`` environment variable for kernel
+    compilation (including modules). Return value must match one of the architecture
+    directories in the kernel source "arch" directory.
+    """
     a = d.getVar('TARGET_ARCH')
 
     valid_archs = ["alpha", "cris", "ia64", "i386", "x86", "m68knommu", "m68k", "ppc", "powerpc",
@@ -39,13 +42,20 @@  def map_kernel_arch(d):
             return a
         bb.error("cannot map '%s' to a linux kernel architecture" % a)
 
-# Return a value for the -A parameter to u-boot's mkimage
-# This would be the value from the table in boot/image.c:uimage_arch
 def map_uboot_arch(d):
+    """
+    Take ``d`` (the :term:`datastore`) to get the value of :term:`TARGET_ARCH`
+    and return a value for the ``-A`` parameter to U-Boot's ``mkimage``.
+    This would be the value from the table in ``boot/image.c:uimage_arch``.
+    """
     return map_kernel_arch(d)
 
-# parse kernel ABI version out of <linux/version.h>
 def get_version_headers(p):
+    """
+    Take ``p``, the root of the kernel build directory and parse the kernel
+    ABI version out of ``<linux/version.h>``, and return a string containing
+    the ABI version, if found. If not found, return ``None``.
+    """
     fn = p + '/include/linux/utsrelease.h'
     if not os.path.isfile(fn):
         # after 2.6.33-rc1