From nobody Wed May 8 17:16:30 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) client-ip=209.132.183.28; envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1567686890; cv=none; d=zoho.com; s=zohoarc; b=gn8eJcdrKl5xaT8E/jrPADDSqHSwGuve+r1eJ/m7CJCvPaGL9Tq7FjKW69dk0l39+z3fIctb5XqV4q2Fxklvkm+qTgs0tUGuR4OcOBLNfn5ynDuGzKAYZom2lR7iCVhLFfTbyFigBVn0tNAgOVpGNW7awNI5KBeHCeumPf7g2RM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1567686890; h=Content-Type:Content-Transfer-Encoding:Date:From:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Sender:Subject:To:ARC-Authentication-Results; bh=bgQ+JG0U/NKllSe12h2c5qs9TABCaXuvQlePNAZvyno=; b=DOkE9CUC8GrKTMCB3hCxiZrxKeE373IjFOSZIxa9gSxcQRnjLndiTPZGCwdOe/HwFjvfInBFo8NiR/zvB2m8Ms8F6ffAfmmjGNEFFZzUjs2Ftsd1ABs+kcFtrHZVCIW4rMRDjIsxvO/uV6TxBS984du5PM1V6XssxjBJCmbPAxg= ARC-Authentication-Results: i=1; mx.zoho.com; spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by mx.zohomail.com with SMTPS id 15676868900731010.6629895096324; Thu, 5 Sep 2019 05:34:50 -0700 (PDT) Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.phx2.redhat.com [10.5.11.22]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id CB7813082124; Thu, 5 Sep 2019 12:34:47 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id C993710002B8; Thu, 5 Sep 2019 12:34:46 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id C8F4324F30; Thu, 5 Sep 2019 12:34:43 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id x85CYffU001869 for ; Thu, 5 Sep 2019 08:34:41 -0400 Received: by smtp.corp.redhat.com (Postfix) id E1A0919C77; Thu, 5 Sep 2019 12:34:41 +0000 (UTC) Received: from dhcp-17-64.lcy.redhat.com (unknown [10.42.17.64]) by smtp.corp.redhat.com (Postfix) with ESMTP id EC74019C6A; Thu, 5 Sep 2019 12:34:38 +0000 (UTC) From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Date: Thu, 5 Sep 2019 13:34:37 +0100 Message-Id: <20190905123437.28294-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23 X-loop: libvir-list@redhat.com Subject: [libvirt] [PATCH] docs: remove devhelp API docs X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.84 on 10.5.11.22 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.42]); Thu, 05 Sep 2019 12:34:48 +0000 (UTC) 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. Signed-off-by: Daniel P. Berrang=C3=A9 Reviewed-by: Pavel Hrdina --- 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 @@ ## . =20 HTML_DIR =3D $(docdir)/html -DEVHELP_DIR=3D$(datadir)/gtk-doc/html/libvirt =20 modules =3D \ libvirt-common \ @@ -50,16 +49,6 @@ apipng =3D \ html/home.png \ html/right.png =20 -devhelphtml =3D \ - devhelp/libvirt.devhelp \ - devhelp/index.html \ - devhelp/general.html \ - $(devhelphtml_generated) - -devhelphtml_generated =3D \ - $(addprefix devhelp/libvirt-,$(addsuffix .html,$(modules))) \ - $(NULL) - css =3D \ generic.css \ libvirt.css \ @@ -84,16 +73,6 @@ fonts =3D \ fonts/overpass-mono-semibold.woff \ fonts/overpass-regular.woff =20 -devhelppng =3D \ - devhelp/home.png \ - devhelp/left.png \ - devhelp/right.png \ - devhelp/up.png - -devhelpcss =3D devhelp/style.css - -devhelpxsl =3D devhelp/devhelp.xsl devhelp/html.xsl - logofiles =3D \ logos/logo-base.svg \ logos/logo-square.svg \ @@ -188,7 +167,6 @@ EXTRA_DIST=3D \ 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/vi= raccessperm.h \ MAINTAINERCLEANFILES =3D \ $(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)/libvir= t-lxc-refs.xml admin_api: $(srcdir)/libvirt-admin-api.xml $(srcdir)/libvirt-admin-refs.xml =20 web: $(dot_html) $(internals_html) $(kbase_html) \ - html/index.html devhelp/index.html + html/index.html =20 hvsupport.html: $(srcdir)/hvsupport.html.in =20 @@ -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 =20 -$(addprefix $(srcdir)/,$(devhelphtml)): $(srcdir)/libvirt-api.xml $(devhel= pxsl) - $(AM_V_GEN)$(XSLTPROC) --stringparam timestamp $(timestamp) \ - --nonet -o $(srcdir)/devhelp/ \ - $(top_srcdir)/docs/devhelp/devhelp.xsl $(srcdir)/libvirt-api.xml - - python_generated_files =3D \ $(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=3D"concat(@name, ': ', summary)"/> - - - - - - - - - - - - - - - - - - - - -
3D"Prev"/3D"Up"/3D"Home"/3D"Next"/libvirt 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 17003611d9..0000000000 Binary files a/docs/devhelp/home.png and /dev/null differ 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 AP=
I.
-
-    
-    
-            
-	
-	  
-	
-		
-	
-	
-	  	: 
-	  
-	    
-	  
-	
-	
-
-    
-    } 
-    
-    ;
-
-
-

