[PATCH 1/1] docs/s390x: fix vfio-ap device_del description

[PATCH 1/1] docs/s390x: fix vfio-ap device_del description

[Christian Borntraeger]

device_del requires an id and not a sysfsfile.

Signed-off-by: Christian Borntraeger <borntraeger@de.ibm.com>
---
 docs/system/s390x/vfio-ap.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/docs/system/s390x/vfio-ap.rst b/docs/system/s390x/vfio-ap.rst
index 3cd84179a2df..f441df69edde 100644
--- a/docs/system/s390x/vfio-ap.rst
+++ b/docs/system/s390x/vfio-ap.rst
@@ -606,10 +606,11 @@ action.
 
 To hot plug a vfio-ap device, use the QEMU ``device_add`` command::
 
-    (qemu) device_add vfio-ap,sysfsdev="$path-to-mdev"
+    (qemu) device_add vfio-ap,sysfsdev="$path-to-mdev",id="$id"
 
 Where the ``$path-to-mdev`` value specifies the absolute path to a mediated
 device to which AP resources to be used by the guest have been assigned.
+``$id`` is the name value for the optional id parameter.
 
 Note that on Linux guests, the AP devices will be created in the
 ``/sys/bus/ap/devices`` directory when the AP bus subsequently performs its periodic
@@ -632,10 +633,9 @@ or a prior hot plug action.
 
 To hot unplug a vfio-ap device, use the QEMU ``device_del`` command::
 
-    (qemu) device_del vfio-ap,sysfsdev="$path-to-mdev"
+    (qemu) device_del "id"
 
-Where ``$path-to-mdev`` is the same as the path specified when the vfio-ap
-device was attached to the virtual machine's ap-bus.
+Where ``$id`` is the same id that was specified at device creation.
 
 On a Linux guest, the AP devices will be removed from the ``/sys/bus/ap/devices``
 directory on the guest when the AP bus subsequently performs its periodic scan,
-- 
2.25.4

Re: [PATCH 1/1] docs/s390x: fix vfio-ap device_del description

[Christian Borntraeger]

wrong Person on to, I wanted to send this to Tony.


On 17.06.20 18:06, Christian Borntraeger wrote:
> device_del requires an id and not a sysfsfile.
> 
> Signed-off-by: Christian Borntraeger <borntraeger@de.ibm.com>
> ---
>  docs/system/s390x/vfio-ap.rst | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/docs/system/s390x/vfio-ap.rst b/docs/system/s390x/vfio-ap.rst
> index 3cd84179a2df..f441df69edde 100644
> --- a/docs/system/s390x/vfio-ap.rst
> +++ b/docs/system/s390x/vfio-ap.rst
> @@ -606,10 +606,11 @@ action.
>  
>  To hot plug a vfio-ap device, use the QEMU ``device_add`` command::
>  
> -    (qemu) device_add vfio-ap,sysfsdev="$path-to-mdev"
> +    (qemu) device_add vfio-ap,sysfsdev="$path-to-mdev",id="$id"
>  
>  Where the ``$path-to-mdev`` value specifies the absolute path to a mediated
>  device to which AP resources to be used by the guest have been assigned.
> +``$id`` is the name value for the optional id parameter.
>  
>  Note that on Linux guests, the AP devices will be created in the
>  ``/sys/bus/ap/devices`` directory when the AP bus subsequently performs its periodic
> @@ -632,10 +633,9 @@ or a prior hot plug action.
>  
>  To hot unplug a vfio-ap device, use the QEMU ``device_del`` command::
>  
> -    (qemu) device_del vfio-ap,sysfsdev="$path-to-mdev"
> +    (qemu) device_del "id"
>  
> -Where ``$path-to-mdev`` is the same as the path specified when the vfio-ap
> -device was attached to the virtual machine's ap-bus.
> +Where ``$id`` is the same id that was specified at device creation.
>  
>  On a Linux guest, the AP devices will be removed from the ``/sys/bus/ap/devices``
>  directory on the guest when the AP bus subsequently performs its periodic scan,
> 

Re: [PATCH 1/1] docs/s390x: fix vfio-ap device_del description

[Cornelia Huck]

On Wed, 17 Jun 2020 18:06:04 +0200
Christian Borntraeger <borntraeger@de.ibm.com> wrote:

> device_del requires an id and not a sysfsfile.

Fixes: bac03ec72f1b ("s390x/vfio-ap: document hot plug/unplug of vfio-ap device")

> 
> Signed-off-by: Christian Borntraeger <borntraeger@de.ibm.com>
> ---
>  docs/system/s390x/vfio-ap.rst | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 

Looks correct to me, will pick when I get an ack/r-b.

Re: [PATCH 1/1] docs/s390x: fix vfio-ap device_del description

