gtk-doc-plugins.mak

   1 # This is an include file specifically tuned for building documentation
   2 # for GStreamer plug-ins
   3
   4 help:
   5         @echo
   6         @echo "If you are a doc maintainer, run 'make update' to update"
   7         @echo "the documentation files maintained in CVS"
   8         @echo
   9         @echo Other useful make targets:
  10         @echo
  11         @echo  check-inspected-versions: make sure the inspected plugin info
  12         @echo                            is up to date before a release
  13         @echo
  14
  15 # update the stuff maintained by doc maintainers
  16 update:
  17         $(MAKE) inspect-update
  18         $(MAKE) scanobj-update
  19
  20 # We set GPATH here; this gives us semantics for GNU make
  21 # which are more like other make's VPATH, when it comes to
  22 # whether a source that is a target of one rule is then
  23 # searched for in VPATH/GPATH.
  24 #
  25 GPATH = $(srcdir)
  26
  27 # thomas: make docs parallel installable
  28 TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@
  29
  30 EXTRA_DIST =                            \
  31         scanobj-build.stamp             \
  32         $(srcdir)/inspect/*.xml         \
  33         inspect.stamp                   \
  34         inspect-build.stamp             \
  35         $(SCANOBJ_FILES)                \
  36         $(content_files)                \
  37         $(extra_files)                  \
  38         $(HTML_IMAGES)                  \
  39         $(DOC_MAIN_SGML_FILE)   \
  40         $(DOC_OVERRIDES)                \
  41         $(DOC_MODULE)-sections.txt
  42
  43 MAINTAINER_DOC_STAMPS =                 \
  44         scanobj-build.stamp             \
  45         inspect-build.stamp             \
  46         inspect.stamp
  47
  48 # we don't add inspect-build.stamp and scanobj-build.stamp here since they are
  49 # built manually by docs maintainers and result is commited to CVS
  50 DOC_STAMPS =                            \
  51         scan-build.stamp                \
  52         tmpl-build.stamp                \
  53         sgml-build.stamp                \
  54         html-build.stamp                \
  55         scan.stamp                      \
  56         tmpl.stamp                      \
  57         sgml.stamp                      \
  58         html.stamp
  59
  60 # files generated/updated by gtkdoc-scangobj
  61 SCANOBJ_FILES =                         \
  62         $(DOC_MODULE).signals           \
  63         $(DOC_MODULE).hierarchy         \
  64         $(DOC_MODULE).interfaces        \
  65         $(DOC_MODULE).prerequisites     \
  66         $(DOC_MODULE).types             \
  67         $(DOC_MODULE).args
  68
  69 SCANOBJ_FILES_O =                       \
  70         .libs/$(DOC_MODULE)-scan.o
  71
  72 # files generated/updated by gtkdoc-scan
  73 SCAN_FILES =                            \
  74         $(DOC_MODULE)-sections.txt      \
  75         $(DOC_MODULE)-overrides.txt     \
  76         $(DOC_MODULE)-undocumented.txt  \
  77         $(DOC_MODULE)-decl.txt          \
  78         $(DOC_MODULE)-decl-list.txt
  79
  80
  81 REPORT_FILES = \
  82         $(DOC_MODULE)-undocumented.txt \
  83         $(DOC_MODULE)-undeclared.txt \
  84         $(DOC_MODULE)-unused.txt
  85
  86 # FC3 seems to need -scan.c to be part of CLEANFILES for distcheck
  87 # no idea why FC4 can do without
  88 CLEANFILES = \
  89         $(SCANOBJ_FILES_O) \
  90         $(DOC_MODULE)-scan.c \
  91         $(REPORT_FILES) \
  92         $(DOC_STAMPS) \
  93         inspect-registry.xml
  94
  95
  96 if ENABLE_GTK_DOC
  97 all-local: html-build.stamp
  98
  99 #### scan gobjects; done by documentation maintainer ####
 100 scanobj-update:
 101         -rm scanobj-build.stamp
 102         $(MAKE) scanobj-build.stamp
 103
 104 # in the case of non-srcdir builds, the built gst directory gets added
 105 # to gtk-doc scanning; but only then, to avoid duplicates
 106 # FIXME: since we don't have the scan step as part of the build anymore,
 107 # we could remove that
 108 # TODO: finish elite script that updates the output files of this step
 109 # instead of rewriting them, so that multiple maintainers can generate
 110 # a collective set of args and signals
 111 scanobj-build.stamp: $(SCANOBJ_DEPS) $(basefiles)
 112         @echo '*** Scanning GObjects ***'
 113         if test x"$(srcdir)" != x. ; then                               \
 114             for f in $(SCANOBJ_FILES);                                  \
 115             do                                                          \
 116                 cp $(srcdir)/$$f . ;                                    \
 117             done;                                                       \
 118         else                                                            \
 119             $(INSPECT_ENVIRONMENT)                                      \
 120             CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)"                         \
 121             CFLAGS="-g $(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)"               \
 122             $(GST_DOC_SCANOBJ) --type-init-func="gst_init(NULL,NULL)"   \
 123                 --module=$(DOC_MODULE) --source=$(PACKAGE) &&           \
 124                 $(PYTHON)                                               \
 125                 $(top_srcdir)/common/scangobj-merge.py $(DOC_MODULE);   \
 126         fi
 127         touch scanobj-build.stamp
 128
 129 $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(SCANOBJ_FILES_O): scan-build.stamp
 130         @true
 131
 132 ### inspect GStreamer plug-ins; done by documentation maintainer ###
 133
 134 # only look at the plugins in this module when building inspect .xml stuff
 135 INSPECT_REGISTRY=$(builddir)/inspect-registry.xml
 136 INSPECT_ENVIRONMENT=\
 137         GST_PLUGIN_SYSTEM_PATH= \
 138         GST_PLUGIN_PATH=$(top_builddir)/gst:$(top_builddir)/sys:$(top_builddir)/ext:$(top_builddir)/plugins:$(top_builddir)/src:$(top_builddir)/gnl \
 139         GST_REGISTRY=$(INSPECT_REGISTRY)
 140
 141 # update the element and plugin XML descriptions; store in inspect/
 142 inspect:
 143         mkdir inspect
 144
 145 inspect-update: inspect
 146         -rm -f $(INSPECT_REGISTRY) inspect-build.stamp
 147         $(MAKE) inspect-build.stamp
 148
 149 # FIXME: inspect.stamp should be written to by gst-xmlinspect.py
 150 # IF the output changed; see gtkdoc-mktmpl
 151 inspect-build.stamp:
 152         @echo '*** Rebuilding plugin inspection files ***'
 153         if test x"$(srcdir)" != x. ; then \
 154             cp $(srcdir)/inspect.stamp . ; \
 155             cp $(srcdir)/inspect-build.stamp . ; \
 156         else \
 157             $(INSPECT_ENVIRONMENT) $(PYTHON) \
 158                 $(top_srcdir)/common/gst-xmlinspect.py $(PACKAGE) inspect && \
 159             echo -n "timestamp" > inspect.stamp && \
 160             touch inspect-build.stamp; \
 161         fi
 162
 163 ### scan headers; done on every build ###
 164 scan-build.stamp: $(HFILE_GLOB) $(EXTRA_HFILES) $(basefiles) scanobj-build.stamp inspect-build.stamp
 165         if test "x$(top_srcdir)" != "x$(top_builddir)" &&               \
 166            test -d "$(top_builddir)/gst";                               \
 167         then                                                            \
 168             export BUILT_OPTIONS="--source-dir=$(top_builddir)/gst";    \
 169         fi;                                                             \
 170         gtkdoc-scan                                                     \
 171             $(SCAN_OPTIONS) $(EXTRA_HFILES)                             \
 172             --module=$(DOC_MODULE)                                      \
 173             $$BUILT_OPTIONS                                             \
 174             --ignore-headers="$(IGNORE_HFILES)";                        \
 175         touch scan-build.stamp
 176
 177 #### update templates; done on every build ####
 178
 179 ### FIXME: make this error out again when docs are fixed for 0.9
 180 # in a non-srcdir build, we need to copy files from the previous step
 181 # and the files from previous runs of this step
 182 tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES)
 183         @echo '*** Rebuilding template files ***'
 184         if test x"$(srcdir)" != x. ; then                               \
 185             for f in $(SCANOBJ_FILES) $(SCAN_FILES);                    \
 186             do                                                          \
 187                 if test -e $(srcdir)/$$f; then cp $(srcdir)/$$f . ; fi; \
 188             done;                                                       \
 189         fi
 190         gtkdoc-mktmpl --module=$(DOC_MODULE) | tee tmpl-build.log
 191         $(PYTHON) \
 192                 $(top_srcdir)/common/mangle-tmpl.py $(srcdir)/inspect tmpl
 193         @cat $(DOC_MODULE)-unused.txt
 194         rm -f tmpl-build.log
 195         touch tmpl-build.stamp
 196
 197 tmpl.stamp: tmpl-build.stamp
 198         @true
 199
 200 #### build xml; done on every build ####
 201
 202 ### FIXME: make this error out again when docs are fixed for 0.9
 203 sgml-build.stamp: tmpl.stamp inspect.stamp $(CFILE_GLOB) $(top_srcdir)/common/plugins.xsl
 204         @echo '*** Building XML ***'
 205         @-mkdir -p xml
 206         @for a in $(srcdir)/inspect/*.xml; do \
 207             xsltproc --stringparam module $(MODULE) \
 208                 $(top_srcdir)/common/plugins.xsl $$a > xml/`basename $$a`; done
 209         @for f in $(EXAMPLE_CFILES); do \
 210                 $(PYTHON) $(top_srcdir)/common/c-to-xml.py $$f > xml/element-`basename $$f .c`.xml; done
 211         gtkdoc-mkdb \
 212                 --module=$(DOC_MODULE) \
 213                 --source-dir=$(DOC_SOURCE_DIR) \
 214                 --main-sgml-file=$(srcdir)/$(DOC_MAIN_SGML_FILE) \
 215                 --output-format=xml \
 216                 --ignore-files="$(IGNORE_HFILES) $(IGNORE_CFILES)" \
 217                 $(MKDB_OPTIONS) \
 218                 | tee sgml-build.log
 219         @if grep "WARNING:" sgml-build.log > /dev/null; then true; fi # exit 1; fi
 220         cp ../version.entities xml
 221         rm sgml-build.log
 222         touch sgml-build.stamp
 223
 224 sgml.stamp: sgml-build.stamp
 225         @true
 226
 227 #### build html; done on every step ####
 228
 229 html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
 230         @echo '*** Building HTML ***'
 231         if test -d html; then rm -rf html; fi
 232         mkdir html
 233         cp $(srcdir)/$(DOC_MAIN_SGML_FILE) html
 234         @for f in $(content_files); do cp $(srcdir)/$$f html; done
 235         cp -pr xml html
 236         cp ../version.entities html
 237         cd html && gtkdoc-mkhtml $(DOC_MODULE) $(DOC_MAIN_SGML_FILE) \
 238             2>&1 | tee ../html-build.log
 239         @if grep "warning:" html-build.log > /dev/null; then \
 240                 echo "ERROR"; grep "warning:" html-build.log; exit 1; fi
 241         @rm html-build.log
 242         mv html/index.sgml html/index.sgml.bak
 243         $(SED) "s/ href=\"$(DOC_MODULE)\// href=\"$(DOC_MODULE)-@GST_MAJORMINOR@\//g" html/index.sgml.bak >html/index.sgml
 244         rm -f html/index.sgml.bak
 245         rm -f html/$(DOC_MAIN_SGML_FILE)
 246         rm -rf html/xml
 247         rm -f html/version.entities
 248         test "x$(HTML_IMAGES)" = "x" || for i in "" $(HTML_IMAGES) ; do \
 249             if test "$$i" != ""; then cp $(srcdir)/$$i html ; fi; done
 250         @echo '-- Fixing Crossreferences'
 251         gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
 252         touch html-build.stamp
 253
 254 clean-local-gtkdoc:
 255         rm -rf xml tmpl html
 256 # clean files copied for nonsrcdir templates build
 257         if test x"$(srcdir)" != x. ; then \
 258             rm -rf $(SCANOBJ_FILES) $(SCAN_FILES); \
 259         fi
 260 else
 261 all-local:
 262 clean-local-gtkdoc:
 263 endif
 264
 265 clean-local: clean-local-gtkdoc
 266         rm -f *~ *.bak
 267         rm -rf .libs
 268
 269 distclean-local: clean
 270         rm -rf tmpl/*.sgml.bak
 271         rm -f *.stamp || true
 272         rm -rf *.o
 273
 274 # thomas: make docs parallel installable; devhelp requires majorminor too
 275 install-data-local:
 276         $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
 277         (installfiles=`echo ./html/*.html`; \
 278         if test "$$installfiles" = './html/*.html'; \
 279         then echo '-- Nothing to install' ; \
 280         else \
 281           for i in $$installfiles; do \
 282             echo '-- Installing '$$i ; \
 283             $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
 284           done; \
 285           pngfiles=`echo ./html/*.png`; \
 286           if test "$$pngfiles" != './html/*.png'; then \
 287             for i in $$pngfiles; do \
 288               echo '-- Installing '$$i ; \
 289               $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
 290             done; \
 291           fi; \
 292           echo '-- Installing $(srcdir)/html/$(DOC_MODULE).devhelp' ; \
 293           $(INSTALL_DATA) $(srcdir)/html/$(DOC_MODULE).devhelp \
 294             $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp; \
 295           if test -e $(srcdir)/html/$(DOC_MODULE).devhelp2; then \
 296                   $(INSTALL_DATA) $(srcdir)/html/$(DOC_MODULE).devhelp2 \
 297                    $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp2; \
 298           fi; \
 299           echo '-- Installing $(srcdir)/html/index.sgml' ; \
 300           $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
 301                 if test -e $(srcdir)/html/style.css; then \
 302                         echo '-- Installing $(srcdir)/html/style.css' ; \
 303                         $(INSTALL_DATA) $(srcdir)/html/style.css $(DESTDIR)$(TARGET_DIR); \
 304                 fi; \
 305         fi)
 306 uninstall-local:
 307         (installfiles=`echo ./html/*.html`; \
 308         if test "$$installfiles" = './html/*.html'; \
 309         then echo '-- Nothing to uninstall' ; \
 310         else \
 311           for i in $$installfiles; do \
 312             rmfile=`basename $$i` ; \
 313             echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/'$$rmfile ; \
 314             rm -f $(DESTDIR)$(TARGET_DIR)/$$rmfile; \
 315           done; \
 316           pngfiles=`echo ./html/*.png`; \
 317           if test "$$pngfiles" != './html/*.png'; then \
 318             for i in $$pngfiles; do \
 319               rmfile=`basename $$i` ; \
 320               echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/'$$rmfile ; \
 321               rm -f $(DESTDIR)$(TARGET_DIR)/$$rmfile; \
 322             done; \
 323           fi; \
 324           echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE).devhelp' ; \
 325           rm -f $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp; \
 326           if test -e $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp2; then \
 327             rm -f $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp2; \
 328           fi; \
 329           echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/index.sgml' ; \
 330           rm -f $(DESTDIR)$(TARGET_DIR)/index.sgml; \
 331                 if test -e $(DESTDIR)$(TARGET_DIR)/style.css; then \
 332                         echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/style.css' ; \
 333                         rm -f $(DESTDIR)$(TARGET_DIR)/style.css; \
 334                 fi; \
 335         fi)
 336         if test -d $(DESTDIR)$(TARGET_DIR); then rmdir -p --ignore-fail-on-non-empty $(DESTDIR)$(TARGET_DIR) 2>/dev/null; fi; true
 337
 338 #
 339 # Checks
 340 #
 341 check-hierarchy: $(DOC_MODULE).hierarchy
 342         @if grep '      ' $(DOC_MODULE).hierarchy; then \
 343             echo "$(DOC_MODULE).hierarchy contains tabs, please fix"; \
 344             /bin/false; \
 345         fi
 346
 347 check: check-hierarchy
 348
 349 # wildcard is apparently not portable to other makes, hence the use of find
 350 inspect_files = $(shell find $(srcdir)/inspect -name '*.xml')
 351
 352 check-inspected-versions:
 353         @echo Checking plugin versions of inspected plugin data ...; \
 354         fail=0 ; \
 355         for each in $(inspect_files) ; do \
 356           if (grep -H '<version>' $$each | grep -v '<version>$(VERSION)'); then \
 357             echo $$each should be fixed to say version $(VERSION) or be removed ; \
 358             echo "sed -i -e 's/<version.*version>/<version>$(VERSION)<\/version>/'" $$each; \
 359             echo ; \
 360             fail=1; \
 361           fi ; \
 362         done ; \
 363         exit $$fail
 364
 365 #
 366 # Require gtk-doc when making dist
 367 #
 368 if ENABLE_GTK_DOC
 369 dist-check-gtkdoc:
 370 else
 371 dist-check-gtkdoc:
 372         @echo "*** gtk-doc must be installed and enabled in order to make dist"
 373         @false
 374 endif
 375
 376 # FIXME: decide whether we want to dist generated html or not
 377 dist-hook: dist-check-gtkdoc dist-hook-local
 378         mkdir $(distdir)/tmpl
 379         mkdir $(distdir)/xml
 380         mkdir $(distdir)/html
 381         -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
 382         -cp $(srcdir)/sgml/*.xml $(distdir)/xml
 383         -cp $(srcdir)/html/index.sgml $(distdir)/html
 384         -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(srcdir)/html/*.png $(distdir)/html
 385         -cp $(srcdir)/html/$(DOC_MODULE).devhelp* $(distdir)/html
 386
 387         images=$(HTML_IMAGES) ;               \
 388         for i in "" $$images ; do                     \
 389           if test "$$i" != ""; then cp $(srcdir)/$$i $(distdir)/html ; fi; \
 390         done
 391
 392 .PHONY : dist-hook-local
 393