[PATCH] [Doc] Update 2 items in the formatdomain.rst

Yalan Zhang posted 1 patch 1 year, 10 months ago
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/libvirt tags/patchew/20220616051142.26805-1-yalzhang@redhat.com
docs/formatdomain.rst | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
[PATCH] [Doc] Update 2 items in the formatdomain.rst
Posted by Yalan Zhang 1 year, 10 months ago
Update the default "driver" value for hostdev interface since
the default is not "KVM" anymore(refer to "Host device
asssignment" part and by test results). And update the mac
address in one xml example.

Signed-off-by: Yalan Zhang <yalzhang@redhat.com>
---
 docs/formatdomain.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
index b6a3495093..19c4aa5e2e 100644
--- a/docs/formatdomain.rst
+++ b/docs/formatdomain.rst
@@ -4917,9 +4917,9 @@ To use VFIO device assignment rather than traditional/legacy KVM device
 assignment (VFIO is a new method of device assignment that is compatible with
 UEFI Secure Boot), a type='hostdev' interface can have an optional ``driver``
 sub-element with a ``name`` attribute set to "vfio". To use legacy KVM device
-assignment you can set ``name`` to "kvm" (or simply omit the ``<driver>``
-element, since "kvm" is currently the default). :since:`Since 1.0.5 (QEMU and
-KVM only, requires kernel 3.6 or newer)`
+assignment you can set ``name`` to "kvm" (the default is "vfio" on systems
+where the VFIO driver is available, and "kvm" on older systems. :since:`Since
+1.1.3` (prior to that the default was always "kvm").
 
 Note that this "intelligent passthrough" of network devices is very similar to
 the functionality of a standard <hostdev> device, the difference being that this
@@ -5018,7 +5018,7 @@ directly reference an SRIOV VF device:
        <source>
          <address type='pci' domain='0x0000' bus='0x00' slot='0x07' function='0x0'/>
        </source>
-       <mac address='00:11:22:33:44:55:66'/>
+       <mac address='00:11:22:33:44:55'/>
        <teaming type='transient' persistent='ua-backup0'/>
      </interface>
    ...
-- 
2.32.0
Re: [PATCH] [Doc] Update 2 items in the formatdomain.rst
Posted by Ján Tomko 1 year, 10 months ago
Saying what part of the file is being updated is more useful than
counting the changes. I've changed the commit summary to:

   docs: formatdomain: update hostdev interface section a bit

On a Thursday in 2022, Yalan Zhang wrote:
>Update the default "driver" value for hostdev interface since
>the default is not "KVM" anymore(refer to "Host device
>asssignment" part and by test results). And update the mac
>address in one xml example.
>
>Signed-off-by: Yalan Zhang <yalzhang@redhat.com>
>---
> docs/formatdomain.rst | 8 ++++----
> 1 file changed, 4 insertions(+), 4 deletions(-)
>
>diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
>index b6a3495093..19c4aa5e2e 100644
>--- a/docs/formatdomain.rst
>+++ b/docs/formatdomain.rst
>@@ -4917,9 +4917,9 @@ To use VFIO device assignment rather than traditional/legacy KVM device
> assignment (VFIO is a new method of device assignment that is compatible with
> UEFI Secure Boot), a type='hostdev' interface can have an optional ``driver``
> sub-element with a ``name`` attribute set to "vfio". To use legacy KVM device
>-assignment you can set ``name`` to "kvm" (or simply omit the ``<driver>``
>-element, since "kvm" is currently the default). :since:`Since 1.0.5 (QEMU and
>-KVM only, requires kernel 3.6 or newer)`
>+assignment you can set ``name`` to "kvm" (the default is "vfio" on systems
>+where the VFIO driver is available, and "kvm" on older systems. :since:`Since
>+1.1.3` (prior to that the default was always "kvm").
>

It seems the whole section could use a rewrite with VFIO in mind, but
this change at least gets rid of the incorrect claims.

Reviewed-by: Ján Tomko <jtomko@redhat.com>

and pushed.

Jano