libvirt.c: document the virState* functions

* src/libvirt.c (virStateActive, virStateCleanup, virStateReload):
(virStateActive): Add per-function comments.
This commit is contained in:
Jim Meyering 2008-11-25 10:31:52 +00:00
parent 1ad44362e3
commit 335de2ba1f
2 changed files with 34 additions and 0 deletions

View File

@ -1,3 +1,9 @@
Tue Nov 25 11:29:18 +0100 2008 Jim Meyering <meyering@redhat.com>
libvirt.c: document the virState* functions
* src/libvirt.c (virStateActive, virStateCleanup, virStateReload):
(virStateActive): Add per-function comments.
Mon Nov 24 19:32:40 GMT 2008 Dnaiel P. Berrange <berrange@redhat.com> Mon Nov 24 19:32:40 GMT 2008 Dnaiel P. Berrange <berrange@redhat.com>
* src/openvz_conf.c, src/openvz_conf.h, src/openvz_driver.c: * src/openvz_conf.c, src/openvz_conf.h, src/openvz_driver.c:

View File

@ -636,6 +636,13 @@ virRegisterStateDriver(virStateDriverPtr driver)
return virStateDriverTabCount++; return virStateDriverTabCount++;
} }
/**
* virStateInitialize:
*
* Initialize all virtualization drivers.
*
* Return 0 if all succeed, -1 upon any failure.
*/
int virStateInitialize(void) { int virStateInitialize(void) {
int i, ret = 0; int i, ret = 0;
@ -650,6 +657,13 @@ int virStateInitialize(void) {
return ret; return ret;
} }
/**
* virStateCleanup:
*
* Run each virtualization driver's cleanup method.
*
* Return 0 if all succeed, -1 upon any failure.
*/
int virStateCleanup(void) { int virStateCleanup(void) {
int i, ret = 0; int i, ret = 0;
@ -661,6 +675,13 @@ int virStateCleanup(void) {
return ret; return ret;
} }
/**
* virStateReload:
*
* Run each virtualization driver's reload method.
*
* Return 0 if all succeed, -1 upon any failure.
*/
int virStateReload(void) { int virStateReload(void) {
int i, ret = 0; int i, ret = 0;
@ -672,6 +693,13 @@ int virStateReload(void) {
return ret; return ret;
} }
/**
* virStateActive:
*
* Run each virtualization driver's "active" method.
*
* Return 0 if none are active, 1 if at least one is.
*/
int virStateActive(void) { int virStateActive(void) {
int i, ret = 0; int i, ret = 0;