[libvirt] [PATCH 2/2] update documentation of <interface type='hostdev'>

[Jim Fehlig]

Chunyan Liu wrote:
> <interface type='hostdev' managed='yes'> is supported, but
> nowhere mentions 'managed' in <interface type='hostdev'> syntax.
> Update documentation to cover it.
>   

Yep, I see the managed attribute is in the schema.

> Signed-off-by: Chunyan Liu <cyliu at suse.com>
> ---
>  docs/formatdomain.html.in | 14 +++++++++++++-
>  1 file changed, 13 insertions(+), 1 deletion(-)
>
> diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
> index 4f19473..c3b9f5b 100644
> --- a/docs/formatdomain.html.in
> +++ b/docs/formatdomain.html.in
> @@ -3510,7 +3510,7 @@
>  <pre>
>    ...
>    <devices>
> -    <interface type='hostdev'>
> +    <interface type='hostdev' managed='yes'>
>        <driver name='vfio'/>
>        <source>
>          <address type='pci' domain='0x0000' bus='0x00' slot='0x07' function='0x0'/>
> @@ -3523,6 +3523,18 @@
>    </devices>
>    ...</pre>
>  
> +    <p>
> +      Similar to the functionality of a standard <hostdev> device,
> +      when <code>managed</code> is "yes", it is detached from the host
> +      before being passed on to the guest, and reattached to the host
> +      after the guest exits. If <code>managed</code> is omitted or "no",
> +      the user is responsible to call <code>virNodeDeviceDettach</code>
> +      (or <code>virsh nodedev-dettach</code>) before starting the guest
> +      or hot-plugging the device, and <code>virNodeDeviceReAttach</code>
> +      (or <code>virsh nodedev-reattach</code>) after hot-unplug or
> +      stopping the guest.
> +    </p>
> +
>   

I suppose the only question I have is whether this paragraph should be
before the example XML snippet or after as you have placed it?  Anyone
else have a comment about that?  Looks good otherwise.

Regards,
Jim

>  
>      <h5><a name="elementsNICSMulticast">Multicast tunnel</a></h5>
>  
>