Bug 738411
| Summary: | doc: typo errors on virsh help snapshot-create-as | ||
|---|---|---|---|
| Product: | Red Hat Enterprise Linux 6 | Reporter: | Nan Zhang <nzhang> |
| Component: | libvirt | Assignee: | Eric Blake <eblake> |
| Status: | CLOSED ERRATA | QA Contact: | Virtualization Bugs <virt-bugs> |
| Severity: | medium | Docs Contact: | |
| Priority: | medium | ||
| Version: | 6.2 | CC: | acathrow, dallan, dyuan, eblake, mzhan, rwu, vbian, whuang, yupzhang |
| Target Milestone: | rc | ||
| Target Release: | --- | ||
| Hardware: | Unspecified | ||
| OS: | Linux | ||
| Whiteboard: | |||
| Fixed In Version: | libvirt-0.9.4-12.el6 | Doc Type: | Bug Fix |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2011-12-06 11:29:22 UTC | Type: | --- |
| Regression: | --- | Mount Type: | --- |
| Documentation: | --- | CRM: | |
| Verified Versions: | Category: | --- | |
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |
| Cloudforms Team: | --- | Target Upstream Version: | |
| Embargoed: | |||
| Bug Depends On: | 638510 | ||
| Bug Blocks: | 740168, 743047 | ||
(In reply to comment #0) > Description of problem: > That's doc issue, snapshot-create-as should be followed by --diskspec to > introduce the arguments, rather than follow <diskspec> directly. Not quite true. The '--diskspec' option is mandatory if you do not have all three of domain, name, and description already provided, but if all three are present, then you can skip the option name for diskspec as well. $ tools/virsh -c test:///default snapshot-create-as --print-xml test name desc vda <domainsnapshot> <name>name</name> <description>desc</description> <disks> <disk name='vda'/> </disks> </domainsnapshot> > > OPTIONS > [--domain] <string> domain name, id or uuid > [--name] <string> name of snapshot > [--description] <string> description of snapshot > --print-xml print XML document rather than create > --no-metadata take snapshot but create no metadata > --halt halt domain after snapshot is created > --disk-only capture disk state but not vm state > <diskspec> disk attributes: However, I agree that this is a bit confusing, and might look better as [--diskspec] <diskspec> in the 'virsh help' output, and as '[[/--diskspec/] *diskspec*]...' (with // for italic and ** for bold) in the 'man virsh' section. I'll reply more to your proposed upstream patch with my counter proposals: https://www.redhat.com/archives/libvir-list/2011-September/msg00543.html tested with
libvirt-0.9.4-12.el6.x86_64
Steps:
# virsh help snapshot-create-as
SYNOPSIS
snapshot-create-as <domain> [<name>] [<description>] [--print-xml]
[--no-metadata] [--halt] [--disk-only] [--diskspec]...
OPTIONS
--diskspec <string> disk attributes:
disk[,snapshot=type][,driver=type][,file=name]
Get expected result, so set bug status to VERIFIED
however, this patch broke virsh qemu-monitor-command and virsh send-key; see bug 740168 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. http://rhn.redhat.com/errata/RHBA-2011-1513.html |
Description of problem: That's doc issue, snapshot-create-as should be followed by --diskspec to introduce the arguments, rather than follow <diskspec> directly. Version-Release number of selected component (if applicable): libvirt-0.9.4-11.el6.x86_64 How reproducible: always Steps to Reproduce: # virsh help snapshot-create-as NAME snapshot-create-as - Create a snapshot from a set of args SYNOPSIS snapshot-create-as <domain> [<name>] [<description>] [--print-xml] [--no-metadata] [--halt] [--disk-only] [<diskspec>]... DESCRIPTION Create a snapshot (disk and RAM) from arguments OPTIONS [--domain] <string> domain name, id or uuid [--name] <string> name of snapshot [--description] <string> description of snapshot --print-xml print XML document rather than create --no-metadata take snapshot but create no metadata --halt halt domain after snapshot is created --disk-only capture disk state but not vm state <diskspec> disk attributes: disk[,snapshot=type][,driver=type][,file=name] Actual results: SYNOPSIS snapshot-create-as <domain> [<name>] [<description>] [--print-xml] [--no-metadata] [--halt] [--disk-only] [<diskspec>]... OPTIONS <diskspec> disk attributes: disk[,snapshot=type][,driver=type][,file=name] Expected results: SYNOPSIS snapshot-create-as <domain> [<name>] [<description>] [--print-xml] [--no-metadata] [--halt] [--disk-only] [--diskspec]... OPTIONS --diskspec <string> disk attributes: disk[,snapshot=type][,driver=type][,file=name] Additional info: