diff --git a/ChangeLog b/ChangeLog index 9584af80e7..6c9a671be2 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +Wed Feb 22 11:53:45 CET 2006 Daniel Veillard + + * configure.in libvirt.spec.in docs/Makefile.am docs/devhelp/*: + added devhelp docs support, based on libxml2 stylesheets + Wed Feb 22 09:57:11 CET 2006 Daniel Veillard * TODO: updated diff --git a/configure.in b/configure.in index 75d62ce280..9086c317e9 100644 --- a/configure.in +++ b/configure.in @@ -236,6 +236,6 @@ rm -f COPYING cp COPYING.LIB COPYING AC_OUTPUT(Makefile src/Makefile include/Makefile docs/Makefile \ - docs/examples/Makefile \ + docs/examples/Makefile docs/devhelp/Makefile \ libvirt.pc libvirt.spec include/libvirt.h \ python/Makefile python/tests/Makefile) diff --git a/docs/Makefile.am b/docs/Makefile.am index ad1a2f1f5e..e488ba0e1a 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -1,5 +1,5 @@ ## Process this file with automake to produce Makefile.in -SUBDIRS=examples +SUBDIRS= . examples devhelp # The directory containing the source code (if it contains documentation). DOC_SOURCE_DIR=../src diff --git a/docs/devhelp/Makefile.am b/docs/devhelp/Makefile.am new file mode 100644 index 0000000000..c599989d60 --- /dev/null +++ b/docs/devhelp/Makefile.am @@ -0,0 +1,27 @@ +DEVHELP_DIR=$(datadir)/gtk-doc/html/libvirt +HTML_FILES=index.html general.html $(HTML_MODULES) +HTML_MODULES= \ + libvirt-libvirt.html + +EXTRA_FORMAT= \ + home.png \ + left.png \ + right.png \ + up.png \ + style.css + +EXTRA_DIST=devhelp.xsl html.xsl libvirt.devhelp $(HTML_FILES) $(EXTRA_FORMAT) + +all: libvirt.devhelp $(HTML_FILES) + +libvirt.devhelp $(HTML_FILES): devhelp.xsl html.xsl $(top_srcdir)/docs/libvirt-api.xml + -@(echo Rebuilding devhelp files) + -@(if [ -x $(XSLTPROC) ] ; then \ + $(XSLTPROC) --nonet -o $(srcdir)/libvirt.devhelp devhelp.xsl $(top_srcdir)/docs/libvirt-api.xml ; fi ); + +install-data-local: + $(mkinstalldirs) $(DESTDIR)$(DEVHELP_DIR) + -@INSTALL@ -m 0644 libvirt.devhelp $(DESTDIR)$(DEVHELP_DIR) + -@INSTALL@ -m 0644 $(EXTRA_FORMAT) $(DESTDIR)$(DEVHELP_DIR) + -@INSTALL@ -m 0644 $(HTML_FILES) $(DESTDIR)$(DEVHELP_DIR) + diff --git a/docs/devhelp/devhelp.xsl b/docs/devhelp/devhelp.xsl new file mode 100644 index 0000000000..ce67a50184 --- /dev/null +++ b/docs/devhelp/devhelp.xsl @@ -0,0 +1,127 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + <xsl:value-of select="concat(@name, ': ', summary)"/> + + + + + + + + + + + + + + + + + + + + +
PrevUpHomeNextlibvirt Reference Manual
+

+

-

+

+ +

WARNING: this module is deprecated !

+ +

Author(s):

+
+

Synopsis

+ 
+	    
+
+
+
+

Description

+
+
+

Details

+
+ + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/devhelp/home.png b/docs/devhelp/home.png new file mode 100644 index 0000000000..17003611d9 Binary files /dev/null and b/docs/devhelp/home.png differ diff --git a/docs/devhelp/html.xsl b/docs/devhelp/html.xsl new file mode 100644 index 0000000000..1efcc7c9b1 --- /dev/null +++ b/docs/devhelp/html.xsl @@ -0,0 +1,579 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ( + + void + + + + + + + + + ,
+ + + + + + + + + + ); + + + + + + + + + + typedef + + + + + + + + + + + + ( + + void + + + + + + + + + ,
+ + + + + + + + + + ); + + + + + + + + + + + typedef + + + + + + ; + + + + + + #define + + + ( + + + + , + + + ) + + ; + + + + + + + + + + +
+

Structure

+ 
+     {
+
+    
+      The content of this structure is not made public by the API.
+
+    
+    
+            
+	
+	  
+	
+		
+	
+	
+	  	: 
+	  
+	    
+	  
+	
+	
+
+    
+    } 
+    
+    ;
+
+
+

+ + + +

+ +
+ + + + +
+

Typedef

+ 
+    
+      
+    
+     
+    
+    ;
+
+
+

+ + + +

+ +
+ + + + +
+

Variable

+ 
+    
+      
+    
+     
+    
+    ;
+
+
+

+ + + +

+ +
+ + + + +
+

Enum

+ 
+    enum 
+    
+     {
+
+    
+      
+          
+      
+      
+         = 
+	
+      
+      
+         /* 
+	
+         */
+      
+      
+
+    
+    };
+
+
+

