]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
Doc: Explicitly declaring that nodedev-destroy only works for vHBA
authorOsier Yang <jyang@redhat.com>
Fri, 22 Nov 2013 12:55:25 +0000 (20:55 +0800)
committerOsier Yang <jyang@redhat.com>
Tue, 3 Dec 2013 08:34:46 +0000 (16:34 +0800)
Though trying to destroy a physical HBA doesn't make sense at all,
it's still a bit misleading with saying "only works for HBA".

Signed-off-by: Osier Yang <jyang@redhat.com>
src/libvirt.c
tools/virsh.pod

index a2df53d3bfc151b88c5a30f0c8e3bc46df8e0f64..8618f4f5e9f977a920ff265ee1fb6b0be814c0e9 100644 (file)
@@ -16070,8 +16070,9 @@ error:
  * virNodeDeviceDestroy:
  * @dev: a device object
  *
- * Destroy the device object. The virtual device is removed from the host operating system.
- * This function may require privileged access
+ * Destroy the device object. The virtual device (only works for vHBA
+ * currently) is removed from the host operating system.  This function
+ * may require privileged access.
  *
  * Returns 0 in case of success and -1 in case of failure.
  */
index f51060fde80df3c200ff60365b2ed87a9aaf6218..c6a8be3d1f323658396d08b96eece8a458530149 100644 (file)
@@ -2158,9 +2158,9 @@ contains xml for a top-level <device> description of a node device.
 =item B<nodedev-destroy> I<device>
 
 Destroy (stop) a device on the host. I<device> can be either device
-name or wwn pair in "wwnn,wwpn" format (only works for HBA). Note
-that this makes libvirt quit managing a host device, and may even make
-that device unusable by the rest of the physical host until a reboot.
+name or wwn pair in "wwnn,wwpn" format (only works for vHBA currently).
+Note that this makes libvirt quit managing a host device, and may even
+make that device unusable by the rest of the physical host until a reboot.
 
 =item B<nodedev-detach> I<nodedev> [I<--driver backend_driver>]