External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-12-22 05:35:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Convert 'formatstoragecaps' page to rST

Browse Source 
Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Erik Skultety <eskultet@redhat.com>
This commit is contained in:
Peter Krempa 2022-03-10 17:57:54 +01:00
parent 9c54820eb5
commit 4e6d0da550
3 changed files with 80 additions and 96 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

95
docs/formatstoragecaps.html.in
View File

@ -1,95 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<body>
<h1>Storage Pool Capabilities XML format</h1>
<ul id="toc"></ul>
<h2><a id="Overview">Overview</a></h2>
<p>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. </p>
<h2><a id="elements">Element and attribute overview</a></h2>
<p>A query interface was added to the virConnect API's to retrieve the
XML listing of the set of Storage Pool Capabilities
(<span class="since">Since 5.2.0</span>):</p>
<pre>
<a href="/html/libvirt-libvirt-storage.html#virConnectGetStoragePoolCapabilities">virConnectGetStoragePoolCapabilities</a>
</pre>
<p>The root element that emulator capability XML document starts with is
named <code>storagepoolCapabilities</code>. There will be any number of
<code>pool</code> child elements with two attributes <code>type</code>
and <code>supported</code>. Each <code>pool</code> element may have
a <code>poolOptions</code> or <code>volOptions</code> subelements to
describe the available features. Sample XML output is:</p>
<pre>
&lt;storagepoolCapabilities&gt;
&lt;pool type='dir' supported='yes'&gt;
&lt;volOptions&gt;
&lt;defaultFormat type='raw'&lt;/&gt;
&lt;enum name='targetFormatType'&gt;
&lt;value&gt;none&lt;/value&gt;
&lt;value&gt;raw&lt;/value&gt;
...
&lt;/enum&gt;
&lt;/volOptions&gt;
&lt;/pool&gt;
&lt;pool type='fs' supported='yes'&gt;
&lt;poolOptions&gt;
&lt;defaultFormat type='auto'&lt;/&gt;
&lt;enum name='sourceFormatType'&gt;
&lt;value&gt;auto&lt;/value&gt;
&lt;value&gt;ext2&lt;/value&gt;
...
&lt;/enum&gt;
&lt;/poolOptions&gt;
&lt;volOptions&gt;
&lt;defaultFormat type='raw'&lt;/&gt;
&lt;enum name='targetFormatType'&gt;
&lt;value&gt;none&lt;/value&gt;
&lt;value&gt;raw&lt;/value&gt;
...
&lt;/enum&gt;
&lt;/volOptions&gt;
&lt;/pool&gt;
...
&lt;/storagepoolCapabilities&gt;
</pre>
<p>The following section describes subelements of the
<code>poolOptions</code> and <code>volOptions</code> subelements </p>:
<dl>
<dt><code>defaultFormat</code></dt>
<dd>For the <code>poolOptions</code>, the <code>type</code> attribute
describes the default format name used for the pool source. For the
<code>volOptions</code>, the <code>type</code> attribute describes
the default volume name used for each volume.
</dd>
<dl>
<dt><code>enum</code></dt>
<dd>Each enum uses a name from the list below with any number of
<code>value</code> value subelements describing the valid values.
<dl>
<dt><code>sourceFormatType</code></dt>
<dd>Lists all the possible <code>poolOptions</code> source
pool format types.
</dd>
<dt><code>targetFormatType</code></dt>
<dd>Lists all the possible <code>volOptions</code> target volume
format types.
</dd>
</dl>
</dd>
</dl>
</dl>
</body>
</html>

79
docs/formatstoragecaps.rst Normal file
View File

@ -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 <html/libvirt-libvirt-storage.html#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.

2
docs/meson.build
View File

@ -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',