Bug 1080859

Summary: [Snapshot Doc] In snapshot-create-as manual page, supported snapshot type should be no, internal and external
Product: Red Hat Enterprise Linux 7 Reporter: Yang Yang <yanyang>
Component: libvirtAssignee: Peter Krempa <pkrempa>
Status: CLOSED ERRATA QA Contact: Virtualization Bugs <virt-bugs>
Severity: low Docs Contact:
Priority: low    
Version: 7.0CC: dyuan, jdenemar, mzhan, pkrempa, shyu
Target Milestone: rc   
Target Release: ---   
Hardware: x86_64   
OS: Linux   
Whiteboard:
Fixed In Version: libvirt-1.2.7-1.el7 Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2015-03-05 07:33:16 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 Yang Yang 2014-03-26 09:03:11 UTC
Description of problem:
In snapshot-create-as manual page, we can see that snapshot type can be none, internal and external. But actually, not 'none' but 'no' is supported.


Version-Release number of selected component (if applicable):
libvirt-1.1.1-28.el7.x86_64

How reproducible:
Always

Steps to Reproduce:
1.# man virsh
As snapshot-create-as manual page shows:
...........
The --memspec option can be used to control whether a checkpoint is
           internal or external.  The --memspec flag is mandatory, followed by
           a memspec of the form [file=]name[,snapshot=type], where type can
           be none, internal, or external.  To include a literal comma in
           file=name, escape it with a second comma. --memspec cannot be used
           together with --disk-only.
...........
2. # virsh snapshot-create-as qcow3-2 snap3 --memspec snapshot=none
error: XML error: unknown memory snapshot setting 'none'

3. # virsh snapshot-create-as qcow3-2 snap4 --memspec snapshot=no
Domain snapshot snap4 created


Actual results:

Snapshot was not able to be created while setting snapshot to none, but it worked while setting snapshot to 'no'.

Expected results:

Supported snapshot type should be no, internal and external. So the manual page should be updated to as following:
In snapshot-create-as manual page:
...........
The --memspec option can be used to control whether a checkpoint is
           internal or external.  The --memspec flag is mandatory, followed by
           a memspec of the form [file=]name[,snapshot=type], where type can
           be no, internal, or external.  To include a literal comma in
           file=name, escape it with a second comma. --memspec cannot be used
           together with --disk-only.
...........

Additional info:

Comment 2 Peter Krempa 2014-03-31 12:11:42 UTC
Fixed upstream:

commit bfd2f54cf203bb3854b26fc3ec019f352c994c17
Author: Shanzhi Yu <shyu>
Date:   Fri Mar 28 19:38:03 2014 +0800

    virsh: man: Fix spelling of parameters for --memspec in snapshot-create-as
    
    https://bugzilla.redhat.com/show_bug.cgi?id=1080859
    
    Snapshot type should be no, internal, or external.

Comment 4 Yang Yang 2014-09-22 10:15:59 UTC
Verified on libvirt-1.2.8-3.el7.x86_64

#man virsh
snapshot-create-as
..........
The --memspec option can be used to control whether a checkpoint is
           internal or external.  The --memspec flag is mandatory, followed by
           a memspec of the form [file=]name[,snapshot=type], where type can
           be no, internal, or external.  To include a literal comma in
           file=name, escape it with a second comma. --memspec cannot be used
           together with --disk-only.
..........

The snapshot type is changed to no, internal and external.

Comment 6 errata-xmlrpc 2015-03-05 07:33:16 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://rhn.redhat.com/errata/RHSA-2015-0323.html