Red Hat Bugzilla – Bug 648855
Virsh help / man page typo
Last modified: 2011-12-03 19:10:03 EST
Description of problem:
I find several virsh help or man page tiny typo, so use this bug to track this kind of issues.
Version-Release number of selected component (if applicable):
Steps to Reproduce:
1. man page line 447
2. man page line 307
1. domain-id can be specified as an short integer
2. edit domain.xml
1. Change 'an' to 'a'
2. virsh edit domain.xml
fixed, upstream patch:
on man page of virsh for command migrate it loses optional parameters and description such as --p2p --direct --tunnelled --persistent --undefinesource --copy-storage-inc --copy-storage-all
for command attach-disk, it loses the optional parameters and description --sourcetype
these two patches are pushed.
1.# virsh help reboot
Run a reboot command in the target domain.
Description incorrect. Expected:"Run reboot command in host to reboot
This package has changed ownership in the Fedora Package Database. Reassigning to the new owner of this component.
(In reply to comment #0)
> Description of problem:
> I find several virsh help or man page tiny typo, so use this bug to track this
> kind of issues.
The initial complaint of typos has been fixed. New issues should be reported on email@example.com or filed as new BZs.
(In reply to comment #5)
> 1.# virsh help reboot
> Run a reboot command in the target domain.
This has nothing to do with typos; while I agree that this wording could be improved, it should be brought up on the list rather than extending the life of this bug. Besides,
> Description incorrect. Expected:"Run reboot command in host to reboot
> target domain"
I'm not sure I like this suggested wording any better. The host really does request that the guest reboot itself (either via an ACPI interrupt or via a guest agent command); the host can't do the reboot itself, since reboot requires guest cooperation.
Maybe it would be better as:
'request that the target domain be rebooted (requires guest cooperation)'
but again, bring that up on list.
Marking as closed nextrelease; it's not worth backporting spelling fixes into F14 at this time, but newer versions should have fewer typos. I'm also doing another sweep of 'an' misuses, via https://www.redhat.com/archives/libvir-list/2011-December/msg00176.html