diff --git a/ChangeLog b/ChangeLog index 6191a31afe..78b5e68d98 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +Wed Dec 7 11:58:20 CET 2005 Daniel Veillard + + * docs/* docs/html/*: more work on the docs generation + * include/libvir.h: adding informations on the header + Wed Dec 7 10:31:29 CET 2005 Daniel Veillard * configure.in docs/FAQ.html docs/Libxml2-Logo-90x34.gif diff --git a/docs/APIchunk0.html b/docs/APIchunk0.html new file mode 100644 index 0000000000..fbeeb160ff --- /dev/null +++ b/docs/APIchunk0.html @@ -0,0 +1,216 @@ + + +API Alphabetic Index A-m for libvir
Red Hat Logo

Libvir the Linux virtualization API

API Alphabetic Index A-m for libvir

Developer Menu
API Indexes
Related links

A-m +n-x +

Letter A:

ABI
_virDomainInfo
+
APIs
virConnectOpenReadOnly
+

Letter C:

CPU
virDomainSuspend
+
Collect
virConnectListDomains
+

Letter D:

Destroy
virDomainDestroy
+
Domain0
virDomainGetMaxMemory
+virDomainSetMaxMemory
+
Dynamically
virDomainSetMaxMemory
+

Letter E:

Extract
virDomainGetInfo
+

Letter G:

Get
virConnectGetVersion
+virDomainGetID
+virDomainGetName
+

Letter H:

Hypervisor
virConnectClose
+virConnectGetVersion
+virConnectOpen
+

Letter I:

IDs
virConnectListDomains
+
Informations
_virDomainInfo
+

Letter K:

KBytes
_virDomainInfo
+

Letter L:

Launch
virDomainCreateLinux
+
Linux
virDomainCreateLinux
+

Letter N:

NULL
virConnectOpen
+virConnectOpenReadOnly
+virDomainCreateLinux
+virDomainGetInfo
+virDomainGetMaxMemory
+virDomainGetName
+virDomainLookupByID
+virDomainLookupByName
+virDomainSetMaxMemory
+
Note
virDomainGetInfo
+

Letter R:

Resume
virDomainResume
+
Retrieve
virDomainGetMaxMemory
+

Letter S:

Suspends
virDomainSuspend
+

Letter T:

TODO:
_virDomainInfo
+
This
virConnectClose
+virConnectOpen
+virConnectOpenReadOnly
+
Try
virDomainLookupByID
+virDomainLookupByName
+

Letter U:

Use
virDomainSuspend
+

Letter a:

about
virDomainGetInfo
+
access
_virDomainInfo
+virDomainSuspend
+
active
virConnectListDomains
+virDomainSuspend
+
add
_virDomainInfo
+
all
virDomainDestroy
+
allocated
virDomainGetInfo
+virDomainGetMaxMemory
+virDomainSetMaxMemory
+virDomainSuspend
+
allowed
_virDomainInfo
+
already
virDomainDestroy
+
amount
virDomainGetMaxMemory
+virDomainSetMaxMemory
+
application
virConnectClose
+virDomainGetMaxMemory
+virDomainSetMaxMemory
+
are
_virDomainInfo
+virConnectClose
+virConnectOpenReadOnly
+virDomainDestroy
+
argument
virConnectOpen
+virConnectOpenReadOnly
+
array
virConnectListDomains
+
available
_virDomainInfo
+

Letter b:

back
virDomainDestroy
+
based
virDomainLookupByID
+
below
_virDomainInfo
+
but
virDomainSuspend
+

Letter c:

call
_virDomainInfo
+
called
virConnectClose
+virConnectOpen
+virConnectOpenReadOnly
+
calling
virDomainResume
+
can
_virDomainInfo
+virDomainGetInfo
+
case
virConnectClose
+virConnectGetVersion
+virConnectListDomains
+virConnectOpen
+virConnectOpenReadOnly
+virDomainCreateLinux
+virDomainDestroy
+virDomainGetID
+virDomainGetInfo
+virDomainGetMaxMemory
+virDomainLookupByID
+virDomainLookupByName
+virDomainResume
+virDomainSetMaxMemory
+virDomainSuspend
+
change
virDomainSetMaxMemory
+
check
_virDomainInfo
+
clients
_virDomainInfo
+
closes
virConnectClose
+
collect
virConnectListDomains
+
command
virDomainCreateLinux
+
connection
_virDomainInfo
+virConnectClose
+virConnectGetVersion
+virConnectListDomains
+virConnectOpen
+virConnectOpenReadOnly
+virDomainCreateLinux
+virDomainGetInfo
+virDomainLookupByID
+virDomainLookupByName
+
currently
virConnectOpen
+virConnectOpenReadOnly
+

Letter d:

deallocated
virDomainGetName
+
domains
virConnectListDomains
+
down
virDomainDestroy
+

Letter e:

error
virConnectClose
+virConnectGetVersion
+virConnectListDomains
+virConnectOpen
+virConnectOpenReadOnly
+virDomainGetID
+virDomainGetMaxMemory
+
especially
virConnectClose
+
extracted
_virDomainInfo
+virDomainGetInfo
+

Letter f:

failure
virDomainCreateLinux
+virDomainDestroy
+virDomainGetInfo
+virDomainLookupByID
+virDomainLookupByName
+virDomainResume
+virDomainSetMaxMemory
+virDomainSuspend
+
file
virDomainCreateLinux
+
find
virDomainLookupByID
+
first
virConnectOpen
+virConnectOpenReadOnly
+
for
_virDomainInfo
+virDomainCreateLinux
+virDomainGetID
+virDomainGetName
+virDomainLookupByName
+
found
virConnectListDomains
+
from
_virDomainInfo
+virDomainResume
+
frozen
virDomainResume
+virDomainSuspend
+
full
_virDomainInfo
+
function
virConnectClose
+virConnectOpen
+virConnectOpenReadOnly
+
further
virConnectClose
+virDomainSuspend
+

Letter g:

get
virConnectOpen
+virConnectOpenReadOnly
+virDomainGetInfo
+virDomainGetMaxMemory
+
given
virDomainDestroy
+virDomainLookupByName
+
guest
virDomainCreateLinux
+

Letter h:

hypervisor
_virDomainInfo
+virConnectClose
+virConnectGetVersion
+virConnectListDomains
+virConnectOpen
+virConnectOpenReadOnly
+virDomainCreateLinux
+virDomainDestroy
+virDomainGetID
+virDomainLookupByID
+virDomainLookupByName
+virDomainSuspend
+

Letter i:

image
virDomainCreateLinux
+
information
virDomainGetInfo
+
informations
virDomainGetInfo
+
initrd
virDomainCreateLinux
+
instance
virDomainDestroy
+
int
virDomainGetID
+
interaction
virConnectClose
+
its
virDomainGetName
+

Letter k:

kernel
virDomainCreateLinux
+
kilobytes
virDomainCreateLinux
+virDomainGetMaxMemory
+virDomainSetMaxMemory
+

Letter l:

level
virConnectGetVersion
+virDomainSuspend
+
lifetime
virDomainGetName
+
limited
_virDomainInfo
+virDomainGetInfo
+
line
virDomainCreateLinux
+
list
virConnectListDomains
+
long
_virDomainInfo
+
lookup
virDomainLookupByName
+

Letter m:

major
virConnectGetVersion
+
maximum
_virDomainInfo
+virDomainGetMaxMemory
+virDomainSetMaxMemory
+
memory
_virDomainInfo
+virDomainCreateLinux
+virDomainGetMaxMemory
+virDomainSetMaxMemory
+virDomainSuspend
+
minor
virConnectGetVersion
+
monitoring
virConnectClose
+

A-m +n-x +

Daniel Veillard

diff --git a/docs/APIchunk1.html b/docs/APIchunk1.html new file mode 100644 index 0000000000..9c90119a02 --- /dev/null +++ b/docs/APIchunk1.html @@ -0,0 +1,153 @@ + + +API Alphabetic Index n-x for libvir
Red Hat Logo

Libvir the Linux virtualization API

API Alphabetic Index n-x for libvir

Developer Menu
API Indexes
Related links

A-m +n-x +

Letter n:

name
virDomainGetName
+virDomainLookupByName
+
need
virConnectClose
+virDomainGetName
+
needed
virConnectClose
+
new
virDomainCreateLinux
+virDomainLookupByID
+virDomainLookupByName
+
not
virConnectClose
+virDomainDestroy
+virDomainGetName
+
number
virConnectListDomains
+virDomainGetID
+virDomainLookupByID
+

Letter o:

object
virDomainCreateLinux
+virDomainDestroy
+virDomainGetID
+virDomainGetInfo
+virDomainGetMaxMemory
+virDomainGetName
+virDomainLookupByID
+virDomainLookupByName
+virDomainResume
+virDomainSetMaxMemory
+virDomainSuspend
+
one
_virDomainInfo
+
only
_virDomainInfo
+virDomainGetInfo
+
optional
virConnectOpen
+virConnectOpenReadOnly
+virDomainCreateLinux
+
otherwise
virConnectGetVersion
+

Letter p:

padding
_virDomainInfo
+
parameters
virDomainCreateLinux
+
partial
virDomainGetInfo
+
pass
virConnectOpen
+virConnectOpenReadOnly
+
path
virDomainCreateLinux
+
physical
virDomainGetMaxMemory
+virDomainSetMaxMemory
+
pointer
virConnectClose
+virConnectGetVersion
+virConnectListDomains
+virConnectOpen
+virConnectOpenReadOnly
+virDomainCreateLinux
+virDomainGetInfo
+virDomainGetName
+virDomainLookupByID
+virDomainLookupByName
+
private
_virDomainInfo
+
process
virDomainResume
+virDomainSuspend
+
protection
_virDomainInfo
+
public
virDomainGetName
+
publicly
_virDomainInfo
+

Letter r:

reactivate
virDomainSuspend
+
read-only
virConnectOpenReadOnly
+
reserved
virDomainGetMaxMemory
+virDomainSetMaxMemory
+
resources
virDomainDestroy
+virDomainSuspend
+
restarted
virDomainResume
+
restricted
virConnectOpenReadOnly
+
rev
virConnectGetVersion
+
running
_virDomainInfo
+virConnectClose
+virConnectGetVersion
+virDomainDestroy
+
runs
virDomainGetMaxMemory
+virDomainSetMaxMemory
+

Letter s:

same
virDomainGetName
+
set
virConnectOpenReadOnly
+virDomainCreateLinux
+virDomainGetInfo
+
should
virConnectClose
+virConnectOpen
+virConnectOpenReadOnly
+
shutdown
virDomainDestroy
+
size
virConnectListDomains
+virDomainCreateLinux
+virDomainGetMaxMemory
+virDomainSetMaxMemory
+
state
_virDomainInfo
+virDomainResume
+
stay
virDomainSuspend
+
store
virConnectListDomains
+virConnectOpen
+virConnectOpenReadOnly
+
string
virDomainGetName
+
structure
_virDomainInfo
+virDomainGetInfo
+
success
virConnectClose
+virDomainDestroy
+virDomainGetInfo
+virDomainResume
+virDomainSetMaxMemory
+virDomainSuspend
+
suspended
virDomainResume
+

Letter t:

term
_virDomainInfo
+
that
virDomainGetInfo
+virDomainGetName
+
their
virConnectListDomains
+
then
virConnectOpenReadOnly
+virDomainGetMaxMemory
+virDomainSetMaxMemory
+
there
virConnectClose
+
this
_virDomainInfo
+virDomainGetMaxMemory
+virDomainSetMaxMemory
+

Letter u:

unsigned
virDomainGetID
+
unused
virConnectOpen
+virConnectOpenReadOnly
+
usable
virConnectOpenReadOnly
+
used
_virDomainInfo
+virDomainDestroy
+virDomainGetInfo
+virDomainSuspend
+
user
virDomainGetInfo
+

Letter v:

version
virConnectGetVersion
+
virDomainFlags
_virDomainInfo
+virDomainCreateLinux
+
virDomainInfo
virDomainGetInfo
+
virDomainResume
virDomainSuspend
+
virSuspendDomain
virDomainResume
+

Letter w:

was
virDomainResume
+
what
_virDomainInfo
+
where
virDomainGetMaxMemory
+virDomainResume
+virDomainSetMaxMemory
+
which
virConnectClose
+
will
virDomainGetName
+virDomainSuspend
+
with
_virDomainInfo
+virConnectClose
+
without
virDomainSuspend
+

Letter x:

xen
virConnectOpen
+virConnectOpenReadOnly
+
xenstore
_virDomainInfo
+

A-m +n-x +

Daniel Veillard

diff --git a/docs/APIconstructors.html b/docs/APIconstructors.html new file mode 100644 index 0000000000..5ae914c5b5 --- /dev/null +++ b/docs/APIconstructors.html @@ -0,0 +1,18 @@ + + +List of constructors for libvir
Red Hat Logo

Libvir the Linux virtualization API

List of constructors for libvir

Developer Menu
API Indexes
Related links

Type unsigned int:

virDomainGetID
+

Type unsigned long:

virConnectGetVersion
+virDomainGetMaxMemory
+

Type virConnectPtr:

virConnectOpen
+virConnectOpenReadOnly
+

Type virDomainPtr:

virDomainCreateLinux
+virDomainLookupByID
+virDomainLookupByName
+

Daniel Veillard

diff --git a/docs/APIfiles.html b/docs/APIfiles.html new file mode 100644 index 0000000000..dcad8609bb --- /dev/null +++ b/docs/APIfiles.html @@ -0,0 +1,42 @@ + + +List of Symbols per Module for libvir
Red Hat Logo

Libvir the Linux virtualization API

List of Symbols per Module for libvir

Developer Menu
API Indexes
Related links

Module libvir:

VIR_DOMAIN_BLOCKED
+VIR_DOMAIN_NONE
+VIR_DOMAIN_NOSTATE
+VIR_DOMAIN_PAUSED
+VIR_DOMAIN_RUNNING
+VIR_DOMAIN_SHUTDOWN
+VIR_DOMAIN_SHUTOFF
+_virDomainInfo
+virConnect
+virConnectClose
+virConnectGetVersion
+virConnectListDomains
+virConnectOpen
+virConnectOpenReadOnly
+virConnectPtr
+virDomain
+virDomainCreateLinux
+virDomainDestroy
+virDomainFlags
+virDomainGetID
+virDomainGetInfo
+virDomainGetMaxMemory
+virDomainGetName
+virDomainInfo
+virDomainInfoPtr
+virDomainLookupByID
+virDomainLookupByName
+virDomainPtr
+virDomainResume
+virDomainSetMaxMemory
+virDomainState
+virDomainSuspend
+

Daniel Veillard

diff --git a/docs/APIfunctions.html b/docs/APIfunctions.html new file mode 100644 index 0000000000..3a2189441c --- /dev/null +++ b/docs/APIfunctions.html @@ -0,0 +1,29 @@ + + +List of function manipulating types in libvir
Red Hat Logo

Libvir the Linux virtualization API

List of function manipulating types in libvir

Developer Menu
API Indexes
Related links

Type int *:

virConnectListDomains
+

Type unsigned int:

virDomainCreateLinux
+

Type unsigned long:

virDomainCreateLinux
+virDomainSetMaxMemory
+

Type virConnectPtr:

virConnectClose
+virConnectGetVersion
+virConnectListDomains
+virDomainCreateLinux
+virDomainLookupByID
+virDomainLookupByName
+

Type virDomainInfoPtr:

virDomainGetInfo
+

Type virDomainPtr:

virDomainDestroy
+virDomainGetID
+virDomainGetInfo
+virDomainGetMaxMemory
+virDomainGetName
+virDomainResume
+virDomainSetMaxMemory
+virDomainSuspend
+

Daniel Veillard

diff --git a/docs/APIsymbols.html b/docs/APIsymbols.html new file mode 100644 index 0000000000..aba7ac8a2d --- /dev/null +++ b/docs/APIsymbols.html @@ -0,0 +1,42 @@ + + +Alphabetic List of Symbols in libvir
Red Hat Logo

Libvir the Linux virtualization API

Alphabetic List of Symbols in libvir

Developer Menu
API Indexes
Related links

Letter V:

VIR_DOMAIN_BLOCKED
+VIR_DOMAIN_NONE
+VIR_DOMAIN_NOSTATE
+VIR_DOMAIN_PAUSED
+VIR_DOMAIN_RUNNING
+VIR_DOMAIN_SHUTDOWN
+VIR_DOMAIN_SHUTOFF
+

Letter _:

_virDomainInfo
+

Letter v:

virConnect
+virConnectClose
+virConnectGetVersion
+virConnectListDomains
+virConnectOpen
+virConnectOpenReadOnly
+virConnectPtr
+virDomain
+virDomainCreateLinux
+virDomainDestroy
+virDomainFlags
+virDomainGetID
+virDomainGetInfo
+virDomainGetMaxMemory
+virDomainGetName
+virDomainInfo
+virDomainInfoPtr
+virDomainLookupByID
+virDomainLookupByName
+virDomainPtr
+virDomainResume
+virDomainSetMaxMemory
+virDomainState
+virDomainSuspend
+

Daniel Veillard

diff --git a/docs/Makefile.am b/docs/Makefile.am index dc3033149e..f6c31a69e1 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -4,18 +4,19 @@ SUBDIRS= # The directory containing the source code (if it contains documentation). DOC_SOURCE_DIR=../src -PAGES= index.html +PAGES= index.html bugs.html FAQ.html APIPAGES=APIconstructors.html APIfiles.html APIfunctions.html \ APIsymbols.html APIchunk0.html EXTRA_DIST= \ - libvir-api.xml libxen-refs.xml apibuild.py + libvir-api.xml libxen-refs.xml apibuild.py \ + *.xsl *.html *.gif html/*.html html/*.png man_MANS= all: web $(man_MANS) -api: libvir-api.xml libvir-refs.xml +api: libvir-api.xml libvir-refs.xml $(APIPAGES) $(srcdir)/html/index.html web: $(PAGES) @@ -28,22 +29,22 @@ $(PAGES): libvir.html site.xsl $(XMLLINT) --nonet --valid --noout $(PAGES) ; fi ); -#$(APIPAGES): libxml2-api.xml libxml2-refs.xml $(top_srcdir)/docs/site.xsl $(top_srcdir)/docs/api.xsl -# -@(if [ -x $(XSLTPROC) ] ; then \ -# echo "Rebuilding the HTML API pages from libxml2-refs.xml" ; \ -# $(XSLTPROC) --nonet --html $(top_srcdir)/doc/api.xsl \ -# $(top_srcdir)/doc/xml.html ; fi ); -# -@(if [ -x $(XMLLINT) ] ; then \ -# echo "Validating the HTML API pages" ; \ -# $(XMLLINT) --nonet --valid --noout API*.html ; fi ); -# -#$(srcdir)/html/index.html: libxml2-api.xml $(srcdir)/newapi.xsl -# -@(if [ -x $(XSLTPROC) ] ; then \ -# echo "Rebuilding the HTML pages from the XML API" ; \ -# $(XSLTPROC) --nonet $(srcdir)/newapi.xsl libxml2-api.xml ; fi ) -# -@(if [ -x $(XMLLINT) ] ; then \ -# echo "Validating the resulting XHTML pages" ; \ -# $(XMLLINT) --nonet --valid --noout html/*.html ; fi ); +$(APIPAGES): libvir-api.xml libvir-refs.xml $(top_srcdir)/docs/site.xsl $(top_srcdir)/docs/api.xsl + -@(if [ -x $(XSLTPROC) ] ; then \ + echo "Rebuilding the HTML API pages from libvir-refs.xml" ; \ + $(XSLTPROC) --nonet --html $(top_srcdir)/docs/api.xsl \ + $(top_srcdir)/docs/libvir.html ; fi ); + -@(if [ -x $(XMLLINT) ] ; then \ + echo "Validating the HTML API pages" ; \ + $(XMLLINT) --nonet --valid --noout API*.html ; fi ); + +$(srcdir)/html/index.html: libvir-api.xml $(srcdir)/newapi.xsl + -@(if [ -x $(XSLTPROC) ] ; then \ + echo "Rebuilding the HTML pages from the XML API" ; \ + $(XSLTPROC) --nonet $(srcdir)/newapi.xsl libvir-api.xml ; fi ) + -@(if [ -x $(XMLLINT) ] ; then \ + echo "Validating the resulting XHTML pages" ; \ + $(XMLLINT) --nonet --valid --noout html/*.html ; fi ); libvir-api.xml libvir-refs.xml: apibuild.py ../include/*.h ../src/*.h ../src/*.c -(./apibuild.py) @@ -58,7 +59,7 @@ rebuild: api all #install-data-local: # $(mkinstalldirs) $(DESTDIR)$(HTML_DIR) -# -@INSTALL@ -m 0644 $(srcdir)/xml.html $(srcdir)/encoding.html $(srcdir)/FAQ.html $(srcdir)/structure.gif $(srcdir)/DOM.gif $(srcdir)/smallfootonly.gif $(srcdir)/redhat.gif $(srcdir)/libxml.gif $(srcdir)/w3c.png $(srcdir)/Libxml2-Logo-180x168.gif $(srcdir)/Libxml2-Logo-90x34.gif $(DESTDIR)$(HTML_DIR) +# -@INSTALL@ -m 0644 $(srcdir)/libvir.html $(srcdir)/encoding.html $(srcdir)/FAQ.html $(srcdir)/structure.gif $(srcdir)/DOM.gif $(srcdir)/smallfootonly.gif $(srcdir)/redhat.gif $(srcdir)/libxml.gif $(srcdir)/w3c.png $(srcdir)/Libxml2-Logo-180x168.gif $(srcdir)/Libxml2-Logo-90x34.gif $(DESTDIR)$(HTML_DIR) # $(mkinstalldirs) $(DESTDIR)$(HTML_DIR)/html # -@INSTALL@ -m 0644 $(srcdir)/html/*.html $(DESTDIR)$(HTML_DIR)/html # -@INSTALL@ -m 0644 $(srcdir)/html/*.png $(DESTDIR)$(HTML_DIR)/html diff --git a/docs/apibuild.py b/docs/apibuild.py index 4385fb586c..2c3c158d27 100755 --- a/docs/apibuild.py +++ b/docs/apibuild.py @@ -21,6 +21,7 @@ ignored_files = { "virsh.c": "testing tool", "hash.c": "internal hash table stuff", "hash.h": "internal hash table stuff", + "internal.h": "internal includes and defines", } ignored_words = { diff --git a/docs/html/book1.html b/docs/html/book1.html new file mode 100644 index 0000000000..5b1cd9d013 --- /dev/null +++ b/docs/html/book1.html @@ -0,0 +1,13 @@ + + +Reference Manual for libvir
Red Hat Logo

Reference Manual for libvir

API Menu
API Indexes
Related links

Table of Contents

  • libvir: core interfaces for the libvir library

Daniel Veillard

diff --git a/docs/html/home.png b/docs/html/home.png new file mode 100644 index 0000000000..17003611d9 Binary files /dev/null and b/docs/html/home.png differ diff --git a/docs/html/index.html b/docs/html/index.html new file mode 100644 index 0000000000..5b1cd9d013 --- /dev/null +++ b/docs/html/index.html @@ -0,0 +1,13 @@ + + +Reference Manual for libvir
Red Hat Logo

Reference Manual for libvir

API Menu
API Indexes
Related links

Table of Contents

  • libvir: core interfaces for the libvir library

Daniel Veillard

diff --git a/docs/html/left.png b/docs/html/left.png new file mode 100644 index 0000000000..2d05b3d5b4 Binary files /dev/null and b/docs/html/left.png differ diff --git a/docs/html/libxml-lib.html b/docs/html/libxml-lib.html new file mode 100644 index 0000000000..5b1cd9d013 --- /dev/null +++ b/docs/html/libxml-lib.html @@ -0,0 +1,13 @@ + + +Reference Manual for libvir
Red Hat Logo

Reference Manual for libvir

API Menu
API Indexes
Related links

Table of Contents

  • libvir: core interfaces for the libvir library

Daniel Veillard

diff --git a/docs/html/libxml-libvir.html b/docs/html/libxml-libvir.html new file mode 100644 index 0000000000..18634cdccf --- /dev/null +++ b/docs/html/libxml-libvir.html @@ -0,0 +1,99 @@ + + +Module libvir from libvir
Red Hat Logo

Module libvir from libvir

API Menu
API Indexes
Related links
UpAPI documentationHomeThe XML C parser and toolkit of Gnome

Provides the interfaces of the libvir library to handle Xen domains from a process running in domain 0

Table of Contents

Structure virConnect
struct _virConnect
+The content of this structure is not made public by the API.
+
Typedef virConnect * virConnectPtr
+
Structure virDomain
struct _virDomain
+The content of this structure is not made public by the API.
+
Enum virDomainFlags
+
Structure virDomainInfo
struct _virDomainInfo
+
Typedef virDomainInfo * virDomainInfoPtr
+
Typedef virDomain * virDomainPtr
+
Enum virDomainState
+
int	virConnectClose			(virConnectPtr conn)
+
unsigned long	virConnectGetVersion	(virConnectPtr conn)
+
int	virConnectListDomains		(virConnectPtr conn, 
					 int * ids, 
					 int maxids)
+
virConnectPtr	virConnectOpen		(const char * name)
+
virConnectPtr	virConnectOpenReadOnly	(const char * name)
+
virDomainPtr	virDomainCreateLinux	(virConnectPtr conn, 
					 const char * kernel_path, 
					 const char * initrd_path, 
					 const char * cmdline, 
					 unsigned long memory, 
					 unsigned int flags)
+
int	virDomainDestroy		(virDomainPtr domain)
+
unsigned int	virDomainGetID		(virDomainPtr domain)
+
int	virDomainGetInfo		(virDomainPtr domain, 
					 virDomainInfoPtr info)
+
unsigned long	virDomainGetMaxMemory	(virDomainPtr domain)
+
const char *	virDomainGetName	(virDomainPtr domain)
+
virDomainPtr	virDomainLookupByID	(virConnectPtr conn, 
					 int id)
+
virDomainPtr	virDomainLookupByName	(virConnectPtr conn, 
					 const char * name)
+
int	virDomainResume			(virDomainPtr domain)
+
int	virDomainSetMaxMemory		(virDomainPtr domain, 
					 unsigned long memory)
+
int	virDomainSuspend		(virDomainPtr domain)
+

Description

+

Structure virConnect

Structure virConnect
struct _virConnect {
+The content of this structure is not made public by the API.
+}
+ a virConnectPtr is pointer to a virConnect private structure, this is the type used to reference a connection to the Xen Hypervisor in the API. +

Structure virDomain

Structure virDomain
struct _virDomain {
+The content of this structure is not made public by the API.
+}

Enum virDomainFlags

Enum virDomainFlags {
+    VIR_DOMAIN_NONE = 0
+}
+

Structure virDomainInfo

Structure virDomainInfo
struct _virDomainInfo {
+    unsigned char	state	: the running state, one of virDomainFlag
+    unsigned long	maxMem	: the maximum memory in KBytes allowed
+    unsigned long	memory	: the memory in KBytes used by the domain
+    unsigned short	nrVirtCpu	: * Informations below are only available
+    unsigned long long	cpuTime	: * TODO: * - check what can be extracted
+}
+ a virDomainInfoPtr is a pointer to a virDomainInfo structure. + + a virDomainPtr is pointer to a virDomain private structure, this is the type used to reference a Xen domain in the API. +

Enum virDomainState

Enum virDomainState {
+    VIR_DOMAIN_NOSTATE = 0 : no state
+    VIR_DOMAIN_RUNNING = 1 : the domain is running
+    VIR_DOMAIN_BLOCKED = 2 : the domain is blocked on resource
+    VIR_DOMAIN_PAUSED = 3 : the domain is paused by user
+    VIR_DOMAIN_SHUTDOWN = 4 : the domain is being shut down
+    VIR_DOMAIN_SHUTOFF = 5 : the domain is shut off
+}
+

Function: virConnectClose

int	virConnectClose			(virConnectPtr conn)

+

This function closes the connection to the Hypervisor. This should not be called if further interaction with the Hypervisor are needed especially if there is running domain which need further monitoring by the application.

+
conn:pointer to the hypervisor connection
Returns:0 in case of success or -1 in case of error.

Function: virConnectGetVersion

unsigned long	virConnectGetVersion	(virConnectPtr conn)

+

Get the version level of the Hypervisor running.

+
conn:pointer to the hypervisor connection
Returns:-1 in case of error or major * 10,000 + minor * 100 + rev otherwise

Function: virConnectListDomains

int	virConnectListDomains		(virConnectPtr conn, 
					 int * ids, 
					 int maxids)

+

Collect the list of active domains, and store their ID in @maxids

+
conn:pointer to the hypervisor connection
ids:array to collect the list of IDs of active domains
maxids:size of @ids
Returns:the number of domain found or -1 in case of error

Function: virConnectOpen

virConnectPtr	virConnectOpen		(const char * name)

+

This function should be called first to get a connection to the Hypervisor and xen store

+
name:optional argument currently unused, pass NULL
Returns:a pointer to the hypervisor connection or NULL in case of error

Function: virConnectOpenReadOnly

virConnectPtr	virConnectOpenReadOnly	(const char * name)

+

This function should be called first to get a read-only connection to the xen store. The set of APIs usable are then restricted.

+
name:optional argument currently unused, pass NULL
Returns:a pointer to the hypervisor connection or NULL in case of error

Function: virDomainCreateLinux

virDomainPtr	virDomainCreateLinux	(virConnectPtr conn, 
					 const char * kernel_path, 
					 const char * initrd_path, 
					 const char * cmdline, 
					 unsigned long memory, 
					 unsigned int flags)

+

Launch a new Linux guest domain

+
conn:pointer to the hypervisor connection
kernel_path:the file path to the kernel image
initrd_path:an optional file path to an initrd
cmdline:optional command line parameters for the kernel
memory:the memory size in kilobytes
flags:an optional set of virDomainFlags
Returns:a new domain object or NULL in case of failure

Function: virDomainDestroy

int	virDomainDestroy		(virDomainPtr domain)

+

Destroy the domain object. The running instance is shutdown if not down already and all resources used by it are given back to the hypervisor.

+
domain:a domain object
Returns:0 in case of success and -1 in case of failure.

Function: virDomainGetID

unsigned int	virDomainGetID		(virDomainPtr domain)

+

Get the hypervisor ID number for the domain

+
domain:a domain object
Returns:the domain ID number or (unsigned int) -1 in case of error

Function: virDomainGetInfo

int	virDomainGetInfo		(virDomainPtr domain, 
					 virDomainInfoPtr info)

+

Extract information about a domain. Note that if the connection used to get the domain is limited only a partial set of the informations can be extracted.

+
domain:a domain object or NULL
info:pointer to a virDomainInfo structure allocated by the user
Returns:0 in case of success and -1 in case of failure.

Function: virDomainGetMaxMemory

unsigned long	virDomainGetMaxMemory	(virDomainPtr domain)

+

Retrieve the maximum amount of physical memory allocated to a domain. If domain is NULL, then this get the amount of memory reserved to Domain0 i.e. the domain where the application runs.

+
domain:a domain object or NULL
Returns:the memory size in kilobytes or 0 in case of error.

Function: virDomainGetName

const char *	virDomainGetName	(virDomainPtr domain)

+

Get the public name for that domain

+
domain:a domain object
Returns:a pointer to the name or NULL, the string need not be deallocated its lifetime will be the same as the domain object.

Function: virDomainLookupByID

virDomainPtr	virDomainLookupByID	(virConnectPtr conn, 
					 int id)

+

Try to find a domain based on the hypervisor ID number

+
conn:pointer to the hypervisor connection
id:the domain ID number
Returns:a new domain object or NULL in case of failure

Function: virDomainLookupByName

virDomainPtr	virDomainLookupByName	(virConnectPtr conn, 
					 const char * name)

+

Try to lookup a domain on the given hypervisor

+
conn:pointer to the hypervisor connection
name:name for the domain
Returns:a new domain object or NULL in case of failure

Function: virDomainResume

int	virDomainResume			(virDomainPtr domain)

+

Resume an suspended domain, the process is restarted from the state where it was frozen by calling virSuspendDomain().

+
domain:a domain object
Returns:0 in case of success and -1 in case of failure.

Function: virDomainSetMaxMemory

int	virDomainSetMaxMemory		(virDomainPtr domain, 
					 unsigned long memory)

+

Dynamically change the maximum amount of physical memory allocated to a domain. If domain is NULL, then this change the amount of memory reserved to Domain0 i.e. the domain where the application runs.

+
domain:a domain object or NULL
memory:the memory size in kilobytes
Returns:0 in case of success and -1 in case of failure.

Function: virDomainSuspend

int	virDomainSuspend		(virDomainPtr domain)

+

Suspends an active domain, the process is frozen without further access to CPU resources and I/O but the memory used by the domain at the hypervisor level will stay allocated. Use virDomainResume() to reactivate the domain.

+
domain:a domain object
Returns:0 in case of success and -1 in case of failure.

Daniel Veillard

diff --git a/docs/html/right.png b/docs/html/right.png new file mode 100644 index 0000000000..92832e3a45 Binary files /dev/null and b/docs/html/right.png differ diff --git a/docs/html/up.png b/docs/html/up.png new file mode 100644 index 0000000000..85b3e2a275 Binary files /dev/null and b/docs/html/up.png differ diff --git a/docs/index.html b/docs/index.html index 3a8eed8462..a8590c9e9a 100644 --- a/docs/index.html +++ b/docs/index.html @@ -30,7 +30,7 @@ A:link, A:visited, A:active { text-decoration: underline }

Libvir the Linux virtualization API

-

libxml

+

libvir

diff --git a/docs/libvir-api.xml b/docs/libvir-api.xml index 989a1aeaec..d507f01133 100644 --- a/docs/libvir-api.xml +++ b/docs/libvir-api.xml @@ -2,6 +2,9 @@ + core interfaces for the libvir library + Provides the interfaces of the libvir library to handle Xen domains from a process running in domain 0 + Daniel Veillard <veillard@redhat.com> @@ -35,18 +38,8 @@ - - - - - - Macro to flag conciously unused parameters to functions - - - macro to flag unimplemented blocks - diff --git a/docs/libvir-refs.xml b/docs/libvir-refs.xml index 65d29589d3..6cc8786c7d 100644 --- a/docs/libvir-refs.xml +++ b/docs/libvir-refs.xml @@ -1,8 +1,6 @@ - - @@ -37,12 +35,6 @@ - - - - - - @@ -168,10 +160,6 @@ - - - - @@ -243,11 +231,6 @@ - - - - - @@ -362,9 +345,6 @@ - - - @@ -420,9 +400,6 @@ - - - @@ -490,10 +467,6 @@ - - - - @@ -520,9 +493,6 @@ - - - @@ -621,9 +591,6 @@ - - - @@ -711,7 +678,6 @@ - @@ -872,14 +838,10 @@ - - - - diff --git a/docs/site.xsl b/docs/site.xsl index 4dcdeecdfc..6fe7142dc0 100644 --- a/docs/site.xsl +++ b/docs/site.xsl @@ -654,7 +654,7 @@ A:link, A:visited, A:active { text-decoration: underline } - + diff --git a/include/libvir.h b/include/libvir.h index 6707f8ff97..20b855cab8 100644 --- a/include/libvir.h +++ b/include/libvir.h @@ -1,12 +1,14 @@ /* - * libvir.h: interface for the libvir library to handle Xen domains - * from a process running in domain 0 + * libvir.h: + * Summary: core interfaces for the libvir library + * Description: Provides the interfaces of the libvir library to handle + * Xen domains from a process running in domain 0 * - * Copyright (C) 2005 Red Hat, Inc. + * Copy: Copyright (C) 2005 Red Hat, Inc. * * See COPYING.LIB for the License of this software * - * Daniel Veillard + * Author: Daniel Veillard */ #ifndef __VIR_VIRLIB_H__