External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-02-22 11:22:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: domain: Fix documentation of the 'snapshot' attribute for <disk>

Browse Source 
Emphasise the valid values by wrapping them in <code> and reword the
last sentence so that the invalid value example can be dropped.

Resolves: https://bugzilla.redhat.com/show_bug.cgi?id=1523070
This commit is contained in:
Peter Krempa 2017-12-07 14:16:10 +01:00
parent c416a20db1
commit 1e98d450f2
1 changed files with 9 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/formatdomain.html.in
View File

@ -2584,17 +2584,16 @@
<dt><code>snapshot</code></dt>
<dd>
Indicates the default behavior of the disk during disk snapshots:
"internal" requires a file format such as qcow2 that can store
both the snapshot and the data changes since the snapshot;
"external" will separate the snapshot from the live data; and
"no" means the disk will not participate in snapshots. Read-only
disks default to "no", while the default for other disks depends
on the hypervisor's capabilities. Some hypervisors allow a
per-snapshot choice as well, during
"<code>internal</code>" requires a file format such as qcow2 that
can store both the snapshot and the data changes since the snapshot;
"<code>external</code>" will separate the snapshot from the live
data; and "<code>no</code>" means the disk will not participate in
snapshots. Read-only disks default to "<code>no</code>", while the
default for other disks depends on the hypervisor's capabilities.
Some hypervisors allow a per-snapshot choice as well, during
<a href="formatsnapshot.html">domain snapshot creation</a>.
Not all snapshot modes are supported; for example,
<code>snapshot='yes'</code> with a transient disk generally
does not make sense.
Not all snapshot modes are supported; for example, enabling
snapshots with a transient disk generally does not make sense.
<span class="since">Since 0.9.5</span>
</dd>
</dl>