From b38893c3eaa56617a3ef313c45e505da6e509c60 Mon Sep 17 00:00:00 2001 From: Daniel Veillard Date: Wed, 7 Dec 2005 13:45:20 +0000 Subject: [PATCH] * configure.in libvir.spec.in docs/Makefile.am: make sure the docs are installed and packaged in the -devel RPM * docs/api.xsl docs/newapi.xsl: forgot to commit API HTML stylesheets Daniel --- ChangeLog | 6 + configure.in | 11 + docs/Makefile.am | 21 +- docs/api.xsl | 394 ++++++++++++++++++++++++ docs/newapi.xsl | 756 +++++++++++++++++++++++++++++++++++++++++++++++ libvir.spec.in | 5 +- 6 files changed, 1177 insertions(+), 16 deletions(-) create mode 100644 docs/api.xsl create mode 100644 docs/newapi.xsl diff --git a/ChangeLog b/ChangeLog index 3760343c5c..d80e8a38d5 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +Wed Dec 7 14:43:28 CET 2005 Daniel Veillard + + * configure.in libvir.spec.in docs/Makefile.am: make sure the + docs are installed and packaged in the -devel RPM + * docs/api.xsl docs/newapi.xsl: forgot to commit API HTML stylesheets + Wed Dec 7 14:09:48 CET 2005 Karel Zak * include/libvir.h src/libvir.c: adding xenConnectNumOfDomains() to returns number of active domains. diff --git a/configure.in b/configure.in index b31a513e0c..30b12c0b76 100644 --- a/configure.in +++ b/configure.in @@ -50,6 +50,17 @@ test "x$U" != "x" && AC_MSG_ERROR(Compiler not ANSI compliant) AM_PROG_LIBTOOL +dnl Specific dir for HTML output ? +AC_ARG_WITH(html-dir, AC_HELP_STRING([--with-html-dir=path], + [path to base html directory, default $datadir/doc/html]), + [HTML_DIR=$withval], [HTML_DIR='$(datadir)/doc']) + +AC_ARG_WITH(html-subdir, AC_HELP_STRING([--with-html-subdir=path], + [directory used under html-dir, default $PACKAGE-$VERSION/html]), + [test "x$withval" != "x" && HTML_DIR="$HTML_DIR/$withval"], + [HTML_DIR="$HTML_DIR/\$(PACKAGE)-\$(VERSION)/html"]) +AC_SUBST(HTML_DIR) + dnl dnl specific tests to setup DV devel environments with debug etc ... dnl diff --git a/docs/Makefile.am b/docs/Makefile.am index f6c31a69e1..c5d7808e3c 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -57,19 +57,10 @@ maintainer-clean-local: clean-local rebuild: api all -#install-data-local: -# $(mkinstalldirs) $(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 -# $(mkinstalldirs) $(DESTDIR)$(HTML_DIR)/tutorial -# -@INSTALL@ -m 0644 $(srcdir)/tutorial/*.* \ -# $(DESTDIR)$(HTML_DIR)/tutorial -# $(mkinstalldirs) $(DESTDIR)$(HTML_DIR)/tutorial/images -# -@INSTALL@ -m 0644 $(srcdir)/tutorial/images/*.* \ -# $(DESTDIR)$(HTML_DIR)/tutorial/images -# $(mkinstalldirs) $(DESTDIR)$(HTML_DIR)/tutorial/images/callouts -# -@INSTALL@ -m 0644 $(srcdir)/tutorial/images/callouts/*.* \ -# $(DESTDIR)$(HTML_DIR)/tutorial/images/callouts +install-data-local: + $(mkinstalldirs) $(DESTDIR)$(HTML_DIR) + -@INSTALL@ -m 0644 $(srcdir)/libvir.html $(srcdir)/FAQ.html $(srcdir)/redhat.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/api.xsl b/docs/api.xsl new file mode 100644 index 0000000000..b414f4e49c --- /dev/null +++ b/docs/api.xsl @@ -0,0 +1,394 @@ + + + + + + + + + + + + + + + + + + +
+ + + +

Type :

+

+ + + + + +

+ + +

Letter :

+

+ + + + + +

+ + +

Module :

+

+ + + + + +

+ + +

Letter :

+
+ +
+
+ + + + + +
+ +
+ + + + Generating API Constructors + List of constructors for + + + + + + + + + + + + + + + + +
+ + + + + +
+ + + + + + +
+ + + + +
+ + + + +
+ +

Daniel Veillard

+
+
+
+
+
+ + + + + + Generating API List of synbols per file + List of Symbols per Module for + + + + + + + + + + + + + + + + +
+ + + + + +
+ + + + + + +
+ + + + +
+ + + + +
+ +

Daniel Veillard

+
+
+
+
+
+ + + + + + Generating API Functions by Type + List of function manipulating types in + + + + + + + + + + + + + + + + +
+ + + + + +
+ + + + + + +
+ + + + +
+ + + + +
+ +

