From 926b7b6e6c927bf2d82511c29d6ab93be0436788 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= Date: Thu, 5 Sep 2019 13:07:59 +0100 Subject: [PATCH] docs: remove devhelp API docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit We currently generate two completely separate API references for the libvirt public API. One at 'docs/html/' and one at 'docs/devhelp/'. Both are published on the website, but we only link to content in the 'docs/html/' pages. Both are installed in the libvirt-docs sub-RPM, with a full copy of the website including 'docs/html/' in /usr/share/docs/libvirt-docs, while the 'docs/devhelp/' content goes to /usr/share/gtk-doc/. The latter was broken for years until: commit ca6f602546cb28658db05f29bc840e04d22d0947 Author: Andrea Bolognani Date: Fri May 10 14:54:52 2019 +0200 docs: Introduce $(devhelphtml_generated) Our XSLT magic generates one Devhelp-compatible HTML file per documentation module, but so far we have only shipped and installed documentation for virterror. Now that we have $(modules), however, we can generate the list of files the same way we do for regular documentation and make sure we always ship and install everything. That this bug went unnoticed for so long is a sign of how few people are using the devhelp docs. The only commits to the devhelp code since it was first introduced have been fixing various build problems that hit. The only obvious difference between the two sets of docs is the CSS styling in use. Overall devhelp does not look compelling enough to justify having two duplicated sets of API docs. Eliminating it will reduce the amount of XSL code we are carrying in the tree which is an attractive benefit. Reviewed-by: Pavel Hrdina Reviewed-by: Andrea Bolognani Signed-off-by: Daniel P. Berrangé --- docs/Makefile.am | 38 +-- docs/devhelp/devhelp.xsl | 131 --------- docs/devhelp/home.png | Bin 654 -> 0 bytes docs/devhelp/html.xsl | 573 --------------------------------------- docs/devhelp/left.png | Bin 459 -> 0 bytes docs/devhelp/right.png | Bin 472 -> 0 bytes docs/devhelp/style.css | 66 ----- docs/devhelp/up.png | Bin 406 -> 0 bytes libvirt.spec.in | 8 - 9 files changed, 1 insertion(+), 815 deletions(-) delete mode 100644 docs/devhelp/devhelp.xsl delete mode 100644 docs/devhelp/home.png delete mode 100644 docs/devhelp/html.xsl delete mode 100644 docs/devhelp/left.png delete mode 100644 docs/devhelp/right.png delete mode 100644 docs/devhelp/style.css delete mode 100644 docs/devhelp/up.png diff --git a/docs/Makefile.am b/docs/Makefile.am index 1cdb584b0b..7a5d3450fc 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -17,7 +17,6 @@ ## . HTML_DIR = $(docdir)/html -DEVHELP_DIR=$(datadir)/gtk-doc/html/libvirt modules = \ libvirt-common \ @@ -50,16 +49,6 @@ apipng = \ html/home.png \ html/right.png -devhelphtml = \ - devhelp/libvirt.devhelp \ - devhelp/index.html \ - devhelp/general.html \ - $(devhelphtml_generated) - -devhelphtml_generated = \ - $(addprefix devhelp/libvirt-,$(addsuffix .html,$(modules))) \ - $(NULL) - css = \ generic.css \ libvirt.css \ @@ -84,16 +73,6 @@ fonts = \ fonts/overpass-mono-semibold.woff \ fonts/overpass-regular.woff -devhelppng = \ - devhelp/home.png \ - devhelp/left.png \ - devhelp/right.png \ - devhelp/up.png - -devhelpcss = devhelp/style.css - -devhelpxsl = devhelp/devhelp.xsl devhelp/html.xsl - logofiles = \ logos/logo-base.svg \ logos/logo-square.svg \ @@ -188,7 +167,6 @@ EXTRA_DIST= \ site.xsl subsite.xsl newapi.xsl page.xsl \ wrapstring.xsl \ $(dot_html) $(dot_html_in) $(gif) $(apihtml) $(apipng) \ - $(devhelphtml) $(devhelppng) $(devhelpcss) $(devhelpxsl) \ $(xml) $(qemu_xml) $(lxc_xml) $(admin_xml) $(fig) $(png) $(css) \ $(javascript) $(logofiles) \ $(internals_html_in) $(internals_html) $(fonts) \ @@ -206,7 +184,6 @@ $(srcdir)/aclperms.htmlinc: $(top_srcdir)/src/access/viraccessperm.h \ MAINTAINERCLEANFILES = \ $(addprefix $(srcdir)/,$(dot_html)) \ $(addprefix $(srcdir)/,$(apihtml)) \ - $(addprefix $(srcdir)/,$(devhelphtml)) \ $(addprefix $(srcdir)/,$(internals_html)) \ $(addprefix $(srcdir)/,$(kbase_html)) \ $(srcdir)/hvsupport.html.in $(srcdir)/aclperms.htmlinc @@ -226,7 +203,7 @@ lxc_api: $(srcdir)/libvirt-lxc-api.xml $(srcdir)/libvirt-lxc-refs.xml admin_api: $(srcdir)/libvirt-admin-api.xml $(srcdir)/libvirt-admin-refs.xml web: $(dot_html) $(internals_html) $(kbase_html) \ - html/index.html devhelp/index.html + html/index.html hvsupport.html: $(srcdir)/hvsupport.html.in @@ -284,12 +261,6 @@ html/index.html: libvirt-api.xml newapi.xsl page.xsl $(APIBUILD_STAMP) $(srcdir)/newapi.xsl $(srcdir)/libvirt-api.xml && \ $(XMLLINT) --nonet --noout $(srcdir)/html/*.html -$(addprefix $(srcdir)/,$(devhelphtml)): $(srcdir)/libvirt-api.xml $(devhelpxsl) - $(AM_V_GEN)$(XSLTPROC) --stringparam timestamp $(timestamp) \ - --nonet -o $(srcdir)/devhelp/ \ - $(top_srcdir)/docs/devhelp/devhelp.xsl $(srcdir)/libvirt-api.xml - - python_generated_files = \ $(srcdir)/html/libvirt-libvirt-lxc.html \ $(srcdir)/html/libvirt-libvirt-qemu.html \ @@ -388,10 +359,6 @@ install-data-local: $(mkinstalldirs) $(DESTDIR)$(HTML_DIR)/kbase for f in $(kbase_html); do \ $(INSTALL) -m 0644 $(srcdir)/$$f $(DESTDIR)$(HTML_DIR)/kbase; done - $(mkinstalldirs) $(DESTDIR)$(DEVHELP_DIR) - for file in $(devhelphtml) $(devhelppng) $(devhelpcss); do \ - $(INSTALL) -m 0644 $(srcdir)/$${file} $(DESTDIR)$(DEVHELP_DIR) ; \ - done $(mkinstalldirs) $(DESTDIR)$(HTML_DIR)/fonts for f in $(fonts); do \ $(INSTALL) -m 0644 $(srcdir)/$$f $(DESTDIR)$(HTML_DIR)/fonts; \ @@ -415,6 +382,3 @@ uninstall-local: for f in $(kbase_html); do \ rm -f $(DESTDIR)$(HTML_DIR)/$$f; \ done - for f in $(devhelphtml) $(devhelppng) $(devhelpcss); do \ - rm -f $(DESTDIR)$(DEVHELP_DIR)/$$(basename $$f); \ - done diff --git a/docs/devhelp/devhelp.xsl b/docs/devhelp/devhelp.xsl deleted file mode 100644 index 17a980c73a..0000000000 --- a/docs/devhelp/devhelp.xsl +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - <xsl:value-of select="concat(@name, ': ', summary)"/> - - - - - - - - - - - - - - - - - - - - -
PrevUpHomeNextlibvirt Reference Manual
-

