[PATCH 3/3] binman: Flesh out the softhsm2-util bintool docstring

Simon Glass sjg at chromium.org
Wed Apr 22 01:11:18 CEST 2026


The Sphinx-generated bintools.rst currently produces an empty section
for this bintool, since its class docstring is only a single line and
so the body under the heading is blank.

Extend the docstring with a short description of what softhsm2-util
does and how binman uses it, so the generated documentation has useful
content.

Suggested-by: Heinrich Schuchardt <xypron.glpk at gmx.de>
Signed-off-by: Simon Glass <sjg at chromium.org>
---

 tools/binman/btool/softhsm2_util.py | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/tools/binman/btool/softhsm2_util.py b/tools/binman/btool/softhsm2_util.py
index 869221d841d..e79584da11d 100644
--- a/tools/binman/btool/softhsm2_util.py
+++ b/tools/binman/btool/softhsm2_util.py
@@ -7,7 +7,16 @@ from binman import bintool
 
 
 class Bintoolsofthsm2_util(bintool.Bintool):
-    """SoftHSMv2 -- support tool for libsofthsm2"""
+    """SoftHSMv2 -- support tool for libsofthsm2
+
+    This bintool supports running `softhsm2-util`, the command-line utility
+    shipped with SoftHSMv2 (a software implementation of a PKCS#11 token).
+    Binman uses it to initialise a token so that keys can be imported and used
+    to sign FIT images or capsules via the PKCS#11 interface, without requiring
+    real hardware.
+
+    See https://www.opendnssec.org/softhsm/ for more details.
+    """
     def __init__(self, name):
         super().__init__('softhsm2-util',
                          'SoftHSMv2 support tool for libsofthsm2',
-- 
2.43.0



More information about the U-Boot mailing list