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 git"
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) scanobj-update
18 $(MAKE) check-outdated-docs
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@
30 MAINTAINER_DOC_STAMPS = \
34 $(MAINTAINER_DOC_STAMPS) \
35 $(srcdir)/inspect/*.xml \
40 $(DOC_MAIN_SGML_FILE) \
42 $(DOC_MODULE)-sections.txt
44 # we don't add scanobj-build.stamp here since they are built manually by docs
45 # maintainers and result is commited to git
56 # files generated/updated by gtkdoc-scangobj
58 $(DOC_MODULE).signals \
59 $(DOC_MODULE).hierarchy \
60 $(DOC_MODULE).interfaces \
61 $(DOC_MODULE).prerequisites \
66 .libs/$(DOC_MODULE)-scan.o
68 # files generated/updated by gtkdoc-scan
70 $(DOC_MODULE)-sections.txt \
71 $(DOC_MODULE)-overrides.txt \
72 $(DOC_MODULE)-decl.txt \
73 $(DOC_MODULE)-decl-list.txt
77 $(DOC_MODULE)-undocumented.txt \
78 $(DOC_MODULE)-undeclared.txt \
79 $(DOC_MODULE)-unused.txt
81 # FC3 seems to need -scan.c to be part of CLEANFILES for distcheck
82 # no idea why FC4 can do without
85 $(DOC_MODULE)-scan.c \
93 all-local: html-build.stamp
95 ### inspect GStreamer plug-ins; done by documentation maintainer ###
97 # only look at the plugins in this module when building inspect .xml stuff
98 INSPECT_REGISTRY=$(top_builddir)/docs/plugins/inspect-registry.xml
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)
107 # update the element and plugin XML descriptions; store in inspect/
109 @-mkdir -p $(INSPECT_DIR)
111 #### scan gobjects; done by documentation maintainer ####
113 -rm scanobj-build.stamp
114 $(MAKE) scanobj-build.stamp
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); \
124 if test -e $(srcdir)/$$f; then cp -u $(srcdir)/$$f . ; fi; \
127 $(INSPECT_ENVIRONMENT) \
128 CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" \
129 CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS) $(WARNING_CFLAGS)" \
130 LDFLAGS="$(GTKDOC_LIBS) $(LDFLAGS)" \
131 $(GST_DOC_SCANOBJ) --type-init-func="gst_init(NULL,NULL)" \
132 --module=$(DOC_MODULE) --source=$(PACKAGE) --inspect-dir=$(INSPECT_DIR) && \
134 $(top_srcdir)/common/scangobj-merge.py $(DOC_MODULE); \
135 if test x"$(srcdir)" != x. ; then \
136 for f in $(SCANOBJ_FILES); \
138 cmp -s ./$$f $(srcdir)/$$f || cp ./$$f $(srcdir)/ ; \
141 touch scanobj-build.stamp
143 $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(SCANOBJ_FILES_O): scan-build.stamp
146 ### scan headers; done on every build ###
147 scan-build.stamp: $(HFILE_GLOB) $(EXTRA_HFILES) $(basefiles) scanobj-build.stamp
148 @echo ' DOC Scanning header files'
150 $(SCAN_OPTIONS) $(EXTRA_HFILES) \
151 --module=$(DOC_MODULE) \
152 --source-dir=$(DOC_SOURCE_DIR) \
153 --ignore-headers="$(IGNORE_HFILES)"; \
154 touch scan-build.stamp
156 #### update templates; done on every build ####
158 ### FIXME: make this error out again when docs are fixed for 0.X
159 # in a non-srcdir build, we need to copy files from the previous step
160 # and the files from previous runs of this step
161 tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES)
162 @echo ' DOC Rebuilding template files'
163 @if test x"$(srcdir)" != x. ; then \
164 for f in $(SCANOBJ_FILES) $(SCAN_FILES); \
166 if test -e $(srcdir)/$$f; then cp -u $(srcdir)/$$f . ; fi; \
169 @gtkdoc-mktmpl --module=$(DOC_MODULE)
171 $(top_srcdir)/common/mangle-tmpl.py $(srcdir)/$(INSPECT_DIR) tmpl
172 @touch tmpl-build.stamp
174 tmpl.stamp: tmpl-build.stamp
177 #### build xml; done on every build ####
179 ### FIXME: make this error out again when docs are fixed for 0.9
180 sgml-build.stamp: tmpl.stamp scan-build.stamp $(CFILE_GLOB) $(top_srcdir)/common/plugins.xsl $(expand_content_files)
181 @echo ' DOC Building XML'
183 @for a in $(srcdir)/$(INSPECT_DIR)/*.xml; do \
184 xsltproc --stringparam module $(MODULE) \
185 $(top_srcdir)/common/plugins.xsl $$a > xml/`basename $$a`; done
186 @for f in $(EXAMPLE_CFILES); do \
187 $(PYTHON) $(top_srcdir)/common/c-to-xml.py $$f > xml/element-`basename $$f .c`.xml; done
189 --module=$(DOC_MODULE) \
190 --source-dir=$(DOC_SOURCE_DIR) \
191 --expand-content-files="$(expand_content_files)" \
192 --main-sgml-file=$(srcdir)/$(DOC_MAIN_SGML_FILE) \
193 --output-format=xml \
194 --ignore-files="$(IGNORE_HFILES) $(IGNORE_CFILES)" \
196 @cp ../version.entities xml
197 @touch sgml-build.stamp
199 sgml.stamp: sgml-build.stamp
202 #### build html; done on every step ####
204 html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
205 @echo ' DOC Building HTML'
206 @if test -d html; then rm -rf html; fi
208 @cp $(srcdir)/$(DOC_MAIN_SGML_FILE) html
209 @for f in $(content_files); do cp $(srcdir)/$$f html; done
211 @cp ../version.entities html
212 @cd html && gtkdoc-mkhtml $(DOC_MODULE) $(DOC_MAIN_SGML_FILE)
213 @mv html/index.sgml html/index.sgml.bak
214 @$(SED) "s/ href=\"$(DOC_MODULE)\// href=\"$(DOC_MODULE)-@GST_MAJORMINOR@\//g" html/index.sgml.bak >html/index.sgml
215 @rm -f html/index.sgml.bak
216 @rm -f html/$(DOC_MAIN_SGML_FILE)
218 @rm -f html/version.entities
219 @test "x$(HTML_IMAGES)" = "x" || for i in "" $(HTML_IMAGES) ; do \
220 if test "$$i" != ""; then cp $(srcdir)/$$i html ; fi; done
221 @echo ' DOC Fixing cross-references'
222 @gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
223 @touch html-build.stamp
226 @rm -rf xml tmpl html
227 # clean files copied for nonsrcdir templates build
228 @if test x"$(srcdir)" != x. ; then \
229 rm -rf $(SCANOBJ_FILES) $(SCAN_FILES) $(REPORT_FILES) \
230 $(MAINTAINER_DOC_STAMPS); \
237 clean-local: clean-local-gtkdoc
242 @rm -f $(REPORT_FILES) \
243 $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
244 @rm -rf tmpl/*.sgml.bak
245 @rm -f $(DOC_MODULE).hierarchy
246 @rm -f *.stamp || true
247 @if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
248 rm -f $(DOC_MODULE)-docs.sgml ; \
249 rm -f $(DOC_MODULE).types ; \
250 rm -f $(DOC_MODULE).interfaces ; \
251 rm -f $(DOC_MODULE)-overrides.txt ; \
252 rm -f $(DOC_MODULE).prerequisites ; \
253 rm -f $(DOC_MODULE)-sections.txt ; \
254 rm -rf tmpl/*.sgml ; \
255 rm -rf $(INSPECT_DIR); \
259 MAINTAINERCLEANFILES = $(MAINTAINER_DOC_STAMPS)
261 # thomas: make docs parallel installable; devhelp requires majorminor too
263 (installfiles=`echo $(builddir)/html/*.sgml $(builddir)/html/*.html $(builddir)/html/*.png $(builddir)/html/*.css`; \
264 if test "$$installfiles" = '$(builddir)/html/*.sgml $(builddir)/html/*.html $(builddir)/html/*.png $(builddir)/html/*.css'; \
265 then echo '-- Nothing to install' ; \
267 $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR); \
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 $(builddir)/html/$(DOC_MODULE).devhelp' ; \
280 $(INSTALL_DATA) $(builddir)/html/$(DOC_MODULE).devhelp \
281 $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp; \
282 if test -e $(builddir)/html/$(DOC_MODULE).devhelp2; then \
283 $(INSTALL_DATA) $(builddir)/html/$(DOC_MODULE).devhelp2 \
284 $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp2; \
286 (which gtkdoc-rebase >/dev/null && \
287 gtkdoc-rebase --relative --dest-dir=$(DESTDIR) --html-dir=$(DESTDIR)$(TARGET_DIR)) || true ; \
290 if test -d $(DESTDIR)$(TARGET_DIR); then \
291 rm -rf $(DESTDIR)$(TARGET_DIR)/*; \
292 rmdir -p $(DESTDIR)$(TARGET_DIR) 2>/dev/null || true; \
294 echo '-- Nothing to uninstall' ; \
301 check-hierarchy: $(DOC_MODULE).hierarchy
302 @if grep ' ' $(DOC_MODULE).hierarchy; then \
303 echo "$(DOC_MODULE).hierarchy contains tabs, please fix"; \
307 check: check-hierarchy
310 # wildcard is apparently not portable to other makes, hence the use of find
311 inspect_files = $(shell find $(srcdir)/$(INSPECT_DIR) -name '*.xml')
313 check-inspected-versions:
314 @echo Checking plugin versions of inspected plugin data ...; \
316 for each in $(inspect_files) ; do \
317 if (grep -H '<version>' $$each | grep -v '<version>$(VERSION)'); then \
318 echo $$each should be fixed to say version $(VERSION) or be removed ; \
319 echo "sed -i -e 's/<version.*version>/<version>$(VERSION)<\/version>/'" $$each; \
327 $(AM_V_GEN)echo Checking for outdated plugin inspect data ...; \
329 if [ -d $(top_srcdir)/.git/ ]; then \
330 files=`find $(srcdir)/inspect/ -name '*xml'`; \
331 for f in $$files; do \
332 ver=`grep '<version>$(PACKAGE_VERSION)</version>' $$f`; \
333 if test "x$$ver" = "x"; then \
334 plugin=`echo $$f | sed -e 's/^.*plugin-//' -e 's/.xml//'`; \
335 # echo "Checking $$plugin $$f"; \
336 pushd "$(top_srcdir)" >/dev/null; \
337 pinit=`git grep -A3 GST_PLUGIN_DEFINE -- ext/ gst/ sys/ | grep "\"$$plugin\""`; \
339 # echo "[$$pinit]"; \
340 if test "x$$pinit" = "x"; then \
341 printf " **** outdated docs for plugin %-15s: %s\n" $$plugin $$f; \
350 # Require gtk-doc when making dist
356 @echo "*** gtk-doc must be installed and enabled in order to make dist"
360 # FIXME: decide whether we want to dist generated html or not
361 # also this only works, if the project has been build before
362 # we could dist html only if its there, but that might lead to missing html in
364 dist-hook: dist-check-gtkdoc dist-hook-local
365 mkdir $(distdir)/html
366 cp html/* $(distdir)/html
367 -cp $(srcdir)/$(DOC_MODULE).types $(distdir)/
368 -cp $(srcdir)/$(DOC_MODULE)-sections.txt $(distdir)/
369 cd $(distdir) && rm -f $(DISTCLEANFILES)
370 -gtkdoc-rebase --online --relative --html-dir=$(distdir)/html
372 .PHONY : dist-hook-local docs check-outdated-docs inspect
374 # avoid spurious build errors when distchecking with -jN