-

-

-

- -

WARNING: this module is deprecated !

- -
-

Synopsis

- 
-	    
-
-
-
-

Description

-
-
-

Details

-
- - - - - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/devhelp/home.png b/docs/devhelp/home.png deleted file mode 100644 index 17003611d9df2b066afc682cbde962f3a575002d..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 654 zcmV;90&)F`P)~yY zO1cF+0vxb!W?!x?K+*#62Jq)nA4q`)5S6sgX4ao{=)(Mgq+YMr)7sjak|a^9)zS!j zlk{-n29mabXYF=7SYBQx&vO8xC}MYams+hxqtO7sImhPaCf@rq;I^3!#u*2aUP)55 zT2&N90xmEJ0s&fGT~(T<3d2xYmK9C>IP*x-M@ib*+0pFm>>uW37N2Wzaq-fCnIZE9 zpb8}0+uN+KuQM2oZVHfP8U6kQdo3?>Wo2dT)WeM9So8DqhLi#T0 z-i(>mfjhvbsYV`;4sgfJ-p>G-SqJ!fjR6BQYs1h*y9xaN0l{VB;o%`08yiy@)$8@~ z2PD1gcDuiy;j1tR0v#V8OH%W)25-YKyx(j#IXO9*YWf0mb8}QG6@b@;cHxh9{t7+@ o!Yd`f8L$sLH?yBt^q3C6015TtIu@BS5dZ)H07*qoM6N<$f*igdr~m)} diff --git a/docs/devhelp/html.xsl b/docs/devhelp/html.xsl deleted file mode 100644 index 587cbfc1a9..0000000000 --- a/docs/devhelp/html.xsl +++ /dev/null @@ -1,573 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ( - - 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 interact 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 -concurrently 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.

- - - - - - diff --git a/docs/devhelp/left.png b/docs/devhelp/left.png deleted file mode 100644 index 2d05b3d5b4aeec9384bbfe404bfc4ed0897051c4..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 459 zcmV;+0W|)JP)40xL?wO*>WZ(J#ML5j2<9jD6A%Q&kC}jOeEc;X{s;`zcnxLeZR6?6h#^ihmNF6NpGdilO$m<82oD9WQ|6nVv1`? z>KufRi{?QPXg;4;wroQu4?mN1Ydd@|kaQ|ZyWLK!)yi7Wb%=0{}lD)tfliHAUyWRQ+fD_;aV6j->y6!O_8bENg6P)Cd4HCN^TYHBC0dz3r5|}*T3c5!K}0^NPTey!^rYo;W&eW{b1SE%dR-1ljcju- zJITo5P_e{cPDWDszO|97o#m$fni3V4d%~7^?0HU4-k!+X`e~w55Q}HA=c?CM9`EK` z^o5GF_RsnG`ey+9wOf8O4bzg>7W*;jU~M?g`OZAA$mNp|Lz<$s+~N9!2`ir8RcClo$(Q~19INM~9}j;&*|enC yGd}kJak0wj?aUKd8;%}`i}SSew>!A-2iw}^5}Rh(M>+vRkipZ{&t;ucLK6U4uc96R diff --git a/libvirt.spec.in b/libvirt.spec.in index dde8bf3a97..d4d2ec8db9 100644 --- a/libvirt.spec.in +++ b/libvirt.spec.in @@ -1528,14 +1528,6 @@ exit 0 %doc AUTHORS ChangeLog.gz NEWS README README.md %doc libvirt-docs/* -# API docs -%dir %{_datadir}/gtk-doc/html/libvirt/ -%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 - - %files daemon %dir %attr(0700, root, root) %{_sysconfdir}/libvirt/