Red Hat Bugzilla – Bug 830051
[Doc] virsh doc has error/omission on device commands and nodedev commands
Last modified: 2013-02-21 02:16:43 EST
Description of problem:
When review man virsh doc for device commands and nodedev commands, find some problems
1. attach-disk parameter "type" in virsh doc said that "type can indicate cdrom or floppy as alternative to the disk default", omit another allowed type "lun"
2. attach-disk parameter "target" in virsh doc said that "source and target are paths for the files and devices.", the target should be the logical device name, but not path
3. For attach-device, detach-device, detach-disk, detach-interface, omit list parameter --persistent in virsh doc
Version-Release number of selected component (if applicable):
Steps to Reproduce:
1.man virsh, and find the device and nodedev commands part
Also, for attach-interface libvirt will ignore the target name which begin with vnet, I think it should be mentioned in man page
I've proposed patch:
Except --persistent which is just an alias to --config. Users are advised to use the new --config therefore we don't want to expose --persistent much:
Therefore I am moving this to POST.
Author: Michal Privoznik <firstname.lastname@example.org>
AuthorDate: Mon Jun 18 13:14:49 2012 +0200
Commit: Michal Privoznik <email@example.com>
CommitDate: Mon Jun 18 13:14:49 2012 +0200
virsh: Tweak attach-* documentation
as we are missing:
attach-disk: --type can accept 'lun' too, not just cdrom or floppy.
attach-disk: --target specify logical device name, not path
attach-interface: --target silently drops strings with vnet* prefix
Verified this issue with:
target controls the bus or device under which the disk is exposed to the guest OS. It indicates the "logical" device name.
type can indicate lun, cdrom or floppy as alternative to thedisk default, although this use only replaces the media within the existing virtual cdrom or floppy device;
2.attach-device, detach-device, detach-disk, detach-interface
For compatibility purposes, --persistent is an alias of --config.
target allows to indicate the target device in the guest. Names starting with ’vnet’ are considered as auto-generated an hence blanked out.
So change the bug status to VERIFIED.
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.
For information on the advisory, and where to find the updated
files, follow the link below.
If the solution does not work for you, open a new bug report.