Daniel Veillard

+
+
+
+
+
+ + + + + + Generating API Alphabetic list + Alphabetic List of Symbols in + + + + + + + + + + + + + + + + +
+ + + + + +
+ + + + + + +
+ + + + +
+ + + + +
+ +

Daniel Veillard

+
+
+
+
+
+ + + + + +

+ + + + + + + + + +

+ + + + + + + + API Alphabetic Index for + + + + + + + + + + + + + + + + +
+ + + + + +
+ + + + + + +
+ + + + +
+ + + + +
+ + + +

Daniel Veillard

+
+
+
+
+
+ + + + + + + Generating API Index + + + + + Generating API Cross References + + + + + + + + + + + + diff --git a/docs/newapi.xsl b/docs/newapi.xsl new file mode 100644 index 0000000000..d6e350304b --- /dev/null +++ b/docs/newapi.xsl @@ -0,0 +1,756 @@ + + + + + + + + + + + + + + + html + ../ + + + API Menu + +
+ + +
+ + + + + + + +
+ + + + + + + +
+
+ +
+
+ +
+ + + + + + + +
+
+ API Indexes +
+
+ +
+ + + + + + + +
+
+ Related links +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + +
PrevUpAPI documentationHomeThe XML C parser and toolkit of GnomeNext
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 
+    #define 
+
+ + + + 
+    Variable 
+    
+      
+    
+     
+    
+    
+    
+
+
+
+ + + + + 
+    
+      
+	Enum 
+	
+	
+
+      
+      
+	Typedef 
+	
+	  
+	
+	 
+	
+	
+
+      
+    
+
+ + + + +

Enum

+ 
+      Enum 
+      
+       {
+
+      
+        
+            
+        
+         = 
+        
+        
+	   : 
+	  
+	    
+	  
+        
+        
+
+      
+      }
+
+
+ + + + 
+    Structure 

+    
+
+    
+      The content of this structure is not made public by the API.
+
+    
+
+ + + +

Structure

+ 
+    Structure 

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

Macro:

+ 
#define
+

+ + + +

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

+	
+	  	
+	
+	
+	  	
+	
+						 
+      
+    
+    )
+
+ + + + + + + + + 
+    Function type: 
+    
+    
+
+    
+      
+    
+    	
+    
+    
+      	
+    
+    
+      	
+    
+    	(
+    
+      void
+    
+    
+      
+        
+      
+       
+      
+      
+        , 

+	
+	  	
+	
+	
+	  	
+	
+						 
+      
+    
+    )
+
+
+ + + + + + + + + +

+ + Function type: + +

+ 
+    Function type: 
+    
+    
+
+    
+      
+    
+    	
+    
+    
+      	
+    
+    
+      	
+    
+    	(
+    
+      void
+    
+    
+      
+        
+      
+       
+      
+      
+        , 

+	
+	  	
+	
+	
+	  	
+	
+						 
+      
+    
+    )
+
+
+

+ + + +

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

Function:

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

+	
+	  	
+	
+	
+	  	
+	
+						 
+      
+    
+    )

+    
+
+
+

+ + + +

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

This module is deprecated

+ + +

+ + + + + + + + + + + + + + + + + + + + + + + + + Module from + + + + + + <xsl:value-of select="$title"/> + + + + + + + + + +
+ + + + + +
+ + + + + + +
+ + + + +
+ + + + +
+ + + + +
+

Table of Contents

+ +

Description

+ + + +
+ + +

Table of Contents

+ + + + + + + + + + + + + + + +

Description

+ + + + + + + + + + + + + + + + + + + +

Daniel Veillard

+
+
+
+
+
+ + + + + + + +
  • + + : + +
    • +     + + + + Reference Manual for + + + + + + <xsl:value-of select="$title"/> + + + + + + + + + +
    + + + + + +
    + + + + + + +
    + + + + +
    + + + + +
    +

    Table of Contents

    +
      + +
    +

    Daniel Veillard

    +
    +
    +
    +
    +
    + + +     +     + + + + + + + + + + + + + + +     diff --git a/libvir.spec.in b/libvir.spec.in index 9c6a397a57..74edfce53a 100644 --- a/libvir.spec.in +++ b/libvir.spec.in @@ -6,7 +6,7 @@ License: LGPL Group: Development/Libraries Source: libvir-%{version}.tar.gz BuildRoot: %{_tmppath}/%{name}-%{version}-root -URL: http://www.gnome.org/~veillard/gamin/ +URL: http://libvir.org/ BuildRequires: xen Requires: xen @@ -57,6 +57,9 @@ rm -fr %{buildroot} %{_includedir}/libvir/*.h %{_libdir}/pkgconfig/libvir.pc +%doc docs/*.html docs/html docs/*.gif +%doc docs/libvir-api.xml + %changelog * Wed Nov 2 2005 Daniel Veillard 0.0.1-1 - created