From 9153cb155e9197520737ef63dc804aae294c2390 Mon Sep 17 00:00:00 2001 From: "Daniel P. Berrange" Date: Tue, 8 Nov 2016 11:35:20 +0000 Subject: [PATCH] docs: add some content to the XML format main page The XML format main page has never had any content in it, relying on the left navbar to provide links to the XML schema pages. Since the navbar is gone, the page needs to have some content created, otherwise it is useless. Signed-off-by: Daniel P. Berrange --- docs/format.html.in | 36 +++++++++++++++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/docs/format.html.in b/docs/format.html.in index 9cb8eee18a..56ec76f438 100644 --- a/docs/format.html.in +++ b/docs/format.html.in @@ -2,9 +2,43 @@ -

XML Format

+

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 instaled 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