[libvirt] [PATCH 3/4] api: Generate docs for libvirt-common.h

Peter Krempa pkrempa at redhat.com
Thu Apr 21 12:53:41 UTC 2016


Since commit f5d9c5d00cfc0c moved the virTypedParam stuff into
libvirt-common we did not generate any docs for them and neither
populated them into libvirt-api.xml. This broke the sanity check in
libvirt python. Fix it by generating docs for libvirt-common.h too.
---
 docs/Makefile.am     | 1 +
 docs/apibuild.py     | 1 +
 docs/sitemap.html.in | 4 ++++
 3 files changed, 6 insertions(+)

diff --git a/docs/Makefile.am b/docs/Makefile.am
index 9524c94..3ca53a4 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -28,6 +28,7 @@ apihtml =					\
   $(apihtml_generated)

 apihtml_generated = \
+  html/libvirt-libvirt-common.html		\
   html/libvirt-libvirt-domain.html		\
   html/libvirt-libvirt-domain-snapshot.html	\
   html/libvirt-libvirt-event.html		\
diff --git a/docs/apibuild.py b/docs/apibuild.py
index 9e63270..9c82c4a 100755
--- a/docs/apibuild.py
+++ b/docs/apibuild.py
@@ -21,6 +21,7 @@ debugsym=None
 # C parser analysis code
 #
 included_files = {
+  "libvirt-common.h": "header with general libvirt API definitions",
   "libvirt-domain.h": "header with general libvirt API definitions",
   "libvirt-domain-snapshot.h": "header with general libvirt API definitions",
   "libvirt-event.h": "header with general libvirt API definitions",
diff --git a/docs/sitemap.html.in b/docs/sitemap.html.in
index 22e410c..d5cf723 100644
--- a/docs/sitemap.html.in
+++ b/docs/sitemap.html.in
@@ -305,6 +305,10 @@
             -->
             <ul>
               <li>
+                <a href="html/libvirt-libvirt-common.html">Common</a>
+                <span>common APIs for the libvirt library</span>
+              </li>
+              <li>
                 <a href="html/libvirt-libvirt-domain.html">Domain</a>
                 <span>domain APIs for the libvirt library</span>
               </li>
-- 
2.8.1




More information about the libvir-list mailing list