[PATCH] docs: tpm: Clarify omission or removal of active_pcr_banks node

Stefan Berger posted 1 patch 1 week, 5 days ago
Test syntax-check failed
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/libvirt tags/patchew/20220112154952.1106711-1-stefanb@linux.ibm.com
docs/formatdomain.rst | 2 ++
1 file changed, 2 insertions(+)

[PATCH] docs: tpm: Clarify omission or removal of active_pcr_banks node

Posted by Stefan Berger 1 week, 5 days ago
Add a sentence to the active_pcr_banks node documentation that clarifies
that when the active_pcr_banks node is removed from the XML or when it
is omitted that the set of active PCR banks is not changed anymore.

Resolves: https://bugzilla.redhat.com/show_bug.cgi?id=2039246
Signed-off-by: Stefan Berger <stefanb@linux.ibm.com>
---
 docs/formatdomain.rst | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
index d4f30bb8af..a84be77c37 100644
--- a/docs/formatdomain.rst
+++ b/docs/formatdomain.rst
@@ -7640,6 +7640,8 @@ Example: usage of the TPM Emulator
    of a TPM 2.0 to activate. Valid names are for example sha1, sha256, sha384,
    and sha512. If this node is provided, the set of PCR banks are activated
    before every start of a VM and this step is logged in the swtpm's log.
+   If this node is removed or omitted then libvirt will not modify the
+   active PCR banks upon VM start but leave them at their last configuration.
    This attribute requires that swtpm_setup v0.7 or later is installed
    and may not have any effect otherwise. The selection of PCR banks only works
    with the ``emulator`` backend. since:`Since 7.10.0`
-- 
2.31.1