gtk-doc-plugins.mak

   1 ###########################################################################
   2 # Everything below here is generic and you shouldn't need to change it.
   3 ###########################################################################
   4 # thomas: except of course that we did
   5
   6 # thomas: copied from glib-2
   7 # We set GPATH here; this gives us semantics for GNU make
   8 # which are more like other make's VPATH, when it comes to
   9 # whether a source that is a target of one rule is then
  10 # searched for in VPATH/GPATH.
  11 #
  12 GPATH = $(srcdir)
  13
  14 # thomas: make docs parallel installable
  15 TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@
  16
  17 EXTRA_DIST =                            \
  18         $(content_files)                \
  19         $(extra_files)                  \
  20         $(HTML_IMAGES)                  \
  21         $(DOC_MAIN_SGML_FILE)           \
  22         $(DOC_OVERRIDES)                \
  23         $(DOC_MODULE)-sections.txt
  24
  25 DOC_STAMPS =                            \
  26         scan-build.stamp                \
  27         tmpl-build.stamp                \
  28         sgml-build.stamp                \
  29         html-build.stamp                \
  30         $(srcdir)/tmpl.stamp            \
  31         $(srcdir)/sgml.stamp            \
  32         $(srcdir)/html.stamp
  33
  34 SCANOBJ_FILES =                         \
  35         $(DOC_MODULE).args              \
  36         $(DOC_MODULE).hierarchy         \
  37         $(DOC_MODULE).interfaces        \
  38         $(DOC_MODULE).prerequisites     \
  39         .libs/$(DOC_MODULE)-scan.o      \
  40         $(DOC_MODULE).signals
  41
  42 CLEANFILES = $(SCANOBJ_FILES) $(DOC_MODULE)-unused.txt $(DOC_STAMPS)
  43
  44 if HAVE_GTK_DOC
  45 all-local: html-build.stamp
  46
  47 #### scan ####
  48
  49 # in the case of non-srcdir builds, the built gst directory gets added
  50 # to gtk-doc scanning; but only then, to avoid duplicates
  51 scan-build.stamp: $(HFILE_GLOB) $(SCANOBJ_DEPS) $(basefiles)
  52         @echo '*** Scanning header files ***'
  53             if test x"$(srcdir)" != x. ; then                           \
  54                 cp $(srcdir)/$(DOC_MODULE).types . ;                    \
  55                 chmod u+w $(DOC_MODULE).types ;                         \
  56             fi ;                                                        \
  57             GST_PLUGIN_PATH=`cd $(top_builddir) && pwd`                 \
  58             GST_PLUGIN_PATH_ONLY=1                                      \
  59             CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)"                         \
  60             CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)"          \
  61             $(GST_DOC_SCANOBJ) --type-init-func="gst_init(NULL,NULL)"   \
  62                 --module=$(DOC_MODULE) ;                                \
  63         if test "x$(top_srcdir)" != "x$(top_builddir)";                 \
  64         then                                                            \
  65           export BUILT_OPTIONS="--source-dir=$(top_builddir)/gst";      \
  66         fi;                                                             \
  67         gtkdoc-scan                                                     \
  68                 $(SCAN_OPTIONS) $(EXTRA_HFILES)                         \
  69                 --module=$(DOC_MODULE)                                  \
  70                 $$BUILT_OPTIONS                                         \
  71                 --ignore-headers="$(IGNORE_HFILES)"
  72         touch scan-build.stamp
  73
  74 $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp
  75         @true
  76
  77 #### templates ####
  78
  79 ### FIXME: make this error out again when docs are fixed for 0.9
  80 tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES)
  81         @echo '*** Rebuilding template files ***'
  82         if test x"$(srcdir)" != x. ; then \
  83             cp $(srcdir)/$(DOC_MODULE)-sections.txt . ; \
  84             touch $(DOC_MODULE)-decl.txt ; \
  85         fi
  86         gtkdoc-mktmpl --module=$(DOC_MODULE) | tee tmpl-build.log
  87         @cat $(DOC_MODULE)-unused.txt
  88         @if ! test -z "`grep -v GstPoptOption $(DOC_MODULE)-unused.txt`"; then \
  89             true; fi # exit 1; fi
  90         rm -f tmpl-build.log
  91         touch tmpl-build.stamp
  92
  93 tmpl.stamp: tmpl-build.stamp
  94         @true
  95
  96 #### xml ####
  97
  98 ### FIXME: make this error out again when docs are fixed for 0.9
  99 sgml-build.stamp: tmpl.stamp $(CFILE_GLOB)
 100         @echo '*** Building XML ***'
 101         gtkdoc-mkdb \
 102                 --module=$(DOC_MODULE) \
 103                 --source-dir=$(DOC_SOURCE_DIR) \
 104                 --main-sgml-file=$(srcdir)/$(DOC_MAIN_SGML_FILE) \
 105                 --output-format=xml \
 106                 --ignore-files="$(IGNORE_HFILES) $(IGNORE_CFILES)" \
 107                 $(MKDB_OPTIONS) \
 108                 | tee sgml-build.log
 109         @if grep "WARNING:" sgml-build.log > /dev/null; then true; fi # exit 1; fi
 110         cp ../version.entities xml
 111         rm sgml-build.log
 112         touch sgml-build.stamp
 113
 114 sgml.stamp: sgml-build.stamp
 115         @true
 116
 117 #### html ####
 118
 119 html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
 120         @echo '*** Building HTML ***'
 121         if test -d html; then rm -rf html; fi
 122         mkdir html
 123         cp $(srcdir)/$(DOC_MAIN_SGML_FILE) html
 124         @for f in $(content_files); do cp $(srcdir)/$$f html; done
 125         cp -pr xml html
 126         cp ../version.entities html
 127         cd html && gtkdoc-mkhtml $(DOC_MODULE) $(DOC_MAIN_SGML_FILE)
 128         rm -f html/$(DOC_MAIN_SGML_FILE)
 129         rm -rf html/xml
 130         rm -f html/version.entities
 131         test "x$(HTML_IMAGES)" = "x" || for i in "" $(HTML_IMAGES) ; do \
 132             if test "$$i" != ""; then cp $(srcdir)/$$i html ; fi; done
 133         @echo '-- Fixing Crossreferences'
 134         gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
 135         touch html-build.stamp
 136 else
 137 all-local:
 138 endif
 139
 140 clean-local:
 141         rm -f *~ *.bak
 142         rm -rf xml html
 143         rm -rf .libs
 144
 145 maintainer-clean-local: clean
 146         cd $(srcdir) && rm -rf xml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
 147
 148 # company: don't delete .sgml and -sections.txt as they're in CVS
 149 # FIXME : thomas added all sgml files and some other things to make
 150 # make distcheck work
 151 distclean-local: clean
 152         rm -f $(DOC_MODULE)-decl-list.txt
 153         rm -f $(DOC_MODULE)-decl.txt
 154         rm -f $(DOC_MODULE)-undocumented.txt
 155         rm -f $(DOC_MODULE)-unused.txt
 156         rm -rf tmpl/*.sgml.bak
 157         rm -f $(DOC_MODULE).hierarchy
 158         rm -f *.stamp || true
 159         if test x"$(srcdir)" != x. ; then \
 160             rm -f $(DOC_MODULE)-docs.sgml ; \
 161             rm -f $(DOC_MODULE).types ; \
 162             rm -f $(DOC_MODULE).interfaces ; \
 163             rm -f $(DOC_MODULE)-overrides.txt ; \
 164             rm -f $(DOC_MODULE).prerequisites ; \
 165             rm -f $(DOC_MODULE)-sections.txt ; \
 166             rm -rf tmpl/*.sgml ; \
 167         fi
 168         rm -rf *.o
 169
 170 # thomas: make docs parallel installable; devhelp requires majorminor too
 171 install-data-local:
 172         $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
 173         (installfiles=`echo ./html/*.html`; \
 174         if test "$$installfiles" = './html/*.html'; \
 175         then echo '-- Nothing to install' ; \
 176         else \
 177           for i in $$installfiles; do \
 178             echo '-- Installing '$$i ; \
 179             $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
 180           done; \
 181           pngfiles=`echo ./html/*.png`; \
 182           if test "$$pngfiles" != './html/*.png'; then \
 183             for i in $$pngfiles; do \
 184               echo '-- Installing '$$i ; \
 185               $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
 186             done; \
 187           fi; \
 188           echo '-- Installing $(srcdir)/html/$(DOC_MODULE).devhelp' ; \
 189           $(INSTALL_DATA) $(srcdir)/html/$(DOC_MODULE).devhelp \
 190             $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp; \
 191           echo '-- Installing $(srcdir)/html/index.sgml' ; \
 192           $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
 193                 if test -e $(srcdir)/html/style.css; then \
 194                         echo '-- Installing $(srcdir)/html/style.css' ; \
 195                         $(INSTALL_DATA) $(srcdir)/html/style.css $(DESTDIR)$(TARGET_DIR); \
 196                 fi; \
 197         fi)
 198 uninstall-local:
 199         (installfiles=`echo ./html/*.html`; \
 200         if test "$$installfiles" = './html/*.html'; \
 201         then echo '-- Nothing to uninstall' ; \
 202         else \
 203           for i in $$installfiles; do \
 204             rmfile=`basename $$i` ; \
 205             echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/'$$rmfile ; \
 206             rm -f $(DESTDIR)$(TARGET_DIR)/$$rmfile; \
 207           done; \
 208           pngfiles=`echo ./html/*.png`; \
 209           if test "$$pngfiles" != './html/*.png'; then \
 210             for i in $$pngfiles; do \
 211               rmfile=`basename $$i` ; \
 212               echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/'$$rmfile ; \
 213               rm -f $(DESTDIR)$(TARGET_DIR)/$$rmfile; \
 214             done; \
 215           fi; \
 216           echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE).devhelp' ; \
 217           rm -f $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp; \
 218           echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/index.sgml' ; \
 219           rm -f $(DESTDIR)$(TARGET_DIR)/index.sgml; \
 220                 if test -e $(DESTDIR)$(TARGET_DIR)/style.css; then \
 221                         echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/style.css' ; \
 222                         rm -f $(DESTDIR)$(TARGET_DIR)/style.css; \
 223                 fi; \
 224         fi)
 225         if test -d $(DESTDIR)$(TARGET_DIR); then rmdir -p --ignore-fail-on-non-empty $(DESTDIR)$(TARGET_DIR) 2>/dev/null; fi; true
 226
 227 #
 228 # Require gtk-doc when making dist
 229 #
 230 if HAVE_GTK_DOC
 231 dist-check-gtkdoc:
 232 else
 233 dist-check-gtkdoc:
 234         @echo "*** gtk-doc must be installed and enabled in order to make dist"
 235         @false
 236 endif
 237
 238 dist-hook: dist-check-gtkdoc dist-hook-local
 239         mkdir $(distdir)/tmpl
 240         mkdir $(distdir)/xml
 241         mkdir $(distdir)/html
 242         -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
 243         -cp $(srcdir)/sgml/*.xml $(distdir)/xml
 244         -cp $(srcdir)/html/index.sgml $(distdir)/html
 245         -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html
 246         -cp $(srcdir)/html/$(DOC_MODULE).devhelp $(distdir)/html
 247
 248         images=$(HTML_IMAGES) ;               \
 249         for i in "" $$images ; do                     \
 250           if test "$$i" != ""; then cp $(srcdir)/$$i $(distdir)/html ; fi; \
 251         done
 252
 253 .PHONY : dist-hook-local