Note: This bug is displayed in read-only format because
the product is no longer active in Red Hat Bugzilla.
RHEL Engineering is moving the tracking of its product development work on RHEL 6 through RHEL 9 to Red Hat Jira (issues.redhat.com). If you're a Red Hat customer, please continue to file support cases via the Red Hat customer portal. If you're not, please head to the "RHEL project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs in the statuses "NEW", "ASSIGNED", and "POST" are being migrated throughout September 2023. Bugs of Red Hat partners with an assigned Engineering Partner Manager (EPM) are migrated in late September as per pre-agreed dates. Bugs against components "kernel", "kernel-rt", and "kpatch" are only migrated if still in "NEW" or "ASSIGNED". If you cannot log in to RH Jira, please consult article #7032570. That failing, please send an e-mail to the RH Jira admins at rh-issues@redhat.com to troubleshoot your issue as a user management inquiry. The email creates a ServiceNow ticket with Red Hat. Individual Bugzilla bugs that are migrated will be moved to status "CLOSED", resolution "MIGRATED", and set with "MigratedToJIRA" in "Keywords". The link to the successor Jira issue will be found under "Links", have a little "two-footprint" icon next to it, and direct you to the "RHEL project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/RHEL-XXXX", where "X" is a digit). This same link will be available in a blue banner at the top of the page informing you that that bug has been migrated.
Description of problem:
virt-sparsify --help print wrong description of a option
This is a valid usage but it's hard to get common understanding and do not in accordance with other help info of some virt-tools like virt-builder, virt-customize, virt-sysprep:
#virt-builder --help|egrep '\-v |\-\-verbose'
-v Enable debugging messages
--verbose Enable debugging messages
#virt-customize --help|egrep '\-v |\-\-verbose'
-v Enable debugging messages
--verbose Enable debugging messages
#virt-sysprep --help|egrep '\-v |\-\-verbose'
-v Enable debugging messages
--verbose Enable debugging messages
#virt-sparsify --help|egrep '\-v |\-\-verbose'
-v Enable debugging messages
--verbose -"-
Version-Release number of selected component (if applicable):
libguestfs-1.27.43-1.1.el7
How reproducible:
100%
Steps to Reproduce:
#virt-sparsify --help
virt-sparsify: sparsify a virtual machine disk
virt-sparsify [--options] indisk outdisk
virt-sparsify [--options] --in-place disk
A short summary of the options is given below. For detailed help please
read the man page virt-sparsify(1).
--check-tmpdir ignore|... Check there is enough space in $TMPDIR
--compress Compressed output format
--convert format Format of output disk (default: same as input)
--debug-gc Debug GC and memory allocations
--format format Format of input disk
--ignore fs Ignore filesystem
--in-place Modify the disk image in-place
--inplace -"-
--long-options List long options
--machine-readable Make output machine readable
-o option Add qemu-img options
-q Quiet output
--quiet -"-
--tmp block|dir|prebuilt:file Set temporary block device, directory or prebuilt file
-v Enable debugging messages
--verbose -"-
-V Display version and exit
--version -"-
-x Enable tracing of libguestfs calls
--zero fs Zero filesystem
-help Display this list of options
--help Display this list of options
Actual results:
Description of option --inplace, --quiet, --verbose, --version is -"-
Expected results:
Description of option --inplace, --quiet, --verbose, --version should be:
--inplace Modify the disk image in-place
--quiet Quiet output
--verbose Enable debugging messages
--version Display version and exit
Additional info:
Comment 2Richard W.M. Jones
2014-09-16 15:35:43 UTC
(In reply to Richard W.M. Jones from comment #2)
> -"- is the common mark for ditto.
>
> https://en.wikipedia.org/wiki/Ditto_mark
> https://en.wikipedia.org/wiki/Ditto
>
> I don't believe this is a bug.
Yes, accurate to say this is not a bug, because -"- is a ditto mark. I file this bug because this bug may help you to improve the help info of virt-sparsify :-). There are many people who can not recognize what -"- means and such format is different from other virt tools such as virt-builder, virt-customize, virt-sysprep, it is better to keep the same format with other virt tools, but it's no problem to do like this.
Also even in the same help info, it have two different format to descript a same function:
# virt-sparsify --help
--check-tmpdir ignore|... Check there is enough space in $TMPDIR
....................
--in-place Modify the disk image in-place
--inplace -"-
....................
-q Quiet output
--quiet -"-
....................
-V Display version and exit
--version -"-
-help Display this list of options
--help Display this list of options
Comment 6Richard W.M. Jones
2015-09-23 15:06:30 UTC