diff options
| author | Simon Glass <[email protected]> | 2026-05-05 12:12:54 -0600 |
|---|---|---|
| committer | Simon Glass <[email protected]> | 2026-05-11 12:05:10 -0600 |
| commit | 44f9ccfdad47deadb1b61896dbbcf004b8c6fa0c (patch) | |
| tree | b4a2303d33cb4753b3e92425bb022af6af5812c7 /tools/binman | |
| parent | 40c94fbf62b39a89171402054f0940d08fb05c9d (diff) | |
binman: Flesh out the softhsm2-util bintool docstring
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 <[email protected]>
Signed-off-by: Simon Glass <[email protected]>
Diffstat (limited to 'tools/binman')
| -rw-r--r-- | tools/binman/btool/softhsm2_util.py | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/tools/binman/btool/softhsm2_util.py b/tools/binman/btool/softhsm2_util.py index 869221d841d..fd2ff2d6473 100644 --- a/tools/binman/btool/softhsm2_util.py +++ b/tools/binman/btool/softhsm2_util.py @@ -7,7 +7,17 @@ from binman import bintool class Bintoolsofthsm2_util(bintool.Bintool): - """SoftHSMv2 -- support tool for libsofthsm2""" + """SoftHSMv2 -- support tool for libsofthsm2 + + This bintool wraps the `softhsm2-util` command shipped with SoftHSMv2 (a + software implementation of a PKCS#11 token). Binman uses this wrapper only + to check that softhsm2-util is installed (and to fetch it if missing); any + actual token initialisation or key import for signing FIT images or + capsules is done outside binman, typically via mkimage and the OpenSSL + PKCS#11 engine. + + See https://www.opendnssec.org/softhsm/ for more details. + """ def __init__(self, name): super().__init__('softhsm2-util', 'SoftHSMv2 support tool for libsofthsm2', |