diff options
| author | Simon Glass <[email protected]> | 2026-05-05 12:12:53 -0600 |
|---|---|---|
| committer | Simon Glass <[email protected]> | 2026-05-11 12:05:10 -0600 |
| commit | 40c94fbf62b39a89171402054f0940d08fb05c9d (patch) | |
| tree | e9cd19efc661965b8cf7469daea4547fc0fe8886 | |
| parent | 4dc8f10edf90cab4d7f6b7106f5e52f6c23099ed (diff) | |
binman: Flesh out the pkcs11-tool 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 pkcs11-tool 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]>
| -rw-r--r-- | tools/binman/btool/pkcs11_tool.py | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/tools/binman/btool/pkcs11_tool.py b/tools/binman/btool/pkcs11_tool.py index 673c0ea0ac3..ca80943f98c 100644 --- a/tools/binman/btool/pkcs11_tool.py +++ b/tools/binman/btool/pkcs11_tool.py @@ -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', |