make libs use same gtk-doc.mak
authorThomas Vander Stichele <thomas@apestaart.org>
Thu, 7 Jul 2005 15:07:21 +0000 (15:07 +0000)
committerThomas Vander Stichele <thomas@apestaart.org>
Thu, 7 Jul 2005 15:07:21 +0000 (15:07 +0000)
Original commit message from CVS:
make libs use same gtk-doc.mak

docs/libs/Makefile.am

index f1a89d8..3931ce4 100644 (file)
@@ -90,251 +90,4 @@ GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)
 # and uncomment this line.
 DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
 
-
-
-###########################################################################
-# Everything below here is generic and you shouldn't need to change it.
-###########################################################################
-# thomas: except of course that we did
-
-# thomas: copied from glib-2
-# We set GPATH here; this gives us semantics for GNU make
-# which are more like other make's VPATH, when it comes to
-# whether a source that is a target of one rule is then
-# searched for in VPATH/GPATH.
-#
-GPATH = $(srcdir)
-
-TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@
-
-EXTRA_DIST =                           \
-       $(content_files)                \
-       $(extra_files)                  \
-       $(HTML_IMAGES)                  \
-       $(DOC_MAIN_SGML_FILE)           \
-       $(DOC_MODULE).types             \
-       $(DOC_OVERRIDES)                \
-       $(DOC_MODULE)-sections.txt
-
-DOC_STAMPS =                           \
-       scan-build.stamp                \
-       tmpl-build.stamp                \
-       sgml-build.stamp                \
-       html-build.stamp                \
-       $(srcdir)/tmpl.stamp            \
-       $(srcdir)/sgml.stamp            \
-       $(srcdir)/html.stamp
-
-SCANOBJ_FILES =                                \
-       $(DOC_MODULE).args              \
-       $(DOC_MODULE).hierarchy         \
-       $(DOC_MODULE).interfaces        \
-       $(DOC_MODULE).prerequisites     \
-       .libs/$(DOC_MODULE)-scan.o      \
-       $(DOC_MODULE).signals
-
-CLEANFILES = $(SCANOBJ_FILES) $(DOC_MODULE)-unused.txt $(DOC_STAMPS)
-
-if HAVE_GTK_DOC
-all-local: html-build.stamp
-
-#### scan ####
-
-# in the case of non-srcdir builds, the built gst directory gets added
-# to gtk-doc scanning; but only then, to avoid duplicates
-scan-build.stamp: $(HFILE_GLOB) $(SCANOBJ_DEPS) $(basefiles)
-       @echo '*** Scanning header files ***'
-       if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null;  \
-       then                                                            \
-            if test x"$(srcdir)" != x. ; then                          \
-                cp $(srcdir)/$(DOC_MODULE).types . ;                   \
-                chmod u+w $(DOC_MODULE).types ;                                \
-            fi ;                                                       \
-           CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)"                         \
-           CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)"          \
-           $(GTK_DOC_SCANOBJ) --type-init-func="gst_init(NULL,NULL)"   \
-               --module=$(DOC_MODULE) ;                                \
-       else                                                            \
-           cd $(srcdir) ;                                              \
-           for i in $(SCANOBJ_FILES) ; do                              \
-              test -f $$i || touch $$i ;                               \
-           done                                                        \
-       fi
-       if test "x$(top_srcdir)" != "x$(top_builddir)";                 \
-       then                                                            \
-         export BUILT_OPTIONS="--source-dir=$(top_builddir)/libs/gst"; \
-       fi;                                                             \
-       gtkdoc-scan                                                     \
-               $(SCAN_OPTIONS) $(EXTRA_HFILES)                         \
-               --module=$(DOC_MODULE)                                  \
-               --source-dir=$(DOC_SOURCE_DIR)                          \
-               $$BUILT_OPTIONS                                         \
-               --ignore-headers="$(IGNORE_HFILES)"
-       touch scan-build.stamp
-
-$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp
-       @true
-
-#### templates ####
-
-tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES)
-       @echo '*** Rebuilding template files ***'
-       if test x"$(srcdir)" != x. ; then \
-           cp $(srcdir)/$(DOC_MODULE)-decl.txt . ; \
-           cp $(srcdir)/$(DOC_MODULE)-sections.txt . ; \
-       fi
-       gtkdoc-mktmpl --module=$(DOC_MODULE)
-       touch tmpl-build.stamp
-
-tmpl.stamp: tmpl-build.stamp
-       @true
-
-#### sgml ####
-
-sgml-build.stamp: tmpl.stamp $(CFILE_GLOB)
-       @echo '*** Building XML ***'
-       gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --main-sgml-file=$(srcdir)/$(DOC_MAIN_SGML_FILE) --output-format=xml $(MKDB_OPTIONS) | tee sgml-build.log
-       @if grep "WARNING:" sgml-build.log > /dev/null; then exit 1; fi
-       rm sgml-build.log
-       touch sgml-build.stamp
-
-sgml.stamp: sgml-build.stamp
-       @true
-
-#### html ####
-
-# FIXME: setting LANG=C is a hack to work with gtk-doc < 1.1, because
-# that forces a non-utf8 locale.  gtk-doc >= 1.1 solves this by calling
-# use bytes; in gtkdoc-fixxref
-html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
-       @echo '*** Building HTML ***'
-       if test -d html; then rm -rf html; fi
-       mkdir html
-       @cp $(srcdir)/$(DOC_MAIN_SGML_FILE) html
-       cp -pr xml html
-       cp ../version.entities html
-       cd html && gtkdoc-mkhtml $(DOC_MODULE) $(DOC_MAIN_SGML_FILE)
-       rm -f html/$(DOC_MAIN_SGML_FILE)
-       rm -rf html/xml
-       rm -f html/version.entities
-       test "x$(HTML_IMAGES)" = "x" || for i in "" $(HTML_IMAGES) ; do \
-           if test "$$i" != ""; then cp $(srcdir)/$$i html ; fi; done
-       @echo '-- Fixing Crossreferences' 
-       LANG=C && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
-       touch html-build.stamp
-else
-all-local:
-endif
-
-clean-local:
-       rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS)
-       rm -rf xml html
-
-maintainer-clean-local: clean
-       cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
-
-# FIXME : thomas added all sgml files and some other things to make
-# make distcheck work
-distclean-local: clean
-       rm -f $(DOC_MODULE)-decl-list.txt
-       rm -f $(DOC_MODULE)-decl.txt
-       rm -f $(DOC_MODULE)-undocumented.txt
-       rm -f $(DOC_MODULE)-unused.txt
-       rm -rf tmpl/*.sgml.bak
-       rm -f $(DOC_MODULE).hierarchy
-       rm -f *.stamp || true
-       if test x"$(srcdir)" != x. ; then \
-           rm -f $(DOC_MODULE)-docs.sgml ; \
-           rm -f $(DOC_MODULE).types ; \
-           rm -f $(DOC_MODULE).interfaces ; \
-           rm -f $(DOC_MODULE)-overrides.txt ; \
-           rm -f $(DOC_MODULE).prerequisites ; \
-           rm -f $(DOC_MODULE)-sections.txt ; \
-           rm -rf tmpl/*.sgml ; \
-       fi
-       rm -f *.o
-
-
-install-data-local:
-       $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR) 
-       (installfiles=`echo ./html/*.html`; \
-       if test "$$installfiles" = './html/*.html'; \
-       then echo '-- Nothing to install' ; \
-       else \
-         for i in $$installfiles; do \
-           echo '-- Installing '$$i ; \
-           $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
-         done; \
-         pngfiles=`echo ./html/*.png`; \
-         if test "$$pngfiles" != './html/*.png'; then \
-           for i in $$pngfiles; do \
-             echo '-- Installing '$$i ; \
-             $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
-           done; \
-         fi; \
-         echo '-- Installing $(srcdir)/html/$(DOC_MODULE).devhelp' ; \
-         $(INSTALL_DATA) $(srcdir)/html/$(DOC_MODULE).devhelp \
-           $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp; \
-         echo '-- Installing $(srcdir)/html/index.sgml' ; \
-         $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
-               if test -e $(srcdir)/html/style.css; then \
-                       echo '-- Installing $(srcdir)/html/style.css' ; \
-                       $(INSTALL_DATA) $(srcdir)/html/style.css $(DESTDIR)$(TARGET_DIR); \
-               fi; \
-       fi) 
-uninstall-local:
-       (installfiles=`echo ./html/*.html`; \
-       if test "$$installfiles" = './html/*.html'; \
-       then echo '-- Nothing to uninstall' ; \
-       else \
-         for i in $$installfiles; do \
-           rmfile=`basename $$i` ; \
-           echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/'$$rmfile ; \
-           rm -f $(DESTDIR)$(TARGET_DIR)/$$rmfile; \
-         done; \
-         pngfiles=`echo ./html/*.png`; \
-         if test "$$pngfiles" != './html/*.png'; then \
-           for i in $$pngfiles; do \
-             rmfile=`basename $$i` ; \
-             echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/'$$rmfile ; \
-             rm -f $(DESTDIR)$(TARGET_DIR)/$$rmfile; \
-           done; \
-         fi; \
-         echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE).devhelp' ; \
-         rm -f $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp; \
-         echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/index.sgml' ; \
-         rm -f $(DESTDIR)$(TARGET_DIR)/index.sgml; \
-               if test -e $(DESTDIR)$(TARGET_DIR)/style.css; then \
-                       echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/style.css' ; \
-                       rm -f $(DESTDIR)$(TARGET_DIR)/style.css; \
-               fi; \
-       fi) 
-       if test -d $(DESTDIR)$(TARGET_DIR); then rmdir -p --ignore-fail-on-non-empty $(DESTDIR)$(TARGET_DIR) 2>/dev/null; fi
-
-#
-# Require gtk-doc when making dist
-#
-if HAVE_GTK_DOC
-dist-check-gtkdoc:
-else
-dist-check-gtkdoc:
-       @echo "*** gtk-doc must be installed and enabled in order to make dist"
-       @false
-endif
-
-dist-hook: dist-check-gtkdoc dist-hook-local
-       mkdir $(distdir)/tmpl
-       mkdir $(distdir)/xml
-       mkdir $(distdir)/html
-       -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
-       -cp $(srcdir)/sgml/*.xml $(distdir)/xml
-       -cp $(srcdir)/html/index.sgml $(distdir)/html
-       -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html
-       -cp $(srcdir)/html/gstreamer-libs.devhelp $(distdir)/html
-
-       images=$(HTML_IMAGES) ;               \
-       for i in "" $$images ; do                     \
-         if test "$$i" != ""; then cp $(srcdir)/$$i $(distdir)/html ; fi; \
-       done
-
-.PHONY : dist-hook-local
+include $(top_srcdir)/common/gtk-doc.mak