[PATCH 1/4] docs: Document TPM portion of domcaps

[Peter Krempa]

On Tue, Jul 12, 2022 at 16:25:46 +0200, Michal Privoznik wrote:
> Surprisingly, we don't document TPM part of domain capabilities.
> Fortunately, the information exposed is pretty much self
> explanatory, but we should document it regardless.
> 
> Signed-off-by: Michal Privoznik <mprivozn at redhat.com>
> ---
>  docs/formatdomaincaps.rst | 30 ++++++++++++++++++++++++++++++
>  1 file changed, 30 insertions(+)
> 
> diff --git a/docs/formatdomaincaps.rst b/docs/formatdomaincaps.rst
> index 933469b2a2..384b5eb7ea 100644
> --- a/docs/formatdomaincaps.rst
> +++ b/docs/formatdomaincaps.rst
> @@ -494,6 +494,36 @@ instance:
>  ``driverType``
>     Options for the ``type`` attribute of the <filesystem><driver> element.
>  
> +TPM device
> +^^^^^^^^^^
> +
> +TPM device capabilities are exposed under the ``tpm`` element. For instance:
> +
> +::

One neat thing RST allows is that you can put a double colon on the end
of the "For instance::" and then can omit the explicit code block by
separate double colons.

We use both so this is just an FYI, no need to change it.

> +
> +  <domainCapabilities>
> +    ...
> +    <devices>
> +      <tpm supported='yes'>
> +        <enum name='model'>
> +          <value>tpm-tis</value>
> +          <value>tpm-crb</value>
> +        </enum>
> +        <enum name='backendModel'>
> +          <value>passthrough</value>
> +          <value>emulator</value>
> +        </enum>
> +      </tpm>
> +      ...
> +    </devices>
> +  <domainCapabilities>

Closing tag here ^

> +
> +``model``
> +   Options for the ``model`` attribute of the <tpm/> element.
> +``backendModel``
> +   Options for the ``type`` attribute of the <tpm><backend/> element.

Please mark the XML elements as literals too.

> +
> +
>  Features
>  ~~~~~~~~
>  
> -- 
> 2.35.1
> 

Reviewed-by: Peter Krempa <pkrempa at redhat.com>