From 63b12805f29ae57fa1f5a29571774023600ae54c Mon Sep 17 00:00:00 2001 From: Peter Krempa Date: Thu, 10 Mar 2022 17:57:53 +0100 Subject: [PATCH] docs: Convert 'format' page to rST Signed-off-by: Peter Krempa Reviewed-by: Erik Skultety --- 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 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. -

- - - - -

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/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 `__ +- `Networks `__ +- `Network filtering `__ +- `Network ports `__ +- `Storage `__ +- `Storage encryption `__ +- `Capabilities `__ +- `Domain capabilities `__ +- `Storage Pool capabilities `__ +- `Node devices `__ +- `Secrets `__ +- `Snapshots `__ +- `Checkpoints `__ +- `Backup jobs `__ + +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',