[libvirt] [RFC PATCH] doc: add sample XML for disk

Wen Congyang wency at cn.fujitsu.com
Thu Jul 14 09:00:39 UTC 2011

At 07/07/2011 05:33 PM, Daniel P. Berrange Write:
> On Thu, Jul 07, 2011 at 01:06:01PM +0800, Wen Congyang wrote:
>> When I edit the xml config file, I need to know the format.
>> The easiest way to know the format is a sample XML.
>> But we do not have such sample now.
>> TODO:
>> 1. dir and network disk's sample
>> 2. nic's sample
>> If we need such document, I will continue doing it.
> I agree it would be useful to have man pages documenting the
> XML format. I wonder if we can somehow have one set of content,
> and from that generate both the docs/formatdomain.html and
> a docs/virt-xml-domain.pod file ?

I read docs/formatdomain.html.in, and think it is not easy to
do it. formatdomain.html.in contains more information than pod file
and some restriction does not written into html file(for example
ide disk can not be set to readonly.)

Most information in formatdoamin.html is not included in pod file,
So I think there is no need to do it.

> Likewise for the other XML schemas.
> Regards,
> Daniel

More information about the libvir-list mailing list