[libvirt] [PATCH 1/4] virsh.rst: Mention media update is not supported in attach-{disk, device}

Han Han posted 4 patches 1 year, 9 months ago

[libvirt] [PATCH 1/4] virsh.rst: Mention media update is not supported in attach-{disk, device}

Posted by Han Han 1 year, 9 months ago
Signed-off-by: Han Han <hhan@redhat.com>
---
 docs/manpages/virsh.rst | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/docs/manpages/virsh.rst b/docs/manpages/virsh.rst
index c637caa583..92f113fbde 100644
--- a/docs/manpages/virsh.rst
+++ b/docs/manpages/virsh.rst
@@ -4391,9 +4391,7 @@ as the top-level element.  See the documentation at
 libvirt XML format for a device.  If *--config* is specified the
 command alters the persistent domain configuration with the device
 attach taking effect the next time libvirt starts the domain.
-For cdrom and floppy devices, this command only replaces the media
-within an existing device; consider using ``update-device`` for this
-usage.  For passthrough host devices, see also ``nodedev-detach``,
+For passthrough host devices, see also ``nodedev-detach``,
 needed if the PCI device does not use managed mode.
 
 If *--live* is specified, affect a running domain.
@@ -4408,7 +4406,8 @@ an offline domain, and like *--live* *--config* for a running domain.
 
 ``Note``: using of partial device definition XML files may lead to unexpected
 results as some fields may be autogenerated and thus match devices other than
-expected.
+expected. It doesn't support replace the media within the existing virtual
+cdrom or floppy device. Use ``update-device`` or ``change-media`` instead.
 
 
 attach-disk
@@ -4442,9 +4441,7 @@ of the disk source, such as *raw* or *qcow2*.  Hypervisor default will be
 used if *subdriver* is not specified.  However, the default may not be
 correct, esp. for QEMU as for security reasons it is configured not to detect
 disk formats.  *type* can indicate *lun*, *cdrom* or *floppy* as
-alternative to the disk default, although this use only replaces the media
-within the existing virtual cdrom or floppy device; consider using
-``update-device`` for this usage instead.
+alternative to the disk default.
 *alias* can set user supplied alias.
 *mode* can specify the two specific mode *readonly* or *shareable*.
 *sourcetype* can indicate the type of source (block|file)
@@ -4476,6 +4473,9 @@ For compatibility purposes, *--persistent* behaves like *--config* for
 an offline domain, and like *--live* *--config* for a running domain.
 Likewise, *--shareable* is an alias for *--mode shareable*.
 
+``Note``: It doesn't support replace the media within the existing virtual
+cdrom or floppy device. Use ``update-device`` or ``change-media`` instead.
+
 
 attach-interface
 ----------------
-- 
2.24.0.rc1

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list