[libvirt] Interface XML description

[Laine Stump]

On 01/26/2011 02:45 AM, Zdenek Styblik wrote:
> On 01/25/2011 11:12 PM, arnaud.champion at devatom.fr wrote:
>> ?Hi,
>>
>> I'm currently working on C# binding, precisly on virInterface things. I don't see any XML documentation around interface XML description. IS there infos anywhere ?
>>
>> Regards,
>>
>> Arnaud
>>
>>
>>
>> --
>> libvir-list mailing list
>> libvir-list at redhat.com
>> https://www.redhat.com/mailman/listinfo/libvir-list
> Afaik no and there already is bugzilla ticket for that.

Yeah, when I wrote the virInterface functions, I didn't know where the 
documentation files lived, and Eric wasn't around then to poke at me 
about not writing any. Every couple of months someone asks about this, 
and I put it back on my list (and I think Justin tries to put it on hist 
list too, but there's always something "more important" (it doesn't help 
that I'm averse to dealing with html tags :-/ ) (note that I'm very 
carefully neglecting to commit to writing any new documentation in any 
timeframe, as I don't want to promise something I can't deliver.)

There is documentation in the Developer's Guide, but IIRC it just points 
to netcf for the XML, and netcf mostly just has examples (which are help 
in themselves, but by no means exhaustive). You can get some amount of 
info from grabbing the netcf sources (info at 
https://fedorahosted.org/netcf ) and looking at the examples in 
tests/interface, and the RNG description in data/xml/interface.rng (the 
same rng file is in libvirt, btw).

Note that the organization of the XML elements in netcf is a bit more 
complicated than in other libvirt XML, as the same element can appear at 
different levels (and different subelements are valid at those times) in 
order to accommodate bridges and bonds. Here's a graphic showing which 
elements can be nested within which other elements (again, there are 
examples of this in the tests/interface directory)