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