From 944f0d385e2bd28cf3a6f0bb75b58166cf48e7ef Mon Sep 17 00:00:00 2001 From: Daniel Veillard Date: Wed, 7 Dec 2005 12:56:14 +0000 Subject: [PATCH] * docs/ChangeLog.awk docs/ChangeLog.xsl: Changelog handling from libxml2 adapted to libvir * docs/* docs/html/libxml-libvir.html: regenerated Daniel --- ChangeLog | 6 ++ docs/APIchunk0.html | 5 ++ docs/APIchunk1.html | 2 + docs/APIfiles.html | 1 + docs/APIfunctions.html | 1 + docs/APIsymbols.html | 1 + docs/ChangeLog.awk | 49 ++++++++++++++++ docs/ChangeLog.xsl | 109 +++++++++++++++++++++++++++++++++++ docs/html/libxml-libvir.html | 5 +- docs/libvir-api.xml | 10 +++- docs/libvir-refs.xml | 11 ++++ 11 files changed, 197 insertions(+), 3 deletions(-) create mode 100755 docs/ChangeLog.awk create mode 100644 docs/ChangeLog.xsl diff --git a/ChangeLog b/ChangeLog index 78b5e68d98..b5a2966242 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +Wed Dec 7 13:55:04 CET 2005 Daniel Veillard + + * docs/ChangeLog.awk docs/ChangeLog.xsl: Changelog handling from + libxml2 adapted to libvir + * docs/* docs/html/libxml-libvir.html: regenerated + Wed Dec 7 11:58:20 CET 2005 Daniel Veillard * docs/* docs/html/*: more work on the docs generation diff --git a/docs/APIchunk0.html b/docs/APIchunk0.html index fbeeb160ff..bf526c2373 100644 --- a/docs/APIchunk0.html +++ b/docs/APIchunk0.html @@ -89,6 +89,7 @@ A:link, A:visited, A:active { text-decoration: underline }
case
virConnectClose
virConnectGetVersion
virConnectListDomains
+virConnectNumOfDomains
virConnectOpen
virConnectOpenReadOnly
virDomainCreateLinux
@@ -111,6 +112,7 @@ A:link, A:visited, A:active { text-decoration: underline } virConnectClose
virConnectGetVersion
virConnectListDomains
+virConnectNumOfDomains
virConnectOpen
virConnectOpenReadOnly
virDomainCreateLinux
@@ -125,6 +127,7 @@ A:link, A:visited, A:active { text-decoration: underline }

Letter e:

error
virConnectClose
virConnectGetVersion
virConnectListDomains
+virConnectNumOfDomains
virConnectOpen
virConnectOpenReadOnly
virDomainGetID
@@ -150,6 +153,7 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainGetName
virDomainLookupByName
found
virConnectListDomains
+virConnectNumOfDomains
from
_virDomainInfo
virDomainResume
frozen
virDomainResume
@@ -171,6 +175,7 @@ A:link, A:visited, A:active { text-decoration: underline } virConnectClose
virConnectGetVersion
virConnectListDomains
+virConnectNumOfDomains
virConnectOpen
virConnectOpenReadOnly
virDomainCreateLinux
diff --git a/docs/APIchunk1.html b/docs/APIchunk1.html index 9c90119a02..4d2abbdafc 100644 --- a/docs/APIchunk1.html +++ b/docs/APIchunk1.html @@ -21,6 +21,7 @@ A:link, A:visited, A:active { text-decoration: underline } virDomainDestroy
virDomainGetName
number
virConnectListDomains
+virConnectNumOfDomains
virDomainGetID
virDomainLookupByID

Letter o:

object
virDomainCreateLinux
@@ -52,6 +53,7 @@ A:link, A:visited, A:active { text-decoration: underline }
pointer
virConnectClose
virConnectGetVersion
virConnectListDomains
+virConnectNumOfDomains
virConnectOpen
virConnectOpenReadOnly
virDomainCreateLinux
diff --git a/docs/APIfiles.html b/docs/APIfiles.html index dcad8609bb..0bc368a134 100644 --- a/docs/APIfiles.html +++ b/docs/APIfiles.html @@ -19,6 +19,7 @@ A:link, A:visited, A:active { text-decoration: underline } virConnectClose
virConnectGetVersion
virConnectListDomains
+virConnectNumOfDomains
virConnectOpen
virConnectOpenReadOnly
virConnectPtr
diff --git a/docs/APIfunctions.html b/docs/APIfunctions.html index 3a2189441c..ed7252e05d 100644 --- a/docs/APIfunctions.html +++ b/docs/APIfunctions.html @@ -14,6 +14,7 @@ A:link, A:visited, A:active { text-decoration: underline }

Type virConnectPtr:

virConnectClose
virConnectGetVersion
virConnectListDomains
+virConnectNumOfDomains
virDomainCreateLinux
virDomainLookupByID
virDomainLookupByName
diff --git a/docs/APIsymbols.html b/docs/APIsymbols.html index aba7ac8a2d..83a5bed89e 100644 --- a/docs/APIsymbols.html +++ b/docs/APIsymbols.html @@ -19,6 +19,7 @@ A:link, A:visited, A:active { text-decoration: underline } virConnectClose
virConnectGetVersion
virConnectListDomains
+virConnectNumOfDomains
virConnectOpen
virConnectOpenReadOnly
virConnectPtr
diff --git a/docs/ChangeLog.awk b/docs/ChangeLog.awk new file mode 100755 index 0000000000..eb0db03245 --- /dev/null +++ b/docs/ChangeLog.awk @@ -0,0 +1,49 @@ +#!/bin/awk -f +function translate(str) { + while (sub(/&/, "#amp;", str) == 1); + while (sub(/#amp;/, "\\&", str) == 1); # fun isn't it ? + while (sub(//, "\\>", str) == 1); + sub(/[0-9][0-9][0-9][0-9][0-9]+/, "", str) + return(str) +} +BEGIN { + nb_entry = 0 + in_entry = 0 + in_item = 0 + print "" + print "" + } +END { + if (in_item == 1) printf("%s\n", translate(item)) + if (in_entry == 1) print " " + print "" + } +/^[ \t]*$/ { next } +/^[A-Za-z0-9]/ { + match($0, "\(.*\) \([A-Z]+\) \([0-9][0-9][0-9][0-9]\) \(.*\) <\(.*\)>", loge) + if (in_item == 1) printf("%s\n", translate(item)) + if (in_entry == 1) print " " + nb_entry = nb_entry + 1 + if (nb_entry > 50) { + in_entry = 0 + in_item = 0 + exit + } + in_entry = 1 + in_item = 0 + printf(" \n", loge[1], loge[2], loge[3], loge[4], loge[5]) + } +/^[ \t]*\*/ { + if (in_item == 1) printf("%s\n", translate(item)) + in_item = 1 + printf(" ") + match($0, "[ \t]*. *\(.*\)", loge) + item = loge[1] + } +/^[ \t]*[a-zA-Z0-9\#]/ { + if (in_item == 1) { + match($0, "[ \t]*\(.*\)[ \t]*", loge) + item = sprintf("%s %s", item, loge[1]) + } + } diff --git a/docs/ChangeLog.xsl b/docs/ChangeLog.xsl new file mode 100644 index 0000000000..f58122f822 --- /dev/null +++ b/docs/ChangeLog.xsl @@ -0,0 +1,109 @@ + + + + + + + + + + + libvir + + + API Menu + +

+ + +
+ + + + + + + + + +
    • +     + + + +

    + + + + + +

      + +
    +

    +     + + + ChangeLog last entries of + + + + + + + + + + + + + + + +
    + + + + + +
    + + + + + + +
    + + + + +
    + + + + +
    + +

    Daniel Veillard

    +
    +
    +
    +
    +
    + + +     + + diff --git a/docs/html/libxml-libvir.html b/docs/html/libxml-libvir.html index 18634cdccf..21c732c486 100644 --- a/docs/html/libxml-libvir.html +++ b/docs/html/libxml-libvir.html @@ -23,6 +23,7 @@ The content of this structure is not made public by the API. 
    int	virConnectClose			(virConnectPtr conn)
    unsigned long	virConnectGetVersion	(virConnectPtr conn)
    int	virConnectListDomains		(virConnectPtr conn, 
    					 int * ids, 
    					 int maxids)
    +
    int	virConnectNumOfDomains		(virConnectPtr conn)
    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)
    @@ -70,7 +71,9 @@ The content of this structure is not made public by the API.

    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)
    
