1 # This is an include file specifically tuned for building documentation
2 # for GStreamer plug-ins
5 @echo "If you are a doc maintainer, run 'make update' to update"
6 @echo "the documentation files maintained in CVS"
8 # update the stuff maintained by doc maintainers
13 # We set GPATH here; this gives us semantics for GNU make
14 # which are more like other make's VPATH, when it comes to
15 # whether a source that is a target of one rule is then
16 # searched for in VPATH/GPATH.
20 # thomas: make docs parallel installable
21 TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@
25 $(srcdir)/inspect/*.xml \
32 $(DOC_MAIN_SGML_FILE) \
34 $(DOC_MODULE)-sections.txt
36 MAINTAINER_DOC_STAMPS = \
41 # we don't add inspect-build.stamp and scanobj-build.stamp here since they are
42 # built manually by docs maintainers and result is commited to CVS
53 # files generated/updated by gtkdoc-scangobj
55 $(DOC_MODULE).signals \
56 $(DOC_MODULE).hierarchy \
57 $(DOC_MODULE).interfaces \
58 $(DOC_MODULE).prerequisites \
63 .libs/$(DOC_MODULE)-scan.o
65 # files generated/updated by gtkdoc-scan
67 $(DOC_MODULE)-sections.txt \
68 $(DOC_MODULE)-overrides.txt \
69 $(DOC_MODULE)-undocumented.txt \
70 $(DOC_MODULE)-decl.txt \
71 $(DOC_MODULE)-decl-list.txt
74 all-local: html-build.stamp
76 #### scan gobjects; done by documentation maintainer ####
78 -rm scanobj-build.stamp
79 make scanobj-build.stamp
81 # in the case of non-srcdir builds, the built gst directory gets added
82 # to gtk-doc scanning; but only then, to avoid duplicates
83 # FIXME: since we don't have the scan step as part of the build anymore,
84 # we could remove that
85 # TODO: finish elite script that updates the output files of this step
86 # instead of rewriting them, so that multiple maintainers can generate
87 # a collective set of args and signals
88 scanobj-build.stamp: $(SCANOBJ_DEPS) $(basefiles)
89 @echo '*** Scanning GObjects ***'
90 if test x"$(srcdir)" != x. ; then \
91 for f in $(SCANOBJ_FILES); \
93 cp $(srcdir)/$$f . ; \
96 $(INSPECT_ENVIRONMENT) \
97 CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" \
98 CFLAGS="-g $(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" \
99 $(GST_DOC_SCANOBJ) --type-init-func="gst_init(NULL,NULL)" \
100 --module=$(DOC_MODULE) --source=$(PACKAGE) && \
102 $(top_srcdir)/common/scangobj-merge.py $(DOC_MODULE); \
104 touch scanobj-build.stamp
106 $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(SCANOBJ_FILES_O): scan-build.stamp
109 ### inspect GStreamer plug-ins; done by documentation maintainer ###
111 # only look at the plugins in this module when building inspect .xml stuff
112 INSPECT_REGISTRY=$(top_builddir)/docs/plugins/inspect-registry.xml
113 INSPECT_ENVIRONMENT=\
114 GST_PLUGIN_SYSTEM_PATH= \
115 GST_PLUGIN_PATH=$(top_builddir)/gst:$(top_builddir)/sys:$(top_builddir)/ext:$(top_builddir)/plugins:$(top_builddir)/src \
116 GST_REGISTRY=$(INSPECT_REGISTRY)
118 # update the element and plugin XML descriptions; store in inspect/
122 inspect-update: inspect
123 -rm $(INSPECT_REGISTRY)
124 -rm inspect-build.stamp
125 make inspect-build.stamp
127 # FIXME: inspect.stamp should be written to by gst-xmlinspect.py
128 # IFF the output changed; see gtkdoc-mktmpl
130 @echo '*** Rebuilding plugin inspection files ***'
131 if test x"$(srcdir)" != x. ; then \
132 cp $(srcdir)/inspect.stamp . ; \
133 cp $(srcdir)/inspect-build.stamp . ; \
135 $(INSPECT_ENVIRONMENT) $(PYTHON) \
136 $(top_srcdir)/common/gst-xmlinspect.py $(PACKAGE) inspect && \
137 echo -n "timestamp" > inspect.stamp && \
138 touch inspect-build.stamp; \
141 ### scan headers; done on every build ###
142 scan-build.stamp: $(HFILE_GLOB) $(EXTRA_HFILES) $(basefiles) scanobj-build.stamp inspect-build.stamp
143 if test "x$(top_srcdir)" != "x$(top_builddir)" && \
144 test -d "$(top_builddir)/gst"; \
146 export BUILT_OPTIONS="--source-dir=$(top_builddir)/gst"; \
149 $(SCAN_OPTIONS) $(EXTRA_HFILES) \
150 --module=$(DOC_MODULE) \
152 --ignore-headers="$(IGNORE_HFILES)"; \
153 touch scan-build.stamp
155 #### update templates; done on every build ####
157 ### FIXME: make this error out again when docs are fixed for 0.9
158 # in a non-srcdir build, we need to copy files from the previous step
159 # and the files from previous runs of this step
160 tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES)
161 @echo '*** Rebuilding template files ***'
162 if test x"$(srcdir)" != x. ; then \
163 for f in $(SCANOBJ_FILES) $(SCAN_FILES); \
165 if test -e $(srcdir)/$$f; then cp $(srcdir)/$$f . ; fi; \
168 gtkdoc-mktmpl --module=$(DOC_MODULE) | tee tmpl-build.log
170 $(top_srcdir)/common/mangle-tmpl.py $(srcdir)/inspect tmpl
171 @cat $(DOC_MODULE)-unused.txt
173 touch tmpl-build.stamp
175 tmpl.stamp: tmpl-build.stamp
178 #### build xml; done on every build ####
180 ### FIXME: make this error out again when docs are fixed for 0.9
181 sgml-build.stamp: tmpl.stamp inspect.stamp $(CFILE_GLOB) $(top_srcdir)/common/plugins.xsl
182 @echo '*** Building XML ***'
184 @for a in $(srcdir)/inspect/*.xml; do \
185 xsltproc --stringparam module $(MODULE) \
186 $(top_srcdir)/common/plugins.xsl $$a > xml/`basename $$a`; done
187 @for f in $(EXAMPLE_CFILES); do \
188 $(PYTHON) $(top_srcdir)/common/c-to-xml.py $$f > xml/element-`basename $$f .c`.xml; done
190 --module=$(DOC_MODULE) \
191 --source-dir=$(DOC_SOURCE_DIR) \
192 --main-sgml-file=$(srcdir)/$(DOC_MAIN_SGML_FILE) \
193 --output-format=xml \
194 --ignore-files="$(IGNORE_HFILES) $(IGNORE_CFILES)" \
197 @if grep "WARNING:" sgml-build.log > /dev/null; then true; fi # exit 1; fi
198 cp ../version.entities xml
200 touch sgml-build.stamp
202 sgml.stamp: sgml-build.stamp
205 #### build html; done on every step ####
207 html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
208 @echo '*** Building HTML ***'
209 if test -d html; then rm -rf html; fi
211 cp $(srcdir)/$(DOC_MAIN_SGML_FILE) html
212 @for f in $(content_files); do cp $(srcdir)/$$f html; done
214 cp ../version.entities html
215 cd html && gtkdoc-mkhtml $(DOC_MODULE) $(DOC_MAIN_SGML_FILE) \
216 2>&1 | tee ../html-build.log
217 @if grep "warning:" html-build.log > /dev/null; then \
218 echo "ERROR"; grep "warning:" html-build.log; exit 1; fi
220 rm -f html/$(DOC_MAIN_SGML_FILE)
222 rm -f html/version.entities
223 test "x$(HTML_IMAGES)" = "x" || for i in "" $(HTML_IMAGES) ; do \
224 if test "$$i" != ""; then cp $(srcdir)/$$i html ; fi; done
225 @echo '-- Fixing Crossreferences'
226 gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
227 touch html-build.stamp
232 # FC3 seems to need -scan.c to be part of CLEANFILES for distcheck
233 # no idea why FC4 can do without
236 $(DOC_MODULE)-scan.c \
237 $(DOC_MODULE)-unused.txt \
241 # FIXME: these rules need a little cleaning up
245 # clean files generated for tmpl build
247 # clean files copied/generated for nonsrcdir tmpl build
248 if test x"$(srcdir)" != x. ; then \
249 rm -rf $(SCANOBJ_FILES) $(SCAN_FILES); \
251 # clean files generated for xml build
253 # clean files generate for html build
256 distclean-local: clean
257 rm -rf tmpl/*.sgml.bak
258 rm -f *.stamp || true
261 # thomas: make docs parallel installable; devhelp requires majorminor too
263 $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
264 (installfiles=`echo ./html/*.html`; \
265 if test "$$installfiles" = './html/*.html'; \
266 then echo '-- Nothing to install' ; \
268 for i in $$installfiles; do \
269 echo '-- Installing '$$i ; \
270 $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
272 pngfiles=`echo ./html/*.png`; \
273 if test "$$pngfiles" != './html/*.png'; then \
274 for i in $$pngfiles; do \
275 echo '-- Installing '$$i ; \
276 $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
279 echo '-- Installing $(srcdir)/html/$(DOC_MODULE).devhelp' ; \
280 $(INSTALL_DATA) $(srcdir)/html/$(DOC_MODULE).devhelp \
281 $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp; \
282 echo '-- Installing $(srcdir)/html/index.sgml' ; \
283 $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
284 if test -e $(srcdir)/html/style.css; then \
285 echo '-- Installing $(srcdir)/html/style.css' ; \
286 $(INSTALL_DATA) $(srcdir)/html/style.css $(DESTDIR)$(TARGET_DIR); \
290 (installfiles=`echo ./html/*.html`; \
291 if test "$$installfiles" = './html/*.html'; \
292 then echo '-- Nothing to uninstall' ; \
294 for i in $$installfiles; do \
295 rmfile=`basename $$i` ; \
296 echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/'$$rmfile ; \
297 rm -f $(DESTDIR)$(TARGET_DIR)/$$rmfile; \
299 pngfiles=`echo ./html/*.png`; \
300 if test "$$pngfiles" != './html/*.png'; then \
301 for i in $$pngfiles; do \
302 rmfile=`basename $$i` ; \
303 echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/'$$rmfile ; \
304 rm -f $(DESTDIR)$(TARGET_DIR)/$$rmfile; \
307 echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE).devhelp' ; \
308 rm -f $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp; \
309 echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/index.sgml' ; \
310 rm -f $(DESTDIR)$(TARGET_DIR)/index.sgml; \
311 if test -e $(DESTDIR)$(TARGET_DIR)/style.css; then \
312 echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/style.css' ; \
313 rm -f $(DESTDIR)$(TARGET_DIR)/style.css; \
316 if test -d $(DESTDIR)$(TARGET_DIR); then rmdir -p --ignore-fail-on-non-empty $(DESTDIR)$(TARGET_DIR) 2>/dev/null; fi; true
321 check-hierarchy: $(DOC_MODULE).hierarchy
322 @if grep ' ' $(DOC_MODULE).hierarchy; then \
323 echo "$(DOC_MODULE).hierarchy contains tabs, please fix"; \
327 check: check-hierarchy
331 # Require gtk-doc when making dist
337 @echo "*** gtk-doc must be installed and enabled in order to make dist"
341 # FIXME: decide whether we want to dist generated html or not
342 dist-hook: dist-check-gtkdoc dist-hook-local
343 mkdir $(distdir)/tmpl
345 mkdir $(distdir)/html
346 -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
347 -cp $(srcdir)/sgml/*.xml $(distdir)/xml
348 -cp $(srcdir)/html/index.sgml $(distdir)/html
349 -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html
350 -cp $(srcdir)/html/$(DOC_MODULE).devhelp $(distdir)/html
352 images=$(HTML_IMAGES) ; \
353 for i in "" $$images ; do \
354 if test "$$i" != ""; then cp $(srcdir)/$$i $(distdir)/html ; fi; \
357 .PHONY : dist-hook-local