1 # This is an include file specifically tuned for building documentation
2 # for GStreamer plug-ins
6 @echo "If you are a doc maintainer, run 'make update' to update"
7 @echo "the documentation files maintained in CVS"
9 @echo Other useful make targets:
11 @echo check-inspected-versions: make sure the inspected plugin info
12 @echo is up to date before a release
15 # update the stuff maintained by doc maintainers
17 $(MAKE) inspect-update
18 $(MAKE) scanobj-update
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.
27 # thomas: make docs parallel installable
28 TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@
32 $(srcdir)/inspect/*.xml \
39 $(DOC_MAIN_SGML_FILE) \
41 $(DOC_MODULE)-sections.txt
43 MAINTAINER_DOC_STAMPS = \
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
60 # files generated/updated by gtkdoc-scangobj
62 $(DOC_MODULE).signals \
63 $(DOC_MODULE).hierarchy \
64 $(DOC_MODULE).interfaces \
65 $(DOC_MODULE).prerequisites \
70 .libs/$(DOC_MODULE)-scan.o
72 # files generated/updated by gtkdoc-scan
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
82 $(DOC_MODULE)-undocumented.txt \
83 $(DOC_MODULE)-undeclared.txt \
84 $(DOC_MODULE)-unused.txt
86 # FC3 seems to need -scan.c to be part of CLEANFILES for distcheck
87 # no idea why FC4 can do without
90 $(DOC_MODULE)-scan.c \
97 all-local: html-build.stamp
99 #### scan gobjects; done by documentation maintainer ####
101 -rm scanobj-build.stamp
102 $(MAKE) scanobj-build.stamp
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); \
116 cp $(srcdir)/$$f . ; \
119 $(INSPECT_ENVIRONMENT) \
120 CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" \
121 CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS)" \
122 LDFLAGS="$(GTKDOC_LIBS) $(LDFLAGS)" \
123 $(GST_DOC_SCANOBJ) --type-init-func="gst_init(NULL,NULL)" \
124 --module=$(DOC_MODULE) --source=$(PACKAGE) && \
126 $(top_srcdir)/common/scangobj-merge.py $(DOC_MODULE); \
128 touch scanobj-build.stamp
130 $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(SCANOBJ_FILES_O): scan-build.stamp
133 ### inspect GStreamer plug-ins; done by documentation maintainer ###
135 # only look at the plugins in this module when building inspect .xml stuff
136 INSPECT_REGISTRY=$(builddir)/inspect-registry.xml
137 INSPECT_ENVIRONMENT=\
138 GST_PLUGIN_SYSTEM_PATH= \
139 GST_PLUGIN_PATH=$(top_builddir)/gst:$(top_builddir)/sys:$(top_builddir)/ext:$(top_builddir)/plugins:$(top_builddir)/src:$(top_builddir)/gnl \
140 GST_REGISTRY=$(INSPECT_REGISTRY)
142 # update the element and plugin XML descriptions; store in inspect/
146 inspect-update: inspect
147 -rm -f $(INSPECT_REGISTRY) inspect-build.stamp
148 $(MAKE) inspect-build.stamp
150 # FIXME: inspect.stamp should be written to by gst-xmlinspect.py
151 # IF the output changed; see gtkdoc-mktmpl
153 @echo '*** Rebuilding plugin inspection files ***'
154 if test x"$(srcdir)" != x. ; then \
155 cp $(srcdir)/inspect.stamp . ; \
156 cp $(srcdir)/inspect-build.stamp . ; \
158 $(INSPECT_ENVIRONMENT) $(PYTHON) \
159 $(top_srcdir)/common/gst-xmlinspect.py $(PACKAGE) inspect && \
160 echo -n "timestamp" > inspect.stamp && \
161 touch inspect-build.stamp; \
164 ### scan headers; done on every build ###
165 scan-build.stamp: $(HFILE_GLOB) $(EXTRA_HFILES) $(basefiles) scanobj-build.stamp inspect-build.stamp
166 if test "x$(top_srcdir)" != "x$(top_builddir)" && \
167 test -d "$(top_builddir)/gst"; \
169 export BUILT_OPTIONS="--source-dir=$(top_builddir)/gst"; \
172 $(SCAN_OPTIONS) $(EXTRA_HFILES) \
173 --module=$(DOC_MODULE) \
175 --ignore-headers="$(IGNORE_HFILES)"; \
176 touch scan-build.stamp
178 #### update templates; done on every build ####
180 ### FIXME: make this error out again when docs are fixed for 0.9
181 # in a non-srcdir build, we need to copy files from the previous step
182 # and the files from previous runs of this step
183 tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES)
184 @echo '*** Rebuilding template files ***'
185 if test x"$(srcdir)" != x. ; then \
186 for f in $(SCANOBJ_FILES) $(SCAN_FILES); \
188 if test -e $(srcdir)/$$f; then cp $(srcdir)/$$f . ; fi; \
191 gtkdoc-mktmpl --module=$(DOC_MODULE) | tee tmpl-build.log
193 $(top_srcdir)/common/mangle-tmpl.py $(srcdir)/inspect tmpl
194 @cat $(DOC_MODULE)-unused.txt
196 touch tmpl-build.stamp
198 tmpl.stamp: tmpl-build.stamp
201 #### build xml; done on every build ####
203 ### FIXME: make this error out again when docs are fixed for 0.9
204 sgml-build.stamp: tmpl.stamp inspect.stamp $(CFILE_GLOB) $(top_srcdir)/common/plugins.xsl
205 @echo '*** Building XML ***'
207 @for a in $(srcdir)/inspect/*.xml; do \
208 xsltproc --stringparam module $(MODULE) \
209 $(top_srcdir)/common/plugins.xsl $$a > xml/`basename $$a`; done
210 @for f in $(EXAMPLE_CFILES); do \
211 $(PYTHON) $(top_srcdir)/common/c-to-xml.py $$f > xml/element-`basename $$f .c`.xml; done
213 --module=$(DOC_MODULE) \
214 --source-dir=$(DOC_SOURCE_DIR) \
215 --main-sgml-file=$(srcdir)/$(DOC_MAIN_SGML_FILE) \
216 --output-format=xml \
217 --ignore-files="$(IGNORE_HFILES) $(IGNORE_CFILES)" \
220 @if grep "WARNING:" sgml-build.log > /dev/null; then true; fi # exit 1; fi
221 cp ../version.entities xml
223 touch sgml-build.stamp
225 sgml.stamp: sgml-build.stamp
228 #### build html; done on every step ####
230 html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
231 @echo '*** Building HTML ***'
232 if test -d html; then rm -rf html; fi
234 cp $(srcdir)/$(DOC_MAIN_SGML_FILE) html
235 @for f in $(content_files); do cp $(srcdir)/$$f html; done
237 cp ../version.entities html
238 cd html && gtkdoc-mkhtml $(DOC_MODULE) $(DOC_MAIN_SGML_FILE) \
239 2>&1 | tee ../html-build.log
240 @if grep "warning:" html-build.log > /dev/null; then \
241 echo "ERROR"; grep "warning:" html-build.log; exit 1; fi
243 mv html/index.sgml html/index.sgml.bak
244 $(SED) "s/ href=\"$(DOC_MODULE)\// href=\"$(DOC_MODULE)-@GST_MAJORMINOR@\//g" html/index.sgml.bak >html/index.sgml
245 rm -f html/index.sgml.bak
246 rm -f html/$(DOC_MAIN_SGML_FILE)
248 rm -f html/version.entities
249 test "x$(HTML_IMAGES)" = "x" || for i in "" $(HTML_IMAGES) ; do \
250 if test "$$i" != ""; then cp $(srcdir)/$$i html ; fi; done
251 @echo '-- Fixing Crossreferences'
252 gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
253 touch html-build.stamp
257 # clean files copied for nonsrcdir templates build
258 if test x"$(srcdir)" != x. ; then \
259 rm -rf $(SCANOBJ_FILES) $(SCAN_FILES); \
266 clean-local: clean-local-gtkdoc
270 distclean-local: clean
271 rm -rf tmpl/*.sgml.bak
272 rm -f *.stamp || true
275 # thomas: make docs parallel installable; devhelp requires majorminor too
277 $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
278 (installfiles=`echo ./html/*.html`; \
279 if test "$$installfiles" = './html/*.html'; \
280 then echo '-- Nothing to install' ; \
282 for i in $$installfiles; do \
283 echo '-- Installing '$$i ; \
284 $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
286 pngfiles=`echo ./html/*.png`; \
287 if test "$$pngfiles" != './html/*.png'; then \
288 for i in $$pngfiles; do \
289 echo '-- Installing '$$i ; \
290 $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
293 echo '-- Installing $(srcdir)/html/$(DOC_MODULE).devhelp' ; \
294 $(INSTALL_DATA) $(srcdir)/html/$(DOC_MODULE).devhelp \
295 $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp; \
296 if test -e $(srcdir)/html/$(DOC_MODULE).devhelp2; then \
297 $(INSTALL_DATA) $(srcdir)/html/$(DOC_MODULE).devhelp2 \
298 $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp2; \
300 echo '-- Installing $(srcdir)/html/index.sgml' ; \
301 $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
302 if test -e $(srcdir)/html/style.css; then \
303 echo '-- Installing $(srcdir)/html/style.css' ; \
304 $(INSTALL_DATA) $(srcdir)/html/style.css $(DESTDIR)$(TARGET_DIR); \
308 (installfiles=`echo ./html/*.html`; \
309 if test "$$installfiles" = './html/*.html'; \
310 then echo '-- Nothing to uninstall' ; \
312 for i in $$installfiles; do \
313 rmfile=`basename $$i` ; \
314 echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/'$$rmfile ; \
315 rm -f $(DESTDIR)$(TARGET_DIR)/$$rmfile; \
317 pngfiles=`echo ./html/*.png`; \
318 if test "$$pngfiles" != './html/*.png'; then \
319 for i in $$pngfiles; do \
320 rmfile=`basename $$i` ; \
321 echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/'$$rmfile ; \
322 rm -f $(DESTDIR)$(TARGET_DIR)/$$rmfile; \
325 echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE).devhelp' ; \
326 rm -f $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp; \
327 if test -e $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp2; then \
328 rm -f $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp2; \
330 echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/index.sgml' ; \
331 rm -f $(DESTDIR)$(TARGET_DIR)/index.sgml; \
332 if test -e $(DESTDIR)$(TARGET_DIR)/style.css; then \
333 echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/style.css' ; \
334 rm -f $(DESTDIR)$(TARGET_DIR)/style.css; \
337 if test -d $(DESTDIR)$(TARGET_DIR); then rmdir -p --ignore-fail-on-non-empty $(DESTDIR)$(TARGET_DIR) 2>/dev/null; fi; true
342 check-hierarchy: $(DOC_MODULE).hierarchy
343 @if grep ' ' $(DOC_MODULE).hierarchy; then \
344 echo "$(DOC_MODULE).hierarchy contains tabs, please fix"; \
348 check: check-hierarchy
350 # wildcard is apparently not portable to other makes, hence the use of find
351 inspect_files = $(shell find $(srcdir)/inspect -name '*.xml')
353 check-inspected-versions:
354 @echo Checking plugin versions of inspected plugin data ...; \
356 for each in $(inspect_files) ; do \
357 if (grep -H '<version>' $$each | grep -v '<version>$(VERSION)'); then \
358 echo $$each should be fixed to say version $(VERSION) or be removed ; \
359 echo "sed -i -e 's/<version.*version>/<version>$(VERSION)<\/version>/'" $$each; \
367 # Require gtk-doc when making dist
373 @echo "*** gtk-doc must be installed and enabled in order to make dist"
377 # FIXME: decide whether we want to dist generated html or not
378 dist-hook: dist-check-gtkdoc dist-hook-local
379 mkdir $(distdir)/tmpl
381 mkdir $(distdir)/html
382 -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
383 -cp $(srcdir)/sgml/*.xml $(distdir)/xml
384 -cp $(srcdir)/html/index.sgml $(distdir)/html
385 -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(srcdir)/html/*.png $(distdir)/html
386 -cp $(srcdir)/html/$(DOC_MODULE).devhelp* $(distdir)/html
388 images=$(HTML_IMAGES) ; \
389 for i in "" $$images ; do \
390 if test "$$i" != ""; then cp $(srcdir)/$$i $(distdir)/html ; fi; \
393 .PHONY : dist-hook-local