Doc: Explicitly declaring that nodedev-destroy only works for vHBA

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>
This commit is contained in:
Osier Yang 2013-11-22 20:55:25 +08:00
parent aaa7484097
commit ec2fb767bb
2 changed files with 6 additions and 5 deletions

View File

@ -16070,8 +16070,9 @@ error:
* virNodeDeviceDestroy: * virNodeDeviceDestroy:
* @dev: a device object * @dev: a device object
* *
* Destroy the device object. The virtual device is removed from the host operating system. * Destroy the device object. The virtual device (only works for vHBA
* This function may require privileged access * 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. * Returns 0 in case of success and -1 in case of failure.
*/ */

View File

@ -2158,9 +2158,9 @@ contains xml for a top-level <device> description of a node device.
=item B<nodedev-destroy> I<device> =item B<nodedev-destroy> I<device>
Destroy (stop) a device on the host. I<device> can be either 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 name or wwn pair in "wwnn,wwpn" format (only works for vHBA currently).
that this makes libvirt quit managing a host device, and may even make Note that this makes libvirt quit managing a host device, and may even
that device unusable by the rest of the physical host until a reboot. make that device unusable by the rest of the physical host until a reboot.
=item B<nodedev-detach> I<nodedev> [I<--driver backend_driver>] =item B<nodedev-detach> I<nodedev> [I<--driver backend_driver>]