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@
26 $(srcdir)/inspect/*.xml \
33 $(DOC_MAIN_SGML_FILE) \
36 $(DOC_MODULE)-sections.txt
38 MAINTAINER_DOC_STAMPS = \
43 # we don't add inspect-build.stamp and scanobj-build.stamp here since they are
44 # built manually by docs maintainers and result is commited to CVS
55 # files generated/updated by gtkdoc-scangobj
57 $(DOC_MODULE).signals \
58 $(DOC_MODULE).hierarchy \
59 $(DOC_MODULE).interfaces \
60 $(DOC_MODULE).prerequisites \
64 .libs/$(DOC_MODULE)-scan.o
66 # files generated/updated by gtkdoc-scan
68 $(DOC_MODULE)-sections.txt \
69 $(DOC_MODULE)-overrides.txt \
70 $(DOC_MODULE)-undocumented.txt \
71 $(DOC_MODULE)-decl.txt \
72 $(DOC_MODULE)-decl-list.txt
75 all-local: html-build.stamp
77 #### scan gobjects; done by documentation maintainer ####
79 -rm scanobj-build.stamp
80 make scanobj-build.stamp
82 # in the case of non-srcdir builds, the built gst directory gets added
83 # to gtk-doc scanning; but only then, to avoid duplicates
84 # FIXME: since we don't have the scan step as part of the build anymore,
85 # we could remove that
86 # TODO: finish elite script that updates the output files of this step
87 # instead of rewriting them, so that multiple maintainers can generate
88 # a collective set of args and signals
89 scanobj-build.stamp: $(HFILE_GLOB) $(SCANOBJ_DEPS) $(basefiles)
90 @echo '*** Scanning GObjects ***'
91 if test x"$(srcdir)" != x. ; then \
92 for f in $(SCANOBJ_FILES); \
94 cp $(srcdir)/$$f . ; \
97 GST_PLUGIN_PATH=`cd $(top_builddir) && pwd` \
98 GST_PLUGIN_PATH_ONLY=1 \
99 CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" \
100 CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" \
101 $(GST_DOC_SCANOBJ) --type-init-func="gst_init(NULL,NULL)" \
102 --module=$(DOC_MODULE) --source=$(PACKAGE); \
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_PATH_ONLY=yes \
115 GST_PLUGIN_PATH=$(top_builddir)/gst:$(top_builddir)/sys:$(top_builddir)/ext \
116 GST_REGISTRY=$(INSPECT_REGISTRY)
118 # update the element and plugin XML descriptions; store in inspect/
122 inspect-update: inspect
123 -rm inspect-build.stamp
124 make inspect-build.stamp
126 # FIXME: inspect.stamp should be written to by gst-xmlinspect.py
127 # IFF the output changed; see gtkdoc-mktmpl
129 @echo '*** Rebuilding plugin inspection files ***'
130 if test x"$(srcdir)" != x. ; then \
131 cp $(srcdir)/inspect.stamp . ; \
132 cp $(srcdir)/inspect-build.stamp . ; \
134 $(INSPECT_ENVIRONMENT) $(PYTHON) \
135 $(top_srcdir)/common/gst-xmlinspect.py $(PACKAGE) inspect && \
136 echo -n "timestamp" > inspect.stamp && \
137 touch inspect-build.stamp; \
140 ### scan headers; done on every build ###
141 scan-build.stamp: $(HFILE_GLOB) $(EXTRA_HFILES) $(basefiles) scanobj-build.stamp inspect-build.stamp
142 if test "x$(top_srcdir)" != "x$(top_builddir)"; \
144 export BUILT_OPTIONS="--source-dir=$(top_builddir)/gst"; \
147 $(SCAN_OPTIONS) $(EXTRA_HFILES) \
148 --module=$(DOC_MODULE) \
150 --ignore-headers="$(IGNORE_HFILES)"; \
151 touch scan-build.stamp
153 #### update templates; done on every build ####
155 ### FIXME: make this error out again when docs are fixed for 0.9
156 # in a non-srcdir build, we need to copy files from the previous step
157 # and the files from previous runs of this step
158 tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES)
159 @echo '*** Rebuilding template files ***'
160 if test x"$(srcdir)" != x. ; then \
161 for f in $(SCANOBJ_FILES) $(SCAN_FILES); \
163 if test -e $(srcdir)/$$f; then cp $(srcdir)/$$f . ; fi; \
166 gtkdoc-mktmpl --module=$(DOC_MODULE) | tee tmpl-build.log
168 $(top_srcdir)/common/mangle-tmpl.py $(srcdir)/inspect tmpl
169 @cat $(DOC_MODULE)-unused.txt
171 touch tmpl-build.stamp
173 tmpl.stamp: tmpl-build.stamp
176 #### build xml; done on every build ####
178 ### FIXME: make this error out again when docs are fixed for 0.9
179 sgml-build.stamp: tmpl.stamp inspect.stamp $(CFILE_GLOB) $(top_srcdir)/common/plugins.xsl
180 @echo '*** Building XML ***'
182 @for a in $(srcdir)/inspect/*.xml; do \
183 xsltproc --stringparam module $(MODULE) \
184 $(top_srcdir)/common/plugins.xsl $$a > xml/`basename $$a`; done
185 @for f in $(EXAMPLE_CFILES); do \
186 $(PYTHON) $(top_srcdir)/common/c-to-xml.py $$f > xml/element-`basename $$f .c`.xml; done
188 --module=$(DOC_MODULE) \
189 --source-dir=$(DOC_SOURCE_DIR) \
190 --main-sgml-file=$(srcdir)/$(DOC_MAIN_SGML_FILE) \
191 --output-format=xml \
192 --ignore-files="$(IGNORE_HFILES) $(IGNORE_CFILES)" \
195 @if grep "WARNING:" sgml-build.log > /dev/null; then true; fi # exit 1; fi
196 cp ../version.entities xml
198 touch sgml-build.stamp
200 sgml.stamp: sgml-build.stamp
203 #### build html; done on every step ####
205 html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
206 @echo '*** Building HTML ***'
207 if test -d html; then rm -rf html; fi
209 cp $(srcdir)/$(DOC_MAIN_SGML_FILE) html
210 @for f in $(content_files); do cp $(srcdir)/$$f html; done
212 cp ../version.entities html
213 cd html && gtkdoc-mkhtml $(DOC_MODULE) $(DOC_MAIN_SGML_FILE)
214 rm -f html/$(DOC_MAIN_SGML_FILE)
216 rm -f html/version.entities
217 test "x$(HTML_IMAGES)" = "x" || for i in "" $(HTML_IMAGES) ; do \
218 if test "$$i" != ""; then cp $(srcdir)/$$i html ; fi; done
219 @echo '-- Fixing Crossreferences'
220 gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
221 touch html-build.stamp
226 # FC3 seems to need -scan.c to be part of CLEANFILES for distcheck
227 # no idea why FC4 can do without
230 $(DOC_MODULE)-scan.c \
231 $(DOC_MODULE)-unused.txt \
235 # FIXME: these rules need a little cleaning up
239 # clean files generated for tmpl build
241 # clean files copied/generated for nonsrcdir tmpl build
242 if test x"$(srcdir)" != x. ; then \
243 rm -rf $(SCANOBJ_FILES) $(SCAN_FILES); \
245 # clean files generated for xml build
247 # clean files generate for html build
250 distclean-local: clean
251 rm -rf tmpl/*.sgml.bak
252 rm -f *.stamp || true
255 # thomas: make docs parallel installable; devhelp requires majorminor too
257 $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
258 (installfiles=`echo ./html/*.html`; \
259 if test "$$installfiles" = './html/*.html'; \
260 then echo '-- Nothing to install' ; \
262 for i in $$installfiles; do \
263 echo '-- Installing '$$i ; \
264 $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
266 pngfiles=`echo ./html/*.png`; \
267 if test "$$pngfiles" != './html/*.png'; then \
268 for i in $$pngfiles; do \
269 echo '-- Installing '$$i ; \
270 $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
273 echo '-- Installing $(srcdir)/html/$(DOC_MODULE).devhelp' ; \
274 $(INSTALL_DATA) $(srcdir)/html/$(DOC_MODULE).devhelp \
275 $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp; \
276 echo '-- Installing $(srcdir)/html/index.sgml' ; \
277 $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
278 if test -e $(srcdir)/html/style.css; then \
279 echo '-- Installing $(srcdir)/html/style.css' ; \
280 $(INSTALL_DATA) $(srcdir)/html/style.css $(DESTDIR)$(TARGET_DIR); \
284 (installfiles=`echo ./html/*.html`; \
285 if test "$$installfiles" = './html/*.html'; \
286 then echo '-- Nothing to uninstall' ; \
288 for i in $$installfiles; do \
289 rmfile=`basename $$i` ; \
290 echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/'$$rmfile ; \
291 rm -f $(DESTDIR)$(TARGET_DIR)/$$rmfile; \
293 pngfiles=`echo ./html/*.png`; \
294 if test "$$pngfiles" != './html/*.png'; then \
295 for i in $$pngfiles; do \
296 rmfile=`basename $$i` ; \
297 echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/'$$rmfile ; \
298 rm -f $(DESTDIR)$(TARGET_DIR)/$$rmfile; \
301 echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE).devhelp' ; \
302 rm -f $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp; \
303 echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/index.sgml' ; \
304 rm -f $(DESTDIR)$(TARGET_DIR)/index.sgml; \
305 if test -e $(DESTDIR)$(TARGET_DIR)/style.css; then \
306 echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/style.css' ; \
307 rm -f $(DESTDIR)$(TARGET_DIR)/style.css; \
310 if test -d $(DESTDIR)$(TARGET_DIR); then rmdir -p --ignore-fail-on-non-empty $(DESTDIR)$(TARGET_DIR) 2>/dev/null; fi; true
313 # Require gtk-doc when making dist
319 @echo "*** gtk-doc must be installed and enabled in order to make dist"
323 # FIXME: decide whether we want to dist generated html or not
324 dist-hook: dist-check-gtkdoc dist-hook-local
325 mkdir $(distdir)/tmpl
327 mkdir $(distdir)/html
328 -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
329 -cp $(srcdir)/sgml/*.xml $(distdir)/xml
330 -cp $(srcdir)/html/index.sgml $(distdir)/html
331 -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html
332 -cp $(srcdir)/html/$(DOC_MODULE).devhelp $(distdir)/html
334 images=$(HTML_IMAGES) ; \
335 for i in "" $$images ; do \
336 if test "$$i" != ""; then cp $(srcdir)/$$i $(distdir)/html ; fi; \
339 .PHONY : dist-hook-local