+
    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: virConnectNumOfDomains
    int	virConnectNumOfDomains		(virConnectPtr conn)
    
+
    
+
    conn:pointer to the hypervisor connection
    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.
    
diff --git a/docs/libvir-api.xml b/docs/libvir-api.xml
index d507f01133..e91f167308 100644
--- a/docs/libvir-api.xml
+++ b/docs/libvir-api.xml
@@ -23,13 +23,14 @@
      
      
      
-     
+     
      
      
      
      
-     
+     
      
+     
      
      
      
@@ -90,6 +91,11 @@
       
       
     
+    
+      
+      
+      
+    
     
       This function should be called first to get a connection to the Hypervisor and xen store
       
diff --git a/docs/libvir-refs.xml b/docs/libvir-refs.xml
index 6cc8786c7d..60852eaf06 100644
--- a/docs/libvir-refs.xml
+++ b/docs/libvir-refs.xml
@@ -13,6 +13,7 @@
     
     
     
+    
     
     
     
@@ -52,6 +53,7 @@
       
       
       
+      
       
       
       
@@ -107,6 +109,7 @@
       
       
       
+      
       
       
       
@@ -139,6 +142,7 @@
       
       
       
+      
       
       
       
@@ -369,6 +373,7 @@
           
           
           
+          
           
           
           
@@ -405,6 +410,7 @@
           
           
           
+          
           
           
           
@@ -433,6 +439,7 @@
           
           
           
+          
           
           
           
@@ -476,6 +483,7 @@
         
         
           
+          
         
         
           
@@ -519,6 +527,7 @@
           
           
           
+          
           
           
           
@@ -639,6 +648,7 @@
         
         
           
+          
           
           
         
@@ -698,6 +708,7 @@
           
           
           
+          
           
           
           
-- 
2.47.2