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)-undocumented.txt \
73 $(DOC_MODULE)-decl.txt \
74 $(DOC_MODULE)-decl-list.txt
78 $(DOC_MODULE)-undocumented.txt \
79 $(DOC_MODULE)-undeclared.txt \
80 $(DOC_MODULE)-unused.txt
82 # FC3 seems to need -scan.c to be part of CLEANFILES for distcheck
83 # no idea why FC4 can do without
86 $(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
100 GST_PLUGIN_SYSTEM_PATH= \
101 GST_PLUGIN_PATH=$(top_builddir)/gst:$(top_builddir)/sys:$(top_builddir)/ext:$(top_builddir)/plugins:$(top_builddir)/src:$(top_builddir)/gnl \
102 GST_REGISTRY=$(INSPECT_REGISTRY) \
103 $(INSPECT_EXTRA_ENVIRONMENT)
105 # update the element and plugin XML descriptions; store in inspect/
109 #### scan gobjects; done by documentation maintainer ####
111 -rm scanobj-build.stamp
112 $(MAKE) scanobj-build.stamp
114 # in the case of non-srcdir builds, the built gst directory gets added
115 # to gtk-doc scanning; but only then, to avoid duplicates
116 # FIXME: since we don't have the scan step as part of the build anymore,
117 # we could remove that
118 # TODO: finish elite script that updates the output files of this step
119 # instead of rewriting them, so that multiple maintainers can generate
120 # a collective set of args and signals
121 scanobj-build.stamp: $(SCANOBJ_DEPS) $(basefiles) inspect
122 @echo '*** Scanning GObjects ***'
123 if test x"$(srcdir)" != x. ; then \
124 for f in $(SCANOBJ_FILES); \
126 cp $(srcdir)/$$f . ; \
129 $(INSPECT_ENVIRONMENT) \
130 CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" \
131 CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS) $(WARNING_CFLAGS)" \
132 LDFLAGS="$(GTKDOC_LIBS) $(LDFLAGS)" \
133 $(GST_DOC_SCANOBJ) --type-init-func="gst_init(NULL,NULL)" \
134 --module=$(DOC_MODULE) --source=$(PACKAGE) --inspect-dir="inspect" && \
136 $(top_srcdir)/common/scangobj-merge.py $(DOC_MODULE); \
138 touch scanobj-build.stamp
140 $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(SCANOBJ_FILES_O): scan-build.stamp
143 ### scan headers; done on every build ###
144 scan-build.stamp: $(HFILE_GLOB) $(EXTRA_HFILES) $(basefiles) scanobj-build.stamp
145 if test "x$(top_srcdir)" != "x$(top_builddir)" && \
146 test -d "$(top_builddir)/gst"; \
148 export BUILT_OPTIONS="--source-dir=$(top_builddir)/gst"; \
151 $(SCAN_OPTIONS) $(EXTRA_HFILES) \
152 --module=$(DOC_MODULE) \
154 --ignore-headers="$(IGNORE_HFILES)"; \
155 touch scan-build.stamp
157 #### update templates; done on every build ####
159 ### FIXME: make this error out again when docs are fixed for 0.9
160 # in a non-srcdir build, we need to copy files from the previous step
161 # and the files from previous runs of this step
162 tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES)
163 @echo '*** Rebuilding template files ***'
164 if test x"$(srcdir)" != x. ; then \
165 for f in $(SCANOBJ_FILES) $(SCAN_FILES); \
167 if test -e $(srcdir)/$$f; then cp $(srcdir)/$$f . ; fi; \
170 gtkdoc-mktmpl --module=$(DOC_MODULE) | tee tmpl-build.log
172 $(top_srcdir)/common/mangle-tmpl.py $(srcdir)/inspect tmpl
173 @cat $(DOC_MODULE)-unused.txt
175 touch tmpl-build.stamp
177 tmpl.stamp: tmpl-build.stamp
180 #### build xml; done on every build ####
182 ### FIXME: make this error out again when docs are fixed for 0.9
183 sgml-build.stamp: tmpl.stamp scan-build.stamp $(CFILE_GLOB) $(top_srcdir)/common/plugins.xsl $(expand_content_files)
184 @echo '*** Building XML ***'
186 @for a in $(srcdir)/inspect/*.xml; do \
187 xsltproc --stringparam module $(MODULE) \
188 $(top_srcdir)/common/plugins.xsl $$a > xml/`basename $$a`; done
189 @for f in $(EXAMPLE_CFILES); do \
190 $(PYTHON) $(top_srcdir)/common/c-to-xml.py $$f > xml/element-`basename $$f .c`.xml; done
192 --module=$(DOC_MODULE) \
193 --source-dir=$(DOC_SOURCE_DIR) \
194 --expand-content-files="$(expand_content_files)" \
195 --main-sgml-file=$(srcdir)/$(DOC_MAIN_SGML_FILE) \
196 --output-format=xml \
197 --ignore-files="$(IGNORE_HFILES) $(IGNORE_CFILES)" \
200 @if grep "WARNING:" sgml-build.log > /dev/null; then true; fi # exit 1; fi
201 cp ../version.entities xml
203 touch sgml-build.stamp
205 sgml.stamp: sgml-build.stamp
208 #### build html; done on every step ####
210 html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
211 @echo '*** Building HTML ***'
212 if test -d html; then rm -rf html; fi
214 cp $(srcdir)/$(DOC_MAIN_SGML_FILE) html
215 @for f in $(content_files); do cp $(srcdir)/$$f html; done
217 cp ../version.entities html
218 cd html && gtkdoc-mkhtml $(DOC_MODULE) $(DOC_MAIN_SGML_FILE)
219 mv html/index.sgml html/index.sgml.bak
220 $(SED) "s/ href=\"$(DOC_MODULE)\// href=\"$(DOC_MODULE)-@GST_MAJORMINOR@\//g" html/index.sgml.bak >html/index.sgml
221 rm -f html/index.sgml.bak
222 rm -f html/$(DOC_MAIN_SGML_FILE)
224 rm -f html/version.entities
225 test "x$(HTML_IMAGES)" = "x" || for i in "" $(HTML_IMAGES) ; do \
226 if test "$$i" != ""; then cp $(srcdir)/$$i html ; fi; done
227 @echo '-- Fixing Crossreferences'
228 gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
229 touch html-build.stamp
233 # clean files copied for nonsrcdir templates build
234 if test x"$(srcdir)" != x. ; then \
235 rm -rf $(SCANOBJ_FILES) $(SCAN_FILES) $(MAINTAINER_DOC_STAMPS); \
242 clean-local: clean-local-gtkdoc
247 rm -rf tmpl/*.sgml.bak
250 MAINTAINERCLEANFILES = $(MAINTAINER_DOC_STAMPS)
252 # thomas: make docs parallel installable; devhelp requires majorminor too
254 (installfiles=`echo $(srcdir)/html/*.sgml $(srcdir)/html/*.html $(srcdir)/html/*.png $(srcdir)/html/*.css`; \
255 if test "$$installfiles" = '$(srcdir)/html/*.sgml $(srcdir)/html/*.html $(srcdir)/html/*.png $(srcdir)/html/*.css'; \
256 then echo '-- Nothing to install' ; \
258 $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR); \
259 for i in $$installfiles; do \
260 echo '-- Installing '$$i ; \
261 $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
263 pngfiles=`echo ./html/*.png`; \
264 if test "$$pngfiles" != './html/*.png'; then \
265 for i in $$pngfiles; do \
266 echo '-- Installing '$$i ; \
267 $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
270 echo '-- Installing $(srcdir)/html/$(DOC_MODULE).devhelp' ; \
271 $(INSTALL_DATA) $(srcdir)/html/$(DOC_MODULE).devhelp \
272 $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp; \
273 if test -e $(srcdir)/html/$(DOC_MODULE).devhelp2; then \
274 $(INSTALL_DATA) $(srcdir)/html/$(DOC_MODULE).devhelp2 \
275 $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp2; \
277 (which gtkdoc-rebase >/dev/null && \
278 gtkdoc-rebase --relative --dest-dir=$(DESTDIR) --html-dir=$(DESTDIR)$(TARGET_DIR)) || true ; \
281 if test -d $(DESTDIR)$(TARGET_DIR); then \
282 rm -rf $(DESTDIR)$(TARGET_DIR)/*; \
283 rmdir -p $(DESTDIR)$(TARGET_DIR) 2>/dev/null || true; \
285 echo '-- Nothing to uninstall' ; \
291 check-hierarchy: $(DOC_MODULE).hierarchy
292 @if grep ' ' $(DOC_MODULE).hierarchy; then \
293 echo "$(DOC_MODULE).hierarchy contains tabs, please fix"; \
297 check: check-hierarchy
299 # wildcard is apparently not portable to other makes, hence the use of find
300 inspect_files = $(shell find $(srcdir)/inspect -name '*.xml')
302 check-inspected-versions:
303 @echo Checking plugin versions of inspected plugin data ...; \
305 for each in $(inspect_files) ; do \
306 if (grep -H '<version>' $$each | grep -v '<version>$(VERSION)'); then \
307 echo $$each should be fixed to say version $(VERSION) or be removed ; \
308 echo "sed -i -e 's/<version.*version>/<version>$(VERSION)<\/version>/'" $$each; \
316 $(AM_V_GEN)echo Checking for outdated plugin inspect data ...; \
318 if [ -d $(top_srcdir)/.git/ ]; then \
319 files=`find $(srcdir)/inspect/ -name '*xml'`; \
320 for f in $$files; do \
321 ver=`grep '<version>$(PACKAGE_VERSION)</version>' $$f`; \
322 if test "x$$ver" = "x"; then \
323 plugin=`echo $$f | sed -e 's/^.*plugin-//' -e 's/.xml//'`; \
324 # echo "Checking $$plugin $$f"; \
325 pushd "$(top_srcdir)" >/dev/null; \
326 pinit=`git grep -A3 GST_PLUGIN_DEFINE -- ext/ gst/ sys/ | grep "\"$$plugin\""`; \
328 # echo "[$$pinit]"; \
329 if test "x$$pinit" = "x"; then \
330 printf " **** outdated docs for plugin %-15s: %s\n" $$plugin $$f; \
339 # Require gtk-doc when making dist
345 @echo "*** gtk-doc must be installed and enabled in order to make dist"
349 # FIXME: decide whether we want to dist generated html or not
350 # also this only works, if the project has been build before
351 # we could dist html only if its there, but that might lead to missing html in
353 dist-hook: dist-check-gtkdoc dist-hook-local
354 mkdir $(distdir)/html
355 cp html/* $(distdir)/html
356 -cp $(srcdir)/$(DOC_MODULE).types $(distdir)/
357 -cp $(srcdir)/$(DOC_MODULE)-sections.txt $(distdir)/
358 cd $(distdir) && rm -f $(DISTCLEANFILES)
359 -gtkdoc-rebase --online --relative --html-dir=$(distdir)/html
361 .PHONY : dist-hook-local docs check-outdated-docs
363 # avoid spurious build errors when distchecking with -jN