[libvirt] [PATCH 2/3] Docs for usage of new command APIs

Daniel P. Berrange berrange at redhat.com
Tue May 25 13:24:51 UTC 2010


---
 docs/Makefile.am       |   12 ++++++++++--
 docs/internals.html.in |    9 +++++++++
 docs/sitemap.html.in   |    4 ++++
 3 files changed, 23 insertions(+), 2 deletions(-)

diff --git a/docs/Makefile.am b/docs/Makefile.am
index 70b9e51..24519fd 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -53,7 +53,7 @@ gif = \
   architecture.gif \
   node.gif
 
-dot_html_in = $(wildcard *.html.in)
+dot_html_in = $(wildcard *.html.in) $(wildcard internals/*.html.in)
 dot_html = $(dot_html_in:%.html.in=%.html)
 
 patches = $(wildcard api_extension/*.patch)
@@ -71,7 +71,7 @@ fig = \
 
 EXTRA_DIST=					\
   libvirt-api.xml libvirt-refs.xml apibuild.py	\
-  site.xsl newapi.xsl news.xsl page.xsl	ChangeLog.xsl	\
+  site.xsl subsite.xsl newapi.xsl news.xsl page.xsl	ChangeLog.xsl	\
   $(dot_html) $(dot_html_in) $(gif) $(apihtml) $(apipng) \
   $(devhelphtml) $(devhelppng) $(devhelpcss) $(devhelpxsl) \
   $(xml) $(fig) $(png) \
@@ -100,6 +100,14 @@ ChangeLog.html.in: ChangeLog.xml ChangeLog.xsl
 %.png: %.fig
 	convert -rotate 90 $< $@
 
+internals/%.html.tmp: internals/%.html.in subsite.xsl page.xsl sitemap.html.in
+	@if [ -x $(XSLTPROC) ] ; then \
+	  echo "Generating $@"; \
+	  name=`echo $@ | sed -e 's/.tmp//'`; \
+	  $(XSLTPROC) --stringparam pagename $$name --nonet --html \
+	    $(top_srcdir)/docs/subsite.xsl $< > $@ \
+	    || { rm $@ && exit 1; }; fi
+
 %.html.tmp: %.html.in site.xsl page.xsl sitemap.html.in
 	@if [ -x $(XSLTPROC) ] ; then \
 	  echo "Generating $@"; \
diff --git a/docs/internals.html.in b/docs/internals.html.in
index d39098e..dc88eab 100644
--- a/docs/internals.html.in
+++ b/docs/internals.html.in
@@ -7,5 +7,14 @@
       internals, adding new public APIs, new hypervisor drivers or extending
       the libvirtd daemon code.
     </p>
+
+    <ul>
+      <li>Introduction to basic rules and guidelines for <a href="hacking.html">hacking<a>
+	    on libvirt code</li>
+      <li>Guide to adding <a href="api_extension.html">public APIs<a></li>
+      <li>Approach for <a href="internals/command.html">spawning commands</a> from
+	libvirt driver code</li>
+    </ul>
+
   </body>
 </html>
diff --git a/docs/sitemap.html.in b/docs/sitemap.html.in
index 0117c8d..0615bc0 100644
--- a/docs/sitemap.html.in
+++ b/docs/sitemap.html.in
@@ -246,6 +246,10 @@
                 <a href="api_extension.html">API extensions</a>
                 <span>Adding new public libvirt APIs</span>
               </li>
+              <li>
+                <a href="internals/command.html">Spawning commands</a>
+                <span>Spawning commands from libvirt driver code</span>
+              </li>
             </ul>
           </li>
         </ul>
-- 
1.6.6.1




More information about the libvir-list mailing list