[Thomas Huth]

On 17/06/2020 18.06, Christian Borntraeger wrote:
> device_del requires an id and not a sysfsfile.
> 
> Signed-off-by: Christian Borntraeger <borntraeger@de.ibm.com>
> ---
>  docs/system/s390x/vfio-ap.rst | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/docs/system/s390x/vfio-ap.rst b/docs/system/s390x/vfio-ap.rst
> index 3cd84179a2df..f441df69edde 100644
> --- a/docs/system/s390x/vfio-ap.rst
> +++ b/docs/system/s390x/vfio-ap.rst
> @@ -606,10 +606,11 @@ action.
>  
>  To hot plug a vfio-ap device, use the QEMU ``device_add`` command::
>  
> -    (qemu) device_add vfio-ap,sysfsdev="$path-to-mdev"
> +    (qemu) device_add vfio-ap,sysfsdev="$path-to-mdev",id="$id"
>  
>  Where the ``$path-to-mdev`` value specifies the absolute path to a mediated
>  device to which AP resources to be used by the guest have been assigned.
> +``$id`` is the name value for the optional id parameter.
>  
>  Note that on Linux guests, the AP devices will be created in the
>  ``/sys/bus/ap/devices`` directory when the AP bus subsequently performs its periodic
> @@ -632,10 +633,9 @@ or a prior hot plug action.
>  
>  To hot unplug a vfio-ap device, use the QEMU ``device_del`` command::
>  
> -    (qemu) device_del vfio-ap,sysfsdev="$path-to-mdev"
> +    (qemu) device_del "id"

Do you want to use $id instead of id here?
>  
> -Where ``$path-to-mdev`` is the same as the path specified when the vfio-ap
> -device was attached to the virtual machine's ap-bus.
> +Where ``$id`` is the same id that was specified at device creation.

            ^--- ... since you use $id here.

>  On a Linux guest, the AP devices will be removed from the ``/sys/bus/ap/devices``
>  directory on the guest when the AP bus subsequently performs its periodic scan,

With the 1 $ question fixed:

Reviewed-by: Thomas Huth <thuth@redhat.com>

Re: [PATCH 1/1] docs/s390x: fix vfio-ap device_del description

[Cornelia Huck]

On Wed, 17 Jun 2020 19:17:54 +0200
Thomas Huth <thuth@redhat.com> wrote:

> On 17/06/2020 18.06, Christian Borntraeger wrote:
> > device_del requires an id and not a sysfsfile.
> > 
> > Signed-off-by: Christian Borntraeger <borntraeger@de.ibm.com>
> > ---
> >  docs/system/s390x/vfio-ap.rst | 8 ++++----
> >  1 file changed, 4 insertions(+), 4 deletions(-)
> > 
> > diff --git a/docs/system/s390x/vfio-ap.rst b/docs/system/s390x/vfio-ap.rst
> > index 3cd84179a2df..f441df69edde 100644
> > --- a/docs/system/s390x/vfio-ap.rst
> > +++ b/docs/system/s390x/vfio-ap.rst
> > @@ -606,10 +606,11 @@ action.
> >  
> >  To hot plug a vfio-ap device, use the QEMU ``device_add`` command::
> >  
> > -    (qemu) device_add vfio-ap,sysfsdev="$path-to-mdev"
> > +    (qemu) device_add vfio-ap,sysfsdev="$path-to-mdev",id="$id"
> >  
> >  Where the ``$path-to-mdev`` value specifies the absolute path to a mediated
> >  device to which AP resources to be used by the guest have been assigned.
> > +``$id`` is the name value for the optional id parameter.
> >  
> >  Note that on Linux guests, the AP devices will be created in the
> >  ``/sys/bus/ap/devices`` directory when the AP bus subsequently performs its periodic
> > @@ -632,10 +633,9 @@ or a prior hot plug action.
> >  
> >  To hot unplug a vfio-ap device, use the QEMU ``device_del`` command::
> >  
> > -    (qemu) device_del vfio-ap,sysfsdev="$path-to-mdev"
> > +    (qemu) device_del "id"  
> 
> Do you want to use $id instead of id here?
> >  
> > -Where ``$path-to-mdev`` is the same as the path specified when the vfio-ap
> > -device was attached to the virtual machine's ap-bus.
> > +Where ``$id`` is the same id that was specified at device creation.  
> 
>             ^--- ... since you use $id here.
> 
> >  On a Linux guest, the AP devices will be removed from the ``/sys/bus/ap/devices``
> >  directory on the guest when the AP bus subsequently performs its periodic scan,  
> 
> With the 1 $ question fixed:
> 
> Reviewed-by: Thomas Huth <thuth@redhat.com>

Indeed, no reason to skimp on the $s :)

Fixed up and pushed to s390-next, thanks.