- - - -

- -

- - - - -
-

Typedef

- 
-    
-      
-    
-     
-    
-    ;
-
-
-

- - - -

- -
- - - - -
-

Variable - 
-    
-      
-    
-     
-    
-    ;
-
-
-

- - - -

- -

- - - - -
-

Enum

- 
-    enum 
-    
-     {
-
-    
-      
-          
-      
-      
-         =3D 
-	
-      
-      
-         /* 
-	
-         */
-      
-      
-
-    
-    };
-
-
-

- - - -

- -
- - - - -
-

Macro

- 
-    #define 
-    
-    
-      (
-      
-        
-	
-	  , 
-	
-      
-      )
-    
-    ;
-
-
-

- - - -

- -
- - - - - - -
= : - - - -
- - - -
- - - - - - - -
-

()

- 
-    
-      
-    
-    	
-    
-    
-      	
-    
-    
-      	
-    
-    	(
-    
-      void
-    
-    
-      
-        
-      
-       
-      
-      
-        , 

-	
-	  	
-	
-	
-	  	
-	
-						 
-      
-    
-    )

-    
-
-
-

- - - -

- - -
- - - - - - - - - - - - -
= : - - - -
Returns: - - - -
- -
- - - - - - - -
-

Function type

- 
-    
-      
-    
-    	
-    
-    
-      	
-    
-    
-      	
-    
-    	(
-    
-      void
-    
-    
-      
-        
-      
-       
-      
-      
-        , 

-	
-	  	
-	
-	
-	  	
-	
-						 
-      
-    
-    )

-    
-
-
-

- - - -

- - -
- - - - - - - - - - - - -
= : - - - -
Returns: - - - -
- -
- - - - - - - - - - <xsl:value-of select=3D"concat(@name, ': ', summary)"/> - - - - - - - - - - - - - - - - - -
3D"Up"/3D"Home"/3D"Next"/libvirt Reference Manual=
-

libvirt API Modules

-

- - = -
- -

- - - - - - - - - - - - libvirt Reference Manual - - - - - - - - - - - -
3D"Home"/3D"Next"/libvirt 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 dri= ven -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 2d05b3d5b4..0000000000 Binary files a/docs/devhelp/left.png and /dev/null differ diff --git a/docs/devhelp/right.png b/docs/devhelp/right.png deleted file mode 100644 index 92832e3a45..0000000000 Binary files a/docs/devhelp/right.png and /dev/null differ diff --git a/docs/devhelp/style.css b/docs/devhelp/style.css deleted file mode 100644 index dfbb41e34c..0000000000 --- a/docs/devhelp/style.css +++ /dev/null @@ -1,66 +0,0 @@ -.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 deleted file mode 100644 index 85b3e2a275..0000000000 Binary files a/docs/devhelp/up.png and /dev/null differ 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/* =20 -# 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 =20 %dir %attr(0700, root, root) %{_sysconfdir}/libvirt/ --=20 2.21.0 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list