[libvirt] RFC version information in API docs

[Daniel Veillard]

On Mon, May 13, 2013 at 02:30:41PM +0200, Claudio Bley wrote:
> Hi.
> 
> Sometimes, it's a bit hard to determine when exactly a function, flag
> or macro appeared in libvirt, ie. whether it will be supported on my
> target machine having a specific version of libvirt or not.
> 
> So, I have created an enriched version of the API docs, using a XSL
> stylesheet enumerating the libvirt?-api.xml files of all libvirt
> releases.
> 
> For an example, you can have a look here:
> 
> http://avdv.github.io/libvirt/html/libvirt-libvirt.html#virVcpuState
> 
> Hovering over an enum value displays version information in a tooltip.
> 
> What do you think? Should this information be included by default in
> the API docs?

  Sounds a rather good idea to me, adding an extra attribute for each
entry should not break anything. But I don't understand why you would
need a libvirt-api-0.xml and libvirt-api-1.xml.

Daniel

-- 
Daniel Veillard      | Open Source and Standards, Red Hat
veillard at redhat.com  | libxml Gnome XML XSLT toolkit  http://xmlsoft.org/
http://veillard.com/ | virtualization library  http://libvirt.org/