From 4e6d0da550ec6a5e830b75603f17e6b9e3f4bb3a Mon Sep 17 00:00:00 2001 From: Peter Krempa Date: Thu, 10 Mar 2022 17:57:54 +0100 Subject: [PATCH] docs: Convert 'formatstoragecaps' page to rST Signed-off-by: Peter Krempa Reviewed-by: Erik Skultety --- docs/formatstoragecaps.html.in | 95 ---------------------------------- docs/formatstoragecaps.rst | 79 ++++++++++++++++++++++++++++ docs/meson.build | 2 +- 3 files changed, 80 insertions(+), 96 deletions(-) delete mode 100644 docs/formatstoragecaps.html.in create mode 100644 docs/formatstoragecaps.rst diff --git a/docs/formatstoragecaps.html.in b/docs/formatstoragecaps.html.in deleted file mode 100644 index a9ecc371fa..0000000000 --- a/docs/formatstoragecaps.html.in +++ /dev/null @@ -1,95 +0,0 @@ - - - - -

Storage Pool Capabilities XML format

- -
    - -

    Overview

    - -

    The Storage Pool Capabilities XML will provide the information - to determine what types of Storage Pools exist, whether the pool is - supported, and if relevant the source format types, the required - source elements, and the target volume format types.

    - -

    Element and attribute overview

    - -

    A query interface was added to the virConnect API's to retrieve the - XML listing of the set of Storage Pool Capabilities - (Since 5.2.0):

    - -
    -virConnectGetStoragePoolCapabilities
-
    - -

    The root element that emulator capability XML document starts with is - named storagepoolCapabilities. There will be any number of - pool child elements with two attributes type - and supported. Each pool element may have - a poolOptions or volOptions subelements to - describe the available features. Sample XML output is:

    - -
    -<storagepoolCapabilities>
-  <pool type='dir' supported='yes'>
-    <volOptions>
-      <defaultFormat type='raw'</>
-      <enum name='targetFormatType'>
-        <value>none</value>
-        <value>raw</value>
-        ...
-      </enum>
-    </volOptions>
-  </pool>
-  <pool type='fs' supported='yes'>
-    <poolOptions>
-      <defaultFormat type='auto'</>
-      <enum name='sourceFormatType'>
-        <value>auto</value>
-        <value>ext2</value>
-        ...
-      </enum>
-    </poolOptions>
-    <volOptions>
-      <defaultFormat type='raw'</>
-      <enum name='targetFormatType'>
-        <value>none</value>
-        <value>raw</value>
-        ...
-      </enum>
-    </volOptions>
-  </pool>
-  ...
-</storagepoolCapabilities>
-
    - -

    The following section describes subelements of the - poolOptions and volOptions subelements

    : - -
    -
    defaultFormat
    -
    For the poolOptions, the type attribute - describes the default format name used for the pool source. For the - volOptions, the type attribute describes - the default volume name used for each volume. -
    -
    -
    enum
    -
    Each enum uses a name from the list below with any number of - value value subelements describing the valid values. -
    -
    sourceFormatType
    -
    Lists all the possible poolOptions source - pool format types. -
    -
    targetFormatType
    -
    Lists all the possible volOptions target volume - format types. -
    -
    -
    -
    -
    - - diff --git a/docs/formatstoragecaps.rst b/docs/formatstoragecaps.rst new file mode 100644 index 0000000000..45c2c1c995 --- /dev/null +++ b/docs/formatstoragecaps.rst @@ -0,0 +1,79 @@ +.. role:: since + +==================================== +Storage Pool Capabilities XML format +==================================== + +.. contents:: + +Overview +-------- + +The Storage Pool Capabilities XML will provide the information to determine what +types of Storage Pools exist, whether the pool is supported, and if relevant the +source format types, the required source elements, and the target volume format +types. + +Element and attribute overview +------------------------------ + +A query interface was added to the virConnect API's to retrieve the XML listing +of the set of Storage Pool Capabilities ( :since:`Since 5.2.0` ): + + ``virConnectGetStoragePoolCapabilities`` (`API docs `__) + +The root element that emulator capability XML document starts with is named +``storagepoolCapabilities``. There will be any number of ``pool`` child elements +with two attributes ``type`` and ``supported``. Each ``pool`` element may have a +``poolOptions`` or ``volOptions`` subelements to describe the available +features. Sample XML output is: + +:: + + + + + + + none + raw + ... + + + + + + + + auto + ext2 + ... + + + + + + none + raw + ... + + + + ... + + +The following section describes subelements of the ``poolOptions`` and +``volOptions`` subelements + +``defaultFormat`` + For the ``poolOptions``, the ``type`` attribute describes the default format + name used for the pool source. For the ``volOptions``, the ``type`` attribute + describes the default volume name used for each volume. +``enum`` + Each enum uses a name from the list below with any number of ``value`` value + subelements describing the valid values. + + ``sourceFormatType`` + Lists all the possible ``poolOptions`` source pool format types. + ``targetFormatType`` + Lists all the possible ``volOptions`` target volume format types. diff --git a/docs/meson.build b/docs/meson.build index 9df49747a5..417915a2cb 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -24,7 +24,6 @@ docs_html_in_files = [ 'formatnetwork', 'formatnode', 'formatnwfilter', - 'formatstoragecaps', 'index', 'internals', 'remote', @@ -81,6 +80,7 @@ docs_rst_files = [ 'formatsnapshot', 'formatstorage', 'formatstorageencryption', + 'formatstoragecaps', 'glib-adoption', 'goals', 'governance',