Signed-off-by: Peter Krempa <pkrempa@xxxxxxxxxx> --- docs/format.html.in | 48 --------------------------------------------- docs/format.rst | 35 +++++++++++++++++++++++++++++++++ docs/meson.build | 2 +- 3 files changed, 36 insertions(+), 49 deletions(-) delete mode 100644 docs/format.html.in create mode 100644 docs/format.rst diff --git a/docs/format.html.in b/docs/format.html.in deleted file mode 100644 index 1d2456de6f..0000000000 --- a/docs/format.html.in +++ /dev/null @@ -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> diff --git a/docs/format.rst b/docs/format.rst new file mode 100644 index 0000000000..a261007e73 --- /dev/null +++ b/docs/format.rst @@ -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 diff --git a/docs/meson.build b/docs/meson.build index aa8bad89f0..acc455c7c7 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -22,7 +22,6 @@ docs_html_in_files = [ 'csharp', 'dbus', 'docs', - 'format', 'formatcaps', 'formatdomaincaps', 'formatnetwork', @@ -82,6 +81,7 @@ docs_rst_files = [ 'drvxen', 'errors', 'firewall', + 'format', 'formatbackup', 'formatcheckpoint', 'formatdomain', -- 2.35.1
