Re: [libvirt] RFC version information in API docs
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?
The version an API appeared is not always that useful - since you
typically need to know what version a hypervisor driver supported
it in. Do you know about this page which shows the version matrix
for APIs + drivers:
http://libvirt.org/hvsupport.html
Daniel
--
|: http://berrange.com -o- http://www.flickr.com/photos/dberrange/ :|
|: http://libvirt.org -o- http://virt-manager.org :|
|: http://autobuild.org -o- http://search.cpan.org/~danberr/ :|
|: http://entangle-photo.org -o- http://live.gnome.org/gtk-vnc :|