mirror of
https://source.denx.de/u-boot/u-boot.git
synced 2026-06-02 09:46:37 +03:00
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 <xypron.glpk@gmx.de> Signed-off-by: Simon Glass <sjg@chromium.org>
This commit is contained in:
@@ -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',
|
||||
|
||||
Reference in New Issue
Block a user