]> git.ipfire.org Git - thirdparty/u-boot.git/commitdiff
binman: Flesh out the pkcs11-tool bintool docstring
authorSimon Glass <sjg@chromium.org>
Tue, 5 May 2026 18:12:53 +0000 (12:12 -0600)
committerSimon Glass <sjg@chromium.org>
Mon, 11 May 2026 18:05:10 +0000 (12:05 -0600)
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 pkcs11-tool does
and how binman uses it, so the generated documentation has useful
content.

Suggested-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
Signed-off-by: Simon Glass <sjg@chromium.org>
tools/binman/btool/pkcs11_tool.py

index 673c0ea0ac359ad47172776881ca7521068c14b3..ca80943f98c84d8728c715f95c394a9a1f7bbac9 100644 (file)
@@ -7,7 +7,16 @@ from binman import bintool
 
 
 class Bintoolpkcs11_tool(bintool.Bintool):
-    """pkcs11-tool -- support tool for managing pkcs#11 tokens"""
+    """pkcs11-tool -- support tool for managing pkcs#11 tokens
+
+    This bintool wraps the `pkcs11-tool` command from the OpenSC project for
+    managing objects stored in PKCS#11 tokens. Binman uses this wrapper only
+    to check that pkcs11-tool is installed (and to fetch it if missing); any
+    actual key or token management for signing FIT images or capsules is done
+    outside binman.
+
+    See https://github.com/OpenSC/OpenSC/wiki for more details.
+    """
     def __init__(self, name):
         super().__init__('pkcs11-tool',
                          'PKCS #11 tokens managing tool',