+ + + +

+ +
+ + + + +
+

Macro

+ 
+    #define 
+    
+    
+      (
+      
+        
+	
+	  , 
+	
+      
+      )
+    
+    ;
+
+
+

+ + + +

+ +
+ + + + + + +
: + + + +
+ + + +
+ + + + + + + +
+

()

+ 
+    
+      
+    
+    	
+    
+    
+      	
+    
+    
+      	
+    
+    	(
+    
+      void
+    
+    
+      
+        
+      
+       
+      
+      
+        , 

+	
+	  	
+	
+	
+	  	
+	
+						 
+      
+    
+    )

+    
+
+
+

+ + + +

+ + +
+ + + + + + + + + + + + +
: + + + +
Returns: + + + +
+ +
+ + + + + + + +
+

Function type

+ 
+    
+      
+    
+    	
+    
+    
+      	
+    
+    
+      	
+    
+    	(
+    
+      void
+    
+    
+      
+        
+      
+       
+      
+      
+        , 

+	
+	  	
+	
+	
+	  	
+	
+						 
+      
+    
+    )

+    
+
+
+

+ + + +

+ + +
+ + + + + + + + + + + + +
: + + + +
Returns: + + + +
+ +
+ + + + + + + + + + <xsl:value-of select="concat(@name, ': ', summary)"/> + + + + + + + + + + + + + + + + + +
UpHomeNextlibvirt Reference Manual
+

libvirt API Modules

+

+ + -
+ +

+ + + + + + + + + + + + libvirt Reference Manual + + + + + + + + + + + +
HomeNextlibvirt Reference Manual
+

libvirt Reference Manual

+

Libvir is a C toolkit to interract with the virtualization capabilities of +recent versions of Linux (and other OSes). It is free software available +under the GNU +Lesser General Public License. Virtualization of the Linux Operating +System means the ability to run multiple instances of Operating Systems +concurently on a single hardware system where the basic resources are driven +by a Linux instance. The library aim at providing long term stable C API +initially for the Xen +paravirtualization but should be able to integrate other virtualization +mechanisms if needed.

+

If you get lost searching for some specific API use, try +the online search +engine hosted on libvirt.org +it indexes the project page, the APIs as well as the mailing-list archives.

+ + + + + + + + diff --git a/docs/devhelp/left.png b/docs/devhelp/left.png new file mode 100644 index 0000000000..2d05b3d5b4 Binary files /dev/null and b/docs/devhelp/left.png differ diff --git a/docs/devhelp/right.png b/docs/devhelp/right.png new file mode 100644 index 0000000000..92832e3a45 Binary files /dev/null and b/docs/devhelp/right.png differ diff --git a/docs/devhelp/style.css b/docs/devhelp/style.css new file mode 100644 index 0000000000..c9cabe7830 --- /dev/null +++ b/docs/devhelp/style.css @@ -0,0 +1,66 @@ +.synopsis, .classsynopsis +{ + background: #eeeeee; + border: solid 1px #aaaaaa; + padding: 0.5em; +} +.programlisting +{ + background: #eeeeff; + border: solid 1px #aaaaff; + padding: 0.5em; +} +.variablelist +{ + padding: 4px; + margin-left: 3em; +} +.variablelist td:first-child +{ + vertical-align: top; +} +table.navigation +{ + background: #ffeeee; + border: solid 1px #ffaaaa; + margin-top: 0.5em; + margin-bottom: 0.5em; +} +.navigation a +{ + color: #770000; +} +.navigation a:visited +{ + color: #550000; +} +.navigation .title +{ + font-size: 200%; +} +div.refnamediv +{ + margin-top: 2em; +} +div.gallery-float +{ + float: left; + padding: 10px; +} +div.gallery-float img +{ + border-style: none; +} +div.gallery-spacer +{ + clear: both; +} +a +{ + text-decoration: none; +} +a:hover +{ + text-decoration: underline; + color: #FF0000; +} diff --git a/docs/devhelp/up.png b/docs/devhelp/up.png new file mode 100644 index 0000000000..85b3e2a275 Binary files /dev/null and b/docs/devhelp/up.png differ diff --git a/libvirt.spec.in b/libvirt.spec.in index efb47abc51..6983010020 100644 --- a/libvirt.spec.in +++ b/libvirt.spec.in @@ -77,6 +77,10 @@ rm -fr %{buildroot} %{_libdir}/lib*.so %{_includedir}/libvirt/*.h %{_libdir}/pkgconfig/libvirt.pc +%doc %{_datadir}/gtk-doc/html/libvirt/*.devhelp +%doc %{_datadir}/gtk-doc/html/libvirt/*.html +%doc %{_datadir}/gtk-doc/html/libvirt/*.png +%doc %{_datadir}/gtk-doc/html/libvirt/*.css %doc docs/*.html docs/html docs/*.gif %doc docs/examples