[PATCH 08/13] Add XML files with admin API specification

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



No online docs are build from it since it doesn't really fit into our
document structure and new page will need to be created for it, but this
is at least a heads-up commit for easier parsing in order to build some
documentation (or python bindings) later on.

Signed-off-by: Martin Kletzander <mkletzan@xxxxxxxxxx>
---
 .gitignore       |  1 +
 docs/Makefile.am | 23 +++++++++++++++++++----
 docs/apibuild.py | 10 +++++++++-
 libvirt.spec.in  |  1 +
 4 files changed, 30 insertions(+), 5 deletions(-)

diff --git a/.gitignore b/.gitignore
index e5e0788..0b40f4a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -69,6 +69,7 @@
 /docs/apibuild.py.stamp
 /docs/devhelp/libvirt.devhelp
 /docs/hvsupport.html.in
+/docs/libvirt-admin-*.xml
 /docs/libvirt-api.xml
 /docs/libvirt-lxc-*.xml
 /docs/libvirt-qemu-*.xml
diff --git a/docs/Makefile.am b/docs/Makefile.am
index f43da93..b7b49cb 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -1,6 +1,6 @@
 ## Process this file with automake to produce Makefile.in

-## Copyright (C) 2005-2014 Red Hat, Inc.
+## Copyright (C) 2005-2015 Red Hat, Inc.
 ##
 ## This library is free software; you can redistribute it and/or
 ## modify it under the terms of the GNU Lesser General Public
@@ -128,8 +128,16 @@ lxc_xml = \
   libvirt-lxc-api.xml \
   libvirt-lxc-refs.xml

+admin_xml = \
+  libvirt-admin-api.xml \
+  libvirt-admin-refs.xml
+
 apidir = $(pkgdatadir)/api
-api_DATA = libvirt-api.xml libvirt-qemu-api.xml libvirt-lxc-api.xml
+api_DATA = \
+       libvirt-api.xml \
+       libvirt-qemu-api.xml \
+       libvirt-lxc-api.xml \
+       libvirt-admin-api.xml

 fig = \
   libvirt-net-logical.fig \
@@ -149,7 +157,7 @@ EXTRA_DIST=					\
   hacking1.xsl hacking2.xsl wrapstring.xsl \
   $(dot_html) $(dot_html_in) $(gif) $(apihtml) $(apipng) \
   $(devhelphtml) $(devhelppng) $(devhelpcss) $(devhelpxsl) \
-  $(xml) $(qemu_xml) $(lxc_xml) $(fig) $(png) $(css) \
+  $(xml) $(qemu_xml) $(lxc_xml) $(admin_xml) $(fig) $(png) $(css) \
   $(patches) $(dot_php_in) $(dot_php_code_in) $(dot_php)\
   $(internals_html_in) $(internals_html) \
   sitemap.html.in aclperms.htmlinc \
@@ -174,6 +182,7 @@ all-am: web
 api: $(srcdir)/libvirt-api.xml $(srcdir)/libvirt-refs.xml
 qemu_api: $(srcdir)/libvirt-qemu-api.xml $(srcdir)/libvirt-qemu-refs.xml
 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) html/index.html devhelp/index.html \
   $(dot_php)
@@ -274,6 +283,7 @@ $(addprefix $(srcdir)/,$(devhelphtml)): $(srcdir)/libvirt-api.xml $(devhelpxsl)
 python_generated_files = \
 		$(srcdir)/html/libvirt-libvirt-lxc.html \
 		$(srcdir)/html/libvirt-libvirt-qemu.html \
+		$(srcdir)/html/libvirt-libvirt-admin.html \
 		$(srcdir)/html/libvirt-virterror.html \
 		$(srcdir)/libvirt-api.xml \
 		$(srcdir)/libvirt-refs.xml \
@@ -281,6 +291,8 @@ python_generated_files = \
 		$(srcdir)/libvirt-lxc-refs.xml \
 		$(srcdir)/libvirt-qemu-api.xml \
 		$(srcdir)/libvirt-qemu-refs.xml \
+		$(srcdir)/libvirt-admin-api.xml \
+		$(srcdir)/libvirt-admin-refs.xml \
 		$(NULL)

 APIBUILD=$(srcdir)/apibuild.py
@@ -304,10 +316,12 @@ $(APIBUILD_STAMP): $(srcdir)/apibuild.py \
 		$(top_srcdir)/include/libvirt/libvirt-stream.h \
 		$(top_srcdir)/include/libvirt/libvirt-lxc.h \
 		$(top_srcdir)/include/libvirt/libvirt-qemu.h \
+		$(top_srcdir)/include/libvirt/libvirt-admin.h \
 		$(top_srcdir)/include/libvirt/virterror.h \
 		$(top_srcdir)/src/libvirt.c \
 		$(top_srcdir)/src/libvirt-lxc.c \
 		$(top_srcdir)/src/libvirt-qemu.c \
+		$(top_srcdir)/src/libvirt-admin.c \
 		$(top_srcdir)/src/util/virerror.c \
 		$(top_srcdir)/src/util/virevent.c \
 		$(top_srcdir)/src/util/virtypedparam.c
@@ -326,9 +340,10 @@ maintainer-clean-local: clean-local
 		todo.html.in
 	rm -rf $(srcdir)/libvirt-qemu-api.xml $(srcdir)/libvirt-qemu-refs.xml
 	rm -rf $(srcdir)/libvirt-lxc-api.xml $(srcdir)/libvirt-lxc-refs.xml
+	rm -rf $(srcdir)/libvirt-admin-api.xml $(srcdir)/libvirt-admin-refs.xml
 	rm -rf $(APIBUILD_STAMP)

-rebuild: api qemu_api lxc_api all
+rebuild: api qemu_api lxc_api admin_api all

 install-data-local:
 	$(mkinstalldirs) $(DESTDIR)$(HTML_DIR)
diff --git a/docs/apibuild.py b/docs/apibuild.py
index 9fa9361..95e9f27 100755
--- a/docs/apibuild.py
+++ b/docs/apibuild.py
@@ -59,6 +59,11 @@ lxc_included_files = {
   "libvirt-lxc.c": "Implementations for the LXC specific APIs",
 }

+admin_included_files = {
+  "libvirt-admin.h": "header with admin specific API definitions",
+  "libvirt-admin.c": "Implementations for the admin specific APIs",
+}
+
 ignored_words = {
   "ATTRIBUTE_UNUSED": (0, "macro keyword"),
   "ATTRIBUTE_SENTINEL": (0, "macro keyword"),
@@ -2018,6 +2023,8 @@ class docBuilder:
             self.includes = includes + qemu_included_files.keys()
         elif name == "libvirt-lxc":
             self.includes = includes + lxc_included_files.keys()
+        elif name == "libvirt-admin":
+            self.includes = includes + admin_included_files.keys()
         self.modules = {}
         self.headers = {}
         self.idx = index()
@@ -2551,7 +2558,7 @@ class docBuilder:


 def rebuild(name):
-    if name not in ["libvirt", "libvirt-qemu", "libvirt-lxc"]:
+    if name not in ["libvirt", "libvirt-qemu", "libvirt-lxc", "libvirt-admin"]:
         self.warning("rebuild() failed, unknown module %s") % name
         return None
     builder = None
@@ -2595,6 +2602,7 @@ if __name__ == "__main__":
         rebuild("libvirt")
         rebuild("libvirt-qemu")
         rebuild("libvirt-lxc")
+        rebuild("libvirt-admin")
     if warnings > 0:
         sys.exit(2)
     else:
diff --git a/libvirt.spec.in b/libvirt.spec.in
index afcfe31..b00f99b 100644
--- a/libvirt.spec.in
+++ b/libvirt.spec.in
@@ -2313,6 +2313,7 @@ exit 0
 %{_datadir}/libvirt/api/libvirt-api.xml
 %{_datadir}/libvirt/api/libvirt-qemu-api.xml
 %{_datadir}/libvirt/api/libvirt-lxc-api.xml
+%{_datadir}/libvirt/api/libvirt-admin-api.xml

 %doc docs/*.html docs/html docs/*.gif
 %doc docs/libvirt-api.xml
-- 
2.4.0

--
libvir-list mailing list
libvir-list@xxxxxxxxxx
https://www.redhat.com/mailman/listinfo/libvir-list




[Index of Archives]     [Virt Tools]     [Libvirt Users]     [Lib OS Info]     [Fedora Users]     [Fedora Desktop]     [Fedora SELinux]     [Big List of Linux Books]     [Yosemite News]     [KDE Users]     [Fedora Tools]