[PATCH 2/4] docs: formatsnapshot: Move paragraphs describing 'disk' element together

Peter Krempa posted 4 patches 3 years, 11 months ago
[PATCH 2/4] docs: formatsnapshot: Move paragraphs describing 'disk' element together
Posted by Peter Krempa 3 years, 11 months ago
There was another paragraph describing the attribute 'type' of the
'disk' element under the description of the subelements. Move it to the
top to get all relevant information in one place.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
---
 docs/formatsnapshot.rst | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

diff --git a/docs/formatsnapshot.rst b/docs/formatsnapshot.rst
index 0ad397316c..b0d8d7ea2f 100644
--- a/docs/formatsnapshot.rst
+++ b/docs/formatsnapshot.rst
@@ -124,6 +124,17 @@ The top-level ``domainsnapshot`` element may contain the following elements:
       corresponding domain disk, while others like qemu allow this field to
       override the domain default.

+      :since:`Since 1.2.2` the ``disk`` element supports an optional attribute
+      ``type`` if the ``snapshot`` attribute is set to ``external``. This
+      attribute specifies the snapshot target storage type and allows to
+      overwrite the default ``file`` type. The ``type`` attribute along with
+      the format of the ``source`` sub-element is identical to the ``source``
+      element used in domain disk definitions. See the `disk devices
+      <formatdomain.html#elementsDisks>`__ section documentation for further
+      information. Libvirt currently supports the ``type`` element in the qemu
+      driver and supported values are ``file``, ``block`` and ``network`` with
+      a protocol of ``gluster`` :since:`(since 1.2.2)` .
+
       ``source``

          If the snapshot mode is external (whether specified or inherited),
@@ -151,17 +162,6 @@ The top-level ``domainsnapshot`` element may contain the following elements:

    ``seclabel``

-      :since:`Since 1.2.2` the ``disk`` element supports an optional attribute
-      ``type`` if the ``snapshot`` attribute is set to ``external``. This
-      attribute specifies the snapshot target storage type and allows to
-      overwrite the default ``file`` type. The ``type`` attribute along with
-      the format of the ``source`` sub-element is identical to the ``source``
-      element used in domain disk definitions. See the `disk devices
-      <formatdomain.html#elementsDisks>`__ section documentation for further
-      information. Libvirt currently supports the ``type`` element in the qemu
-      driver and supported values are ``file``, ``block`` and ``network`` with
-      a protocol of ``gluster`` :since:`(since 1.2.2)` .
-
 ``creationTime``

    A readonly representation of the time this snapshot was created. The time is
-- 
2.35.1
Re: [PATCH 2/4] docs: formatsnapshot: Move paragraphs describing 'disk' element together
Posted by Michal Prívozník 3 years, 11 months ago
On 3/9/22 10:09, Peter Krempa wrote:
> There was another paragraph describing the attribute 'type' of the
> 'disk' element under the description of the subelements. Move it to the
> top to get all relevant information in one place.
> 
> Signed-off-by: Peter Krempa <pkrempa@redhat.com>
> ---
>  docs/formatsnapshot.rst | 22 +++++++++++-----------
>  1 file changed, 11 insertions(+), 11 deletions(-)
> 
> diff --git a/docs/formatsnapshot.rst b/docs/formatsnapshot.rst
> index 0ad397316c..b0d8d7ea2f 100644
> --- a/docs/formatsnapshot.rst
> +++ b/docs/formatsnapshot.rst
> @@ -124,6 +124,17 @@ The top-level ``domainsnapshot`` element may contain the following elements:
>        corresponding domain disk, while others like qemu allow this field to
>        override the domain default.
> 
> +      :since:`Since 1.2.2` the ``disk`` element supports an optional attribute
> +      ``type`` if the ``snapshot`` attribute is set to ``external``. This
> +      attribute specifies the snapshot target storage type and allows to
> +      overwrite the default ``file`` type. The ``type`` attribute along with
> +      the format of the ``source`` sub-element is identical to the ``source``
> +      element used in domain disk definitions. See the `disk devices
> +      <formatdomain.html#elementsDisks>`__ section documentation for further
> +      information. Libvirt currently supports the ``type`` element in the qemu
> +      driver and supported values are ``file``, ``block`` and ``network`` with
> +      a protocol of ``gluster`` :since:`(since 1.2.2)` .
> +
>        ``source``
> 
>           If the snapshot mode is external (whether specified or inherited),
> @@ -151,17 +162,6 @@ The top-level ``domainsnapshot`` element may contain the following elements:
> 
>     ``seclabel``
> 
> -      :since:`Since 1.2.2` the ``disk`` element supports an optional attribute
> -      ``type`` if the ``snapshot`` attribute is set to ``external``. This
> -      attribute specifies the snapshot target storage type and allows to
> -      overwrite the default ``file`` type. The ``type`` attribute along with
> -      the format of the ``source`` sub-element is identical to the ``source``
> -      element used in domain disk definitions. See the `disk devices
> -      <formatdomain.html#elementsDisks>`__ section documentation for further
> -      information. Libvirt currently supports the ``type`` element in the qemu
> -      driver and supported values are ``file``, ``block`` and ``network`` with
> -      a protocol of ``gluster`` :since:`(since 1.2.2)` .
> -
>  ``creationTime``
> 
>     A readonly representation of the time this snapshot was created. The time is


This doesn't look right because it leaves ``seclabel'' hanging in the
air with no content.

Michal