docs: Document the new <slices> sub-element of disk's <source>

We are going to add support for specifying offset and size attributes
which will allow controling where the image and where the guest data
itself starts in the source of the disk. This will be represented by
a <slices> element filled with either a <slice type='storage'> for the
offset of the image format data.

Add the XML documentation and RNG schema.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
This commit is contained in:
Peter Krempa 2020-02-05 18:00:23 +01:00
parent 8c43037688
commit 44f0f76890
2 changed files with 32 additions and 0 deletions

View File

@ -2878,6 +2878,9 @@
&lt;disk type='block' device='lun'&gt;
&lt;driver name='qemu' type='raw'/&gt;
&lt;source dev='/dev/sda'&gt;
&lt;slices&gt;
&lt;slice type='storage' offset='12345' size='123'/&gt;
&lt;/slices&gt;
&lt;reservations managed='no'&gt;
&lt;source type='unix' path='/path/to/qemu-pr-helper' mode='client'/&gt;
&lt;/reservations&gt;
@ -3360,6 +3363,16 @@
controller.
<span class="since">Since 6.0.0</span>
</dd>
<dt><code>slices</code></dt>
<dd>The <code>slices</code> element using its <code>slice</code>
sub-elements allows configuring offset and size of either the
location of the image format (<code>slice type='storage'</code>)
inside the storage source or the guest data inside the image format
container (future expansion).
The <code>offset</code> and <code>size</code> values are in bytes.
<span class="since">Since 6.1.0</span>
</dd>
</dl>
<p>

View File

@ -1596,12 +1596,31 @@
</optional>
</define>
<define name="diskSourceSlice">
<attribute name='offset'>
<ref name="positiveInteger"/>
</attribute>
<attribute name='size'>
<ref name="positiveInteger"/>
</attribute>
</define>
<define name="diskSourceCommon">
<optional>
<attribute name="index">
<ref name="positiveInteger"/>
</attribute>
</optional>
<optional>
<element name='slices'>
<element name='slice'>
<attribute name='type'>
<value>storage</value>
</attribute>
<ref name="diskSourceSlice"/>
</element>
</element>
</optional>
</define>
<define name="diskSource">