Attachment 15572 Details for Bug 13495 – add devhelp support and install/uninstall

[patch] add devhelp support and install/uninstall

0001-Add-devhelp-support.patch (text/plain), 6.25 KB, created by Marc-Andre Lureau on 2008-03-30 09:28:33 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Marc-Andre Lureau

Created: 2008-03-30 09:28:33 UTC

Size: 6.25 KB

patch

obsolete

>From 39b2d9248153bceaaea32c6d3b14f8141ad5e55d Mon Sep 17 00:00:00 2001
>From: Marc-Andre Lureau <marcandre.lureau@gmail.com>
>Date: Sun, 30 Mar 2008 19:04:55 +0300
>Subject: [PATCH] Add devhelp support
>
>---
> Doxyfile.in                |    2 +-
> doc/Makefile.am            |   82 +++++++++++++++++++++++++++++++++++++++----
> doc/doxygen_to_devhelp.xsl |   48 +++++++++++++++++++++++++
> 3 files changed, 123 insertions(+), 9 deletions(-)
> create mode 100644 doc/doxygen_to_devhelp.xsl
>
>diff --git a/Doxyfile.in b/Doxyfile.in
>index 80ee0d0..afac639 100644
>--- a/Doxyfile.in
>+++ b/Doxyfile.in
>@@ -133,7 +133,7 @@ MAN_LINKS              = YES
> #---------------------------------------------------------------------------
> # configuration options related to the XML output
> #---------------------------------------------------------------------------
>-GENERATE_XML           = NO
>+GENERATE_XML           = YES
> #---------------------------------------------------------------------------
> # Configuration options related to the preprocessor   
> #---------------------------------------------------------------------------
>diff --git a/doc/Makefile.am b/doc/Makefile.am
>index e1c8e4d..ad5ac83 100644
>--- a/doc/Makefile.am
>+++ b/doc/Makefile.am
>@@ -1,3 +1,5 @@
>+all-local: $(HTML_FILES) $(HTML_INDEX) $(devhelp_file)
>+
> EXTRA_DIST= 					\
> 	busconfig.dtd				\
> 	introspect.dtd				\
>@@ -7,19 +9,16 @@ EXTRA_DIST= 					\
> 	dbus-tutorial.xml			\
> 	dcop-howto.txt				\
> 	file-boilerplate.c			\
>-	introspect.xsl
>+	introspect.xsl				\
>+	doxygen_to_devhelp.xsl
> 
>+if DBUS_XML_DOCS_ENABLED
> HTML_FILES=					\
> 	dbus-faq.html				\
> 	dbus-specification.html			\
> 	dbus-test-plan.html			\
> 	dbus-tutorial.html
> 
>-if DBUS_XML_DOCS_ENABLED
>-all-local: $(HTML_FILES)
>-
>-EXTRA_DIST += $(HTML_FILES) system-activation.txt
>-
> dbus-specification.html: dbus-specification.xml
> 	$(XMLTO) html-nochunks $<
> 
>@@ -32,7 +31,74 @@ dbus-tutorial.html: dbus-tutorial.xml
> dbus-faq.html: dbus-faq.xml
> 	$(XMLTO) html-nochunks $<
> 
>+install-doc: $(HTML_FILES)
>+	@$(NORMAL_INSTALL)
>+	$(mkinstalldirs) $(DESTDIR)$(docdir)
>+	$(INSTALL_DATA) $(HTML_FILES) $(DESTDIR)$(docdir)/$$f
>+
>+uninstall-doc:
>+	@$(NORMAL_UNINSTALL)
>+	-(cd $(DESTDIR)$(docdir)/ && rm -f $(HTML_FILES))
> endif
> 
>-maintainer-clean-local:
>-	rm -f $(HTML_FILES)
>+if DBUS_DOXYGEN_DOCS_ENABLED
>+
>+doxygen_configfile = Doxyfile
>+doxygen_configfile_source = $(top_srcdir)/Doxyfile.in
>+
>+devhelp_file = ${PACKAGE_TARNAME}.devhelp
>+devhelp_stylesheet = $(srcdir)/doxygen_to_devhelp.xsl
>+
>+referencedir = $(docdir)/reference/html
>+devhelpdir = $(datadir)/devhelp/books/${PACKAGE_TARNAME}
>+
>+HTML_INDEX=api/html/index.html
>+XML_INDEX=api/xml/index.xml
>+
>+# Build a DevHelp reference from the doxygen xml
>+$(devhelp_file): $(XML_INDEX) $(devhelp_stylesheet)
>+	xsltproc --stringparam book_title "${PACKAGE_NAME} Reference Manual" \
>+		--stringparam book_name "${PACKAGE_NAME}" \
>+		--stringparam reference_prefix "../../../doc/${PACKAGE_NAME}/reference/html" \
>+		--stringparam docdir "../../../doc/${PACKAGE_NAME}" \
>+		-o $@ $(devhelp_stylesheet) $(XML_INDEX)
>+
>+$(HTML_INDEX) $(XML_INDEX): $(doxygen_configfile_source) $(beautify_docs_source) $(top_srcdir)/dbus/*.h
>+	-rm -rf api
>+	(cd .. && $(DOXYGEN) $(doxygen_configfile))
>+	touch $@
>+
>+install-reference: $(HTML_INDEX) $(devhelp_file)
>+	@$(NORMAL_INSTALL)
>+	$(mkinstalldirs) $(DESTDIR)$(referencedir)
>+	@dir='$(<D)'; for p in $$dir/*.html $$dir/*.css $$dir/*.png ; do \
>+	  f="`echo $$p | sed -e 's|^.*/||'`"; \
>+	  echo " $(INSTALL_DATA) $$p $(DESTDIR)$(referencedir)/$$f"; \
>+	  $(INSTALL_DATA) $$p $(DESTDIR)$(referencedir)/$$f; \
>+	done
>+	$(mkinstalldirs) $(DESTDIR)$(devhelpdir)
>+	$(INSTALL_DATA) $(devhelp_file) $(DESTDIR)$(devhelpdir)/$$f;
>+
>+uninstall-reference: $(HTML_INDEX)
>+	@$(NORMAL_UNINSTALL)
>+	@dir='$(<D)'; for p in $$dir/*.html $$dir/*.css $$dir/*.png $$dir/*.dot ; do \
>+	  f="`echo $$p | sed -e 's|^.*/||'`"; \
>+	  echo " rm -f $(DESTDIR)$(referencedir)/$$f"; \
>+	  rm -f $(DESTDIR)$(referencedir)/$$f; \
>+	done
>+	rm -f $(DESTDIR)$(devhelpdir)/$(devhelp_file)
>+
>+endif
>+
>+doc-clean:
>+	-rm -f $(HTML_FILES) $(devhelp_file)
>+	-rm -rf api
>+	-rm -f $(devhelp_file)
>+
>+install-data-local: install-reference install-doc
>+
>+uninstall-local: uninstall-reference uninstall-doc
>+
>+clean-local: doc-clean
>+
>+.PHONY: doc-clean install-reference uninstall-reference install-doc uninstall-doc
>diff --git a/doc/doxygen_to_devhelp.xsl b/doc/doxygen_to_devhelp.xsl
>new file mode 100644
>index 0000000..6382969
>--- /dev/null
>+++ b/doc/doxygen_to_devhelp.xsl
>@@ -0,0 +1,48 @@
>+<xsl:stylesheet
>+    xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
>+    xmlns:fo="http://www.w3.org/1999/XSL/Format"
>+    version="1.0">
>+
>+<xsl:output method="xml" version="1.0" indent="yes"/>
>+
>+
>+<xsl:param name="book_title"/>
>+<xsl:param name="book_name"/>
>+<xsl:param name="reference_prefix"/>
>+<xsl:param name="docdir"/>
>+
>+<xsl:template match="/">
>+    <book title="{$book_title}"
>+        name="{$book_name}"
>+        link="{$reference_prefix}/index.html">
>+      <chapters>
>+	<sub name="Tutorial" link="{$docdir}/dbus-tutorial.html"/>
>+	<sub name="FAQ" link="{$docdir}/dbus-faq.html"/>
>+	<sub name="Specification" link="{$docdir}/dbus-specification.html"/>
>+	<sub name="API Reference" link="{$reference_prefix}/index.html"/>
>+      </chapters>
>+    </book>
>+
>+  <functions>
>+    <xsl:apply-templates select="doxygenindex/compound[@kind='group']/member[@kind='function']"/>
>+  </functions>
>+</xsl:template>
>+
>+<xsl:template match="member">
>+  <xsl:param name="name"><xsl:value-of select="name"/></xsl:param>
>+  <xsl:param name="refid"><xsl:value-of select="@refid"/></xsl:param>
>+  <xsl:param name="before"><xsl:value-of select="substring-before($refid,'_1')"/></xsl:param>
>+  <xsl:param name="after"><xsl:value-of select="substring-after($refid,'_1')"/></xsl:param>
>+  <xsl:param name="link"><xsl:value-of select="$before"/>.html#<xsl:value-of select="$after"/></xsl:param>
>+  <xsl:if test="starts-with($name,'dbus') or starts-with($name, 'DBus')">
>+    <xsl:if test="starts-with($refid,'group__') and contains($refid, '_1')">
>+       <function name="{$name}" link="{$reference_prefix}/{$link}"/>
>+    </xsl:if>
>+  </xsl:if>
>+</xsl:template>
>+
>+</xsl:stylesheet>
>+
>+
>-- 
>1.5.5.rc0.1.gb9db
>

Actions: View | Splinter Review

Attachments on bug 13495: 12912 | 15572 | 42022 | 42023 | 42024 | 42025 | 42026 | 42027 | 42028 | 42029

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.