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

docs: Convert 'format' 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:53 +01:00
parent 51213f4d29
commit 63b12805f2
3 changed files with 36 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
docs/format.html.in
View File

@ -1,48 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<body>
<h1>XML Format</h1>
<p>
Objects in the libvirt API are configured using XML documents to allow
for ease of extension in future releases. Each XML document has an
associated Relax-NG schema that can be used to validate documents
prior to usage.
</p>
<ul>
<li><a href="formatdomain.html">Domains</a></li>
<li><a href="formatnetwork.html">Networks</a></li>
<li><a href="formatnwfilter.html">Network filtering</a></li>
<li><a href="formatnetworkport.html">Network ports</a></li>
<li><a href="formatstorage.html">Storage</a></li>
<li><a href="formatstorageencryption.html">Storage encryption</a></li>
<li><a href="formatcaps.html">Capabilities</a></li>
<li><a href="formatdomaincaps.html">Domain capabilities</a></li>
<li><a href="formatstoragecaps.html">Storage Pool capabilities</a></li>
<li><a href="formatnode.html">Node devices</a></li>
<li><a href="formatsecret.html">Secrets</a></li>
<li><a href="formatsnapshot.html">Snapshots</a></li>
<li><a href="formatcheckpoint.html">Checkpoints</a></li>
<li><a href="formatbackup.html">Backup jobs</a></li>
</ul>
<h2>Command line validation</h2>
<p>
The <code>virt-xml-validate</code> tool provides a simple command line
for validating XML documents prior to giving them to libvirt. It uses
the locally installed RNG schema documents. It will auto-detect which
schema to use for validation based on the name of the top level element
in the input document. Thus it merely requires the XML document filename
to be passed on the command line
</p>
<pre>
$ virt-xml-validate /path/to/XML/file</pre>
</body>
</html>

35
docs/format.rst Normal file
View File

@ -0,0 +1,35 @@
==========
XML Format
==========
Objects in the libvirt API are configured using XML documents to allow for ease
of extension in future releases. Each XML document has an associated Relax-NG
schema that can be used to validate documents prior to usage.
- `Domains <formatdomain.html>`__
- `Networks <formatnetwork.html>`__
- `Network filtering <formatnwfilter.html>`__
- `Network ports <formatnetworkport.html>`__
- `Storage <formatstorage.html>`__
- `Storage encryption <formatstorageencryption.html>`__
- `Capabilities <formatcaps.html>`__
- `Domain capabilities <formatdomaincaps.html>`__
- `Storage Pool capabilities <formatstoragecaps.html>`__
- `Node devices <formatnode.html>`__
- `Secrets <formatsecret.html>`__
- `Snapshots <formatsnapshot.html>`__
- `Checkpoints <formatcheckpoint.html>`__
- `Backup jobs <formatbackup.html>`__
Command line validation
-----------------------
The ``virt-xml-validate`` tool provides a simple command line for validating XML
documents prior to giving them to libvirt. It uses the locally installed RNG
schema documents. It will auto-detect which schema to use for validation based
on the name of the top level element in the input document. Thus it merely
requires the XML document filename to be passed on the command line
::
$ virt-xml-validate /path/to/XML/file

2
docs/meson.build
View File

@ -22,7 +22,6 @@ docs_html_in_files = [
'csharp', 'csharp',
'dbus', 'dbus',
'docs', 'docs',
'format',
'formatcaps', 'formatcaps',
'formatdomaincaps', 'formatdomaincaps',
'formatnetwork', 'formatnetwork',
@ -82,6 +81,7 @@ docs_rst_files = [
'drvxen', 'drvxen',
'errors', 'errors',
'firewall', 'firewall',
'format',
'formatbackup', 'formatbackup',
'formatcheckpoint', 'formatcheckpoint',
'formatdomain', 'formatdomain',