[pve-devel] [PATCH docs v4 1/2] qm: resource mapping: add description for `mdev` option

[Alexander Zeidler]

On Thu Jun 6, 2024 at 11:22 AM CEST, Dominik Csapak wrote:
> in a new section about additional options
>
> Signed-off-by: Dominik Csapak <d.csapak at proxmox.com>
> ---
> no changes
>  qm.adoc | 13 +++++++++++++
>  1 file changed, 13 insertions(+)
>
> diff --git a/qm.adoc b/qm.adoc
> index 42c26db..3f4e59a 100644
> --- a/qm.adoc
> +++ b/qm.adoc
> @@ -1802,6 +1802,19 @@ To create mappings `Mapping.Modify` on `/mapping/<type>/<name>` is necessary
>  To use these mappings, `Mapping.Use` on `/mapping/<type>/<name>` is necessary
>  (in addition to the normal guest privileges to edit the configuration).
>  
> +Additional Options
> +^^^^^^^^^^^^^^^^^^
Omit the '^' line and use  .Additional Options  instead, to avoid:
asciidoc: WARNING: qm.adoc: line 1806: section title out of sequence: expected level 3, got level 4

> +
> +There are additional options when defining a cluster wide resource mapping.
> +Currently there are the following options:
> +
> +* `mdev` (PCI): This marks the PCI device as being capable of providing
"This marks the PCI device", but your 2/2 patch begins with "This marks the
device", maybe add or remove the word "PCI" to stay consistent.

> +  `mediated devices`. When this is enabled, you can select a type when

> +  configuring it on the guest. If multiple PCI devices are selected for
> +  the mapping, the mediated device will be create on the first one where
> +  there are any available instances of the selected type.
s/create/created/

"where there" could be avoided, e.g.:
If multiple PCI devices are selected for the mapping, the mediated
device will be created on the first device on which instances of the
selected type are available.

> +
> +
>  Managing Virtual Machines with `qm`
>  ------------------------------------
>