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