From 5cc4af3e7d664b4c359953df3c7dcb06588adc1e Mon Sep 17 00:00:00 2001 From: Daniel Veillard Date: Wed, 9 Nov 2005 09:57:48 +0000 Subject: [PATCH] * docs/Goals: added a Goals document for the library Daniel --- ChangeLog | 4 ++++ docs/Goals | 29 +++++++++++++++++++++++++++++ 2 files changed, 33 insertions(+) create mode 100644 docs/Goals diff --git a/ChangeLog b/ChangeLog index 53cbf47193..2f02aefa42 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +Wed Nov 9 10:57:12 CET 2005 Daniel Veillard + + * docs/Goals: added a Goals document for the library + Mon Nov 7 18:14:50 CET 2005 Daniel Veillard * TODO: updated diff --git a/docs/Goals b/docs/Goals new file mode 100644 index 0000000000..fbe2a5ee9a --- /dev/null +++ b/docs/Goals @@ -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 +$Date$ -- GitLab