From 5fe8d8b3ff4c21db02478c2778631927a2388270 Mon Sep 17 00:00:00 2001 From: Daniel Veillard Date: Thu, 9 Feb 2006 18:03:54 +0000 Subject: [PATCH] Fixing generation, Daniel --- docs/apibuild.py | 4 +- docs/html/book1.html | 2 +- docs/html/index.html | 2 +- docs/{libvir-api.xml => libvirt-api.xml} | 116 ++++++++++----------- docs/{libvir-refs.xml => libvirt-refs.xml} | 116 ++++++++++----------- 5 files changed, 120 insertions(+), 120 deletions(-) rename docs/{libvir-api.xml => libvirt-api.xml} (76%) rename docs/{libvir-refs.xml => libvirt-refs.xml} (89%) diff --git a/docs/apibuild.py b/docs/apibuild.py index ada57fbe55..15c01ce85a 100755 --- a/docs/apibuild.py +++ b/docs/apibuild.py @@ -2073,11 +2073,11 @@ class docBuilder: def rebuild(): builder = None - if glob.glob("../src/libvir.c") != [] : + if glob.glob("../src/libvirt.c") != [] : print "Rebuilding API description for libvirt" builder = docBuilder("libvirt", ["../src", "../include"], []) - elif glob.glob("src/libvir.c") != [] : + elif glob.glob("src/libvirt.c") != [] : print "Rebuilding API description for libvir" builder = docBuilder("libvirt", ["src", "include"], []) diff --git a/docs/html/book1.html b/docs/html/book1.html index 99c0a97029..893b6f1e85 100644 --- a/docs/html/book1.html +++ b/docs/html/book1.html @@ -1,3 +1,3 @@ -Reference Manual for libvir

Reference Manual for libvir

Table of Contents

  • libvir: core interfaces for the libvir library

main menu

related links

Graphics and design by Diana Fong

+Reference Manual for libvirt

Reference Manual for libvirt

Table of Contents

  • libvirt: core interfaces for the libvirt library

main menu

related links

Graphics and design by Diana Fong

diff --git a/docs/html/index.html b/docs/html/index.html index 99c0a97029..893b6f1e85 100644 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -1,3 +1,3 @@ -Reference Manual for libvir

Reference Manual for libvir

Table of Contents

  • libvir: core interfaces for the libvir library

main menu

related links

Graphics and design by Diana Fong

+Reference Manual for libvirt

Reference Manual for libvirt

Table of Contents

  • libvirt: core interfaces for the libvirt library

main menu

related links

Graphics and design by Diana Fong

diff --git a/docs/libvir-api.xml b/docs/libvirt-api.xml similarity index 76% rename from docs/libvir-api.xml rename to docs/libvirt-api.xml index 49dedf2ea2..450487ac42 100644 --- a/docs/libvir-api.xml +++ b/docs/libvirt-api.xml @@ -1,9 +1,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 + + core interfaces for the libvirt library + Provides the interfaces of the libvirt library to handle Xen domains from a process running in domain 0 Daniel Veillard <veillard@redhat.com> @@ -64,33 +64,33 @@ - + Macro providing the version of the library as version * 1,000,000 + minor * 1000 + micro - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + 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. - - - - + + + + @@ -103,62 +103,62 @@ * - add padding to this structure for ABI long term protection *'/> - + a virDomainInfoPtr is a pointer to a virDomainInfo structure. - + - + a virDomainKernelPtr is a pointer to a virDomainKernel structure. - + a virDomainPtr is pointer to a virDomain private structure, this is the type used to reference a Xen domain in the API. - - - + + + 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. - + Get the name of the Hypervisor software used. - + Get the version level of the Hypervisor running. This may work only with hypervisor call, i.e. with priviledged access to the hypervisor, not with a Read-Only connection. - + Collect the list of active domains, and store their ID in @maxids - + Provides the number of active domains. - + This function should be called first to get a connection to the Hypervisor and xen store - + This function should be called first to get a restricted connection to the libbrary functionalities. The set of APIs usable are then restricted on the available methods to control the domains. - + Launch a new Linux guest domain, unimplemented yet, API to be defined. This would function requires priviledged access to the hypervisor. @@ -168,94 +168,94 @@ - + 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. The data structure is freed and should not be used thereafter if the call does not return an error. This function may requires priviledged access - + Free the domain object. The running instance is kept alive. The data structure is freed and should not be used thereafter. - + Get the hypervisor ID number for the domain - + 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. - + 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. - + Get the public name for that domain - + Get the type of domain operation system. - + Provide an XML description of the domain. NOTE: this API is subject to changes. - + Try to find a domain based on the hypervisor ID number - + Try to lookup a domain on the given hypervisor based on its name. - + This method will restore a domain saved to disk by virDomainSave(). - + Resume an suspended domain, the process is restarted from the state where it was frozen by calling virSuspendDomain(). This function may requires priviledged access - + This method will suspend a domain and save its memory contents to a file on disk. After the call, if successful, the domain is not listed as running anymore (this may be a problem). Use virDomainRestore() to restore a domain after saving. - + 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. This function requires priviledged access to the hypervisor. - + Shutdown a domain, the domain object is still usable there after but the domain OS is being stopped. Note that the guest OS may ignore the request. TODO: should we add an option for reboot, knowing it may not be doable in the general case ? - + 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. This function may requires priviledged access. - + Provides two information back, @libVer is the version of the library while @typeVer will be the version of the hypervisor type @type against which the library was compiled. If @type is NULL, "Xen" is assumed, if @type is unknown or not availble, an error code will be returned and @typeVer will be 0. diff --git a/docs/libvir-refs.xml b/docs/libvirt-refs.xml similarity index 89% rename from docs/libvir-refs.xml rename to docs/libvirt-refs.xml index 110087e600..af83e808a8 100644 --- a/docs/libvir-refs.xml +++ b/docs/libvirt-refs.xml @@ -1,62 +1,62 @@ - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -187,7 +187,7 @@ - +