Bug 1533015

Summary: Mini problems in virt-install and virt-xml help message
Product: Red Hat Enterprise Linux 7 Reporter: zhoujunqin <juzhou>
Component: virt-managerAssignee: Pavel Hrdina <phrdina>
Status: CLOSED ERRATA QA Contact: Virtualization Bugs <virt-bugs>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 7.5CC: mxie, phrdina, tzheng, xiaodwan
Target Milestone: rc   
Target Release: ---   
Hardware: x86_64   
OS: Unspecified   
Whiteboard:
Fixed In Version: virt-manager-1.5.0-2.el7 Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2019-08-06 13:07:59 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 zhoujunqin 2018-01-10 09:31:39 UTC
Description of problem:
Mini problems in virt-install help message 

Version-Release number of selected component (if applicable):
virt-manager-1.4.3-3.el7.noarch
virt-install-1.4.3-3.el7.noarch


How reproducible:
100%

Steps to Reproduce:
1. Check description for virt-install help message.
1.1 
  --vcpus VCPUS         Number of vcpus to configure for your guest. Ex:
                        --vcpus 5
                        --vcpus 5,maxcpus=10,cpuset=1-4,6,8
                        --vcpus sockets=2,cores=4,threads=2,

1.2   --sound [SOUND]       Configure guest sound device emulation


Actual results:
1.1 
wrong spelling maxcpus instead of 'maxvcpus' in example
There is a comma after threads=2

1.2
Has bracket([]) for SOUND


Expected results:
1. Update "maxcpus" to right one "maxvcpus" in virt-install help message
2. Remove comma(,) after threads=2
3. Remove bracket ([]) from SOUND

Additional info:

Comment 2 zhoujunqin 2018-01-10 10:18:46 UTC
And same issue in virt-xml help message
# virt-xml --help |grep maxcpus
                        --vcpus 5,maxcpus=10,cpuset=1-4,6,8

Result:
wrong spelling maxcpus instead of 'maxvcpus' in example

Comment 4 Pavel Hrdina 2019-01-15 14:32:22 UTC
Upstream commit:

commit 14033113a495a7ed1b95e6a22f79c75cdd6a0463
Author: Pavel Hrdina <phrdina>
Date:   Tue Jan 15 14:47:01 2019 +0100

    cli: fix typos in virt-install --help output

Comment 5 Pavel Hrdina 2019-01-15 14:33:59 UTC
The --sound part is intentional because the brackets indicates that the [SOUND] is optional.

Comment 8 ysu@redhat.com 2019-04-29 03:25:06 UTC
I can reproduce this issue with package:
virt-manager-1.4.3-3.el7.noarch
virt-install-1.4.3-3.el7.noarch

Then try to verify this bug with new build:
virt-manager-1.5.0-3.el7.noarch
virt-install-1.5.0-3.el7.noarch
libvirt-4.5.0-12.el7.x86_64
qemu-kvm-rhev-2.12.0-26.el7.x86_64
libvirt-python-4.5.0-1.el7.x86_64

Steps:

1.Check descriptions of 'maxvcpu' and format of 'threads=2,'for virt-install help message.
1.1 #virt-isntall -h

--vcpus VCPUS Number of vcpus to configure for your guest. Ex:
--vcpus 5
--vcpus 5,maxvcpus=10,cpuset=1-4,6,8
--vcpus sockets=2,cores=4,threads=2
Result:'Maxvcpu' and comma(,) after threads=2 in virt-install help message is correct.


2.Check descriptions of 'maxvcpu' and format of 'threads=2,'for virt-xml help message.
2.1 #virt-xml --help

--vcpus VCPUS Number of vcpus to configure for your guest. Ex:
--vcpus 5
--vcpus 5,maxvcpus=10,cpuset=1-4,6,8
--vcpus sockets=2,cores=4,threads=2

Result:'Maxvcpu' and comma(,) after threads=2 in virt-xml help message is correct.

I move this bug from ON_QA to VERIFIED based on above testing.

Comment 10 errata-xmlrpc 2019-08-06 13:07:59 UTC
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.

https://access.redhat.com/errata/RHBA-2019:2232