Bug 952086

Summary: Should add a matrix to man page for controller and their related models
Product: Red Hat Enterprise Linux 7 Reporter: Geyang Kong <gkong>
Component: virt-managerAssignee: Martin Kletzander <mkletzan>
Status: CLOSED CURRENTRELEASE QA Contact: Virtualization Bugs <virt-bugs>
Severity: medium Docs Contact:
Priority: medium    
Version: 7.0CC: cwei, dyuan, lcui, mjenner, mkletzan, mzhan, tzheng
Target Milestone: rc   
Target Release: ---   
Hardware: x86_64   
OS: Linux   
Whiteboard:
Fixed In Version: virt-manager-0.10.0-1.el7 Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2014-06-13 12:07:18 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Geyang Kong 2013-04-15 07:25:49 UTC
Description of problem:
  Should add a matrix to man page for controller and their related models

Version-Release number of selected component (if applicable):
python-virtinst-0.600.4-1.el7.noarch
libvirt-1.0.4-1.el7.x86_64

Reproduce steps:
1. Run man virt-install
2. Find Device Options part.

Actual results:
1. After step 2, could only get following output:
........
   Device Options
       --controller=TYPE[,OPTS]
         Attach a controller device to the guest. TYPE is one of: ide, fdc, scsi, sata, virtio-serial, or usb.

         Controller also supports the special value usb2, which will set up a USB2 controller with fallback USB1
         support.

         model
             Controller model.
.........

There is nothing to describe controller model in the man page, this will make user have no idea about how to set it with different controller type.

Expected results:
1. There should be a matrix, at least like --os-variant, to tell user which models are supported by which type.
 
Additional info:

Comment 1 Martin Kletzander 2013-04-19 13:21:24 UTC
From my POV, I think the model list should not be added to the man page, as it depends more on libvirt and qemu.  Would you be satisfied with adding a info where to find list of supported models?

Comment 2 Geyang Kong 2013-04-24 02:51:08 UTC
You have to install libvirt-debuginfo package, then you should get a file under this path:
/usr/src/debug/libvirt-1.0.3/src/conf/domain_conf.c

From line 291, you will get them

Comment 3 Martin Kletzander 2013-04-24 08:36:38 UTC
I know where to find the information.  It is even better understandable from the libvirt documentation (e.g. online [1]), but I think it makes more sense to just point users to that place instead of duplicating the information.

Let me propose that upstream and we'll see how that goes.

[1] http://libvirt.org/formatdomain.html#elementsControllers

Comment 4 Martin Kletzander 2013-04-25 11:08:20 UTC
Patch proposed upstream:
https://www.redhat.com/archives/virt-tools-list/2013-April/msg00248.html

Would this be OK?  In case this solution doesn't suit you, don't hesitate to step up and let me know, thanks.

Comment 5 Geyang Kong 2013-04-26 01:33:32 UTC
Looks good, I think I can accept this.

Comment 6 Martin Kletzander 2013-04-26 06:56:42 UTC
Moving to POST based on commit RELEASE-0.9.5-1-189-g13c5ffc:

commit 13c5ffc6cd662935700d3be3b2eaec8ab4e0b314
Author: Martin Kletzander <mkletzan>
Date:   Thu Apr 25 12:43:06 2013 +0200

    Describe controller models in virt-install man page

Comment 9 luxin 2013-08-14 02:52:19 UTC
I can reproduce this bug:

Version:
python-virtinst-0.600.4-1.el7.noarch
libvirt-1.0.4-1.el7.x86_64

Steps for Reproduce:
1. Run #man virt-install
2. Find Device Options part.

Result:
After step 2, 
Device Options
         --controller=TYPE[,OPTS]
         Attach a controller device to the guest. TYPE is one of: ide, fdc,
         scsi, sata, virtio-serial, or usb.

         Controller also supports the special value usb2, which will set up a
         USB2 controller with fallback USB1 support.

         model
             Controller model.

         address
             Controller address, current PCI of form
             'bus:domain:slot:function'.
         ......
There is nothing to describe controller model in the man page

Verify:
virt-install-0.10.0-1.el7.noarch.rpm 
virt-manager-0.10.0-1.el7.noarch.rpm 
virt-manager-common-0.10.0-1.el7.noarch.rpm 

Steps for Verify:
1. Run #man virt-install
2. Find Device Options part.

Result:
After step 2
Device Options
       --controller=TYPE[,OPTS]
         Attach a controller device to the guest. TYPE is one of: ide, fdc,
         scsi, sata, virtio-serial, or usb.

         Controller also supports the special value usb2, which will set up a
         USB2 controller with fallback USB1 support.

         model
             Controller model.  These may vary according to the hypervisor and
             its version.  Most commonly used models are e.g. auto, virtio-
             scsi for the scsi controller, ehci or none for the usb
             controller.  For full list and further details on
             controllers/models, see
             "http://libvirt.org/formatdomain.html#elementsControllers".

         address
             Controller address, current PCI of form
             'bus:domain:slot:function'.
         ......
There is description about controller models to help user understand how to set it with different controller types.

Comment 10 Ludek Smid 2014-06-13 12:07:18 UTC
This request was resolved in Red Hat Enterprise Linux 7.0.

Contact your manager or support representative in case you have further questions about the request.