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>

diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index d29c20e6ed9965da7477ac81226124d690f1eb1e..f4af65f13ff03e27726f4c064d720ffd0b342b0a 100644 (file)
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -2878,6 +2878,9 @@
   <disk type='block' device='lun'>
     <driver name='qemu' type='raw'/>
     <source dev='/dev/sda'>
+      <slices>
+        <slice type='storage' offset='12345' size='123'/>
+      </slices>
       <reservations managed='no'>
         <source type='unix' path='/path/to/qemu-pr-helper' mode='client'/>
       </reservations>
@@ -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>

diff --git a/docs/schemas/domaincommon.rng b/docs/schemas/domaincommon.rng
index 29b6b953573fa24aa4daec44d972b060b857b43b..4be751461df9ed6f65f3d6ef2bbf5a0aeeb3f9ac 100644 (file)
--- a/docs/schemas/domaincommon.rng
+++ b/docs/schemas/domaincommon.rng
@@ -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">