X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=doc%2FMakefile.am;h=b2659871c6fdf136c019bc28cff8ccd1f2cd74f8;hb=085cabfbf4262087aaaa2cf3a567c9aaa0aec282;hp=5a3a0a28f4d19c7cd26d46d6e2813544fd3ce900;hpb=a7f69a41d5b82eb00da20b661181b490039bb70f;p=platform%2Fupstream%2Fdbus.git diff --git a/doc/Makefile.am b/doc/Makefile.am index 5a3a0a2..b265987 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,30 +1,176 @@ -EXTRA_DIST= \ - config-file.txt \ +apidir = @htmldir@/api + +# automake normally assumes that man pages are generated files; +# these ones aren't, so we need the dist_ prefix to say that they're +# their own source code +dist_man1_MANS = \ + dbus-cleanup-sockets.1 \ + dbus-launch.1 \ + dbus-monitor.1 \ + dbus-send.1 \ + dbus-uuidgen.1 + +# on the other hand, this one is generated +man1_MANS = \ + dbus-daemon.1 + +MAN_IN_FILES = dbus-daemon.1.in + +MAN_HTML_FILES = \ + dbus-cleanup-sockets.1.html \ + dbus-daemon.1.html \ + dbus-launch.1.html \ + dbus-monitor.1.html \ + dbus-send.1.html \ + dbus-uuidgen.1.html + +DTDS = \ + busconfig.dtd \ + introspect.dtd + +dist_doc_DATA = system-activation.txt + +# uploaded and distributed, but not installed +STATIC_DOCS = \ + dbus-faq.xml \ + dbus-specification.xml \ + dbus-test-plan.xml \ + dbus-tutorial.xml \ + dcop-howto.txt \ + introspect.xsl \ + $(DTDS) + +EXTRA_DIST = \ + file-boilerplate.c \ + doxygen_to_devhelp.xsl \ + $(STATIC_DOCS) \ + $(MAN_IN_FILES) + +html_DATA = + +dist_html_DATA = + +# diagram.png/diagram.svg aren't really HTML, but must go in the same +# directory as the HTML to avoid broken links +STATIC_HTML = \ + diagram.png \ + diagram.svg \ + $(NULL) + +dist_html_DATA += $(STATIC_HTML) + +# we distribute these in the tarball so users don't necessarily need xmlto +dist_html_DATA += $(XMLTO_OUTPUT) + +XMLTO_OUTPUT= \ + dbus-faq.html \ dbus-specification.html \ - dbus-specification.sgml \ dbus-test-plan.html \ - dbus-test-plan.sgml \ - dcop-howto.txt \ - file-boilerplate.c + dbus-tutorial.html + +if DBUS_XML_DOCS_ENABLED +dbus-specification.html: dbus-specification.xml + $(XMLTO) html-nochunks $< + +dbus-test-plan.html: dbus-test-plan.xml + $(XMLTO) html-nochunks $< + +dbus-tutorial.html: dbus-tutorial.xml + $(XMLTO) html-nochunks $< -if MAINTAINER_MODE -all-local: dbus-specification.html dbus-test-plan.html +dbus-faq.html: dbus-faq.xml + $(XMLTO) html-nochunks $< endif -dbus-specification.html: dbus-specification.sgml - db2html -o . --nochunks dbus-specification.sgml && \ - rm -r dbus-specification/stylesheet-images && \ - (if test -d dbus-specification ; then rmdir dbus-specification ; fi) +if DBUS_DOXYGEN_DOCS_ENABLED +all-local:: doxygen.stamp + +doxygen.stamp: $(wildcard $(top_srcdir)/dbus/*.[ch]) + $(AM_V_GEN)cd $(top_builddir) && doxygen Doxyfile + @touch $@ + +if DBUS_HAVE_XSLTPROC +html_DATA += dbus.devhelp + +dbus.devhelp: $(srcdir)/doxygen_to_devhelp.xsl doxygen.stamp + $(XSLTPROC) -o $@ $< api/xml/index.xml +endif + +# this assumes CREATE_SUBDIRS isn't set to YES in Doxyfile +# (which it isn't currently) +install-data-local:: doxygen.stamp + $(MKDIR_P) $(DESTDIR)$(apidir) + $(INSTALL_DATA) api/html/* $(DESTDIR)$(apidir) + +uninstall-local:: + rm -f $(DESTDIR)$(apidir)/*.html + rm -f $(DESTDIR)$(apidir)/*.png + rm -f $(DESTDIR)$(apidir)/*.css + rm -f $(DESTDIR)$(apidir)/*.js + rm -f $(DESTDIR)$(htmldir)/*.html + rm -f $(DESTDIR)$(docdir)/*.txt + rm -f $(DESTDIR)$(htmldir)/*.png + rm -f $(DESTDIR)$(htmldir)/*.svg + rmdir --ignore-fail-on-non-empty $(DESTDIR)$(apidir) || \ + rmdir $(DESTDIR)$(apidir) +endif + +if DBUS_HAVE_MAN2HTML +html_DATA += $(MAN_HTML_FILES) + +%.1.html: %.1 + $(AM_V_GEN)( $(MAN2HTML) < $< > $@.tmp && mv $@.tmp $@ ) +endif + +if DBUS_CAN_UPLOAD_DOCS +BONUS_FILES = \ + $(top_srcdir)/README \ + $(top_srcdir)/HACKING \ + $(top_srcdir)/AUTHORS \ + $(top_srcdir)/NEWS \ + $(top_srcdir)/COPYING \ + $(top_srcdir)/ChangeLog + +dbus-docs: $(STATIC_DOCS) $(dist_doc_DATA) $(dist_html_DATA) $(MAN_HTML_FILES) $(BONUS_FILES) doxygen.stamp + $(AM_V_at)rm -rf $@ $@.tmp + $(AM_V_GEN)$(MKDIR_P) $@.tmp/api + $(AM_V_at)cd $(srcdir) && cp $(STATIC_DOCS) @abs_builddir@/$@.tmp + $(AM_V_at)cd $(srcdir) && cp $(dist_doc_DATA) @abs_builddir@/$@.tmp + $(AM_V_at)cd $(srcdir) && cp $(STATIC_HTML) @abs_builddir@/$@.tmp + $(AM_V_at)cp $(XMLTO_OUTPUT) @abs_builddir@/$@.tmp + $(AM_V_at)cp $(MAN_HTML_FILES) @abs_builddir@/$@.tmp + $(AM_V_at)cp $(BONUS_FILES) @abs_builddir@/$@.tmp + $(AM_V_at)cp -r api/html @abs_builddir@/$@.tmp/api + $(AM_V_at)mv $@.tmp $@ + +dbus-docs.tar.gz: dbus-docs + $(AM_V_GEN)tar czf $@ $< + +DOC_SERVER = dbus.freedesktop.org +DOC_WWW_DIR = /srv/dbus.freedesktop.org/www + +SPECIFICATION_SERVER = specifications.freedesktop.org +SPECIFICATION_PATH = /srv/specifications.freedesktop.org/www/dbus/1.0 + +maintainer-upload-docs: dbus-docs.tar.gz dbus-docs + scp dbus-docs.tar.gz $(DOC_SERVER):$(DOC_WWW_DIR)/ + rsync -rpvzP --chmod=Dg+s,ug+rwX,o=rX \ + dbus-docs/ $(DOC_SERVER):$(DOC_WWW_DIR)/doc/ + cd $(srcdir) && scp -p $(DTDS) $(SPECIFICATION_SERVER):$(SPECIFICATION_PATH)/ +else +maintainer-upload-docs: + @echo "Can't upload documentation! Re-run configure with" + @echo " --enable-doxygen-docs --enable-xml-docs" + @echo "and ensure that man2html is installed." + @false +endif -dbus-test-plan.html: dbus-test-plan.sgml - db2html -o . --nochunks dbus-test-plan.sgml && \ - rm -r dbus-test-plan/stylesheet-images && \ - (if test -d dbus-test-plan ; then rmdir dbus-test-plan ; fi) +clean-local: + rm -f $(html_DATA) + rm -rf api + rm -rf dbus-docs dbus-docs.tmp + rm -f *.1.html + rm -f doxygen.stamp maintainer-clean-local: - rm -f dbus-test-plan.html - rm -rf dbus-test-plan/stylesheet-images - test -d dbus-test-plan && rmdir dbus-test-plan - rm -f dbus-specification.html - rm -rf dbus-specification/stylesheet-images - test -d dbus-specification && rmdir dbus-specification + rm -f $(XMLTO_OUTPUT)