* docs/Goals: added a Goals document for the library

Daniel
This commit is contained in:
Daniel Veillard 2005-11-09 09:57:48 +00:00
parent 8af506b89f
commit 5cc4af3e7d
2 changed files with 33 additions and 0 deletions

View File

@ -1,3 +1,7 @@
Wed Nov 9 10:57:12 CET 2005 Daniel Veillard <veillard@redhat.com>
* docs/Goals: added a Goals document for the library
Mon Nov 7 18:14:50 CET 2005 Daniel Veillard <veillard@redhat.com> Mon Nov 7 18:14:50 CET 2005 Daniel Veillard <veillard@redhat.com>
* TODO: updated * TODO: updated

29
docs/Goals Normal file
View File

@ -0,0 +1,29 @@
Why libxen:
-----------
The main goals of the library is to provide an stable API abstracting
the underlying acual implementation of the hypervisor calls.
1/ Stable API:
by isolating the data structures and entry points used at the low
level Xen Hypervisor interfaces, allowing evolution of said interface
over time without breaking the application visible API and ABI
2/ Abstraction:
by providing at the C level simplified concept exposed only as opaque
structure for the hypervisor connection, domains and other kind of
objects which may be needed in the future. It must also provide
a set of higher level function calls simplifying the developement
of applications using the supervisor.
3/ Maintainability and openness:
All data structures and entry points must be fully documented, all
changes will be driven in an open fashion based on a publicly archived
mailing-list allowing peer-review before changes will be introduced.
Tools and regression tests will be implemented and shipped as part of the
releases of the library.
Daniel Veillard <veillard@redhat.com>
$Date$