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
59 $(DOC_MODULE).hierarchy \
60 $(DOC_MODULE).interfaces \
61 $(DOC_MODULE).prerequisites \
62 $(DOC_MODULE).signals \
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
90 all-local: html-build.stamp
92 ### inspect GStreamer plug-ins; done by documentation maintainer ###
94 # only look at the plugins in this module when building inspect .xml stuff
95 INSPECT_REGISTRY=$(top_builddir)/docs/plugins/inspect-registry.xml
98 GST_PLUGIN_SYSTEM_PATH= \
99 GST_PLUGIN_PATH=$(top_builddir)/gst:$(top_builddir)/sys:$(top_builddir)/ext:$(top_builddir)/plugins:$(top_builddir)/src:$(top_builddir)/gnl \
100 GST_REGISTRY=$(INSPECT_REGISTRY) \
101 PKG_CONFIG_PATH="$(GST_PKG_CONFIG_PATH)" \
102 $(INSPECT_EXTRA_ENVIRONMENT)
104 #### scan gobjects; done by documentation maintainer ####
106 -rm scanobj-build.stamp
107 $(MAKE) scanobj-build.stamp
109 # TODO: finish elite script that updates the output files of this step
110 # instead of rewriting them, so that multiple maintainers can generate
111 # a collective set of args and signals
112 scanobj-build.stamp: $(SCANOBJ_DEPS) $(basefiles)
113 @echo " DOC Introspecting gobjects"
114 @if test x"$(srcdir)" != x. ; then \
115 for f in $(SCANOBJ_FILES) $(SCAN_FILES); \
117 if test -e $(srcdir)/$$f; then cp -u $(srcdir)/$$f . ; fi; \
120 mkdir -p $(INSPECT_DIR); \
121 scanobj_options=""; \
122 if test "x$(V)" = "x1"; then \
123 scanobj_options="--verbose"; \
125 $(INSPECT_ENVIRONMENT) \
126 CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" \
127 CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS) $(WARNING_CFLAGS)" \
128 LDFLAGS="$(GTKDOC_LIBS) $(LDFLAGS)" \
129 $(GST_DOC_SCANOBJ) $$scanobj_options --type-init-func="gst_init(NULL,NULL)" \
130 --module=$(DOC_MODULE) --source=$(PACKAGE) --inspect-dir=$(INSPECT_DIR) && \
131 echo " DOC Merging introspection data" && \
133 $(top_srcdir)/common/scangobj-merge.py $(DOC_MODULE); \
134 if test x"$(srcdir)" != x. ; then \
135 for f in $(SCANOBJ_FILES); \
137 cmp -s ./$$f $(srcdir)/$$f || cp ./$$f $(srcdir)/ ; \
140 touch scanobj-build.stamp
142 $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(SCANOBJ_FILES_O): scan-build.stamp
145 ### scan headers; done on every build ###
146 scan-build.stamp: $(HFILE_GLOB) $(EXTRA_HFILES) $(basefiles) scanobj-build.stamp
147 @echo ' DOC Scanning header files'
149 $(SCAN_OPTIONS) $(EXTRA_HFILES) \
150 --module=$(DOC_MODULE) \
151 --source-dir=$(DOC_SOURCE_DIR) \
152 --ignore-headers="$(IGNORE_HFILES)"; \
153 touch scan-build.stamp
155 #### update templates; done on every build ####
157 # in a non-srcdir build, we need to copy files from the previous step
158 # and the files from previous runs of this step
159 tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES)
160 @echo ' DOC Rebuilding template files'
161 @if test x"$(srcdir)" != x. ; then \
162 for f in $(SCANOBJ_FILES) $(SCAN_FILES); \
164 if test -e $(srcdir)/$$f; then cp -u $(srcdir)/$$f . ; fi; \
167 @gtkdoc-mktmpl --module=$(DOC_MODULE)
169 $(top_srcdir)/common/mangle-tmpl.py $(srcdir)/$(INSPECT_DIR) tmpl
170 @touch tmpl-build.stamp
172 tmpl.stamp: tmpl-build.stamp
177 sgml-build.stamp: tmpl.stamp scan-build.stamp $(CFILE_GLOB) $(top_srcdir)/common/plugins.xsl $(expand_content_files)
178 @echo ' DOC Building XML'
180 @for a in $(srcdir)/$(INSPECT_DIR)/*.xml; do \
181 xsltproc --stringparam module $(MODULE) \
182 $(top_srcdir)/common/plugins.xsl $$a > xml/`basename $$a`; done
183 @for f in $(EXAMPLE_CFILES); do \
184 $(PYTHON) $(top_srcdir)/common/c-to-xml.py $$f > xml/element-`basename $$f .c`.xml; done
186 --module=$(DOC_MODULE) \
187 --source-dir=$(DOC_SOURCE_DIR) \
188 --expand-content-files="$(expand_content_files)" \
189 --main-sgml-file=$(srcdir)/$(DOC_MAIN_SGML_FILE) \
190 --output-format=xml \
191 --ignore-files="$(IGNORE_HFILES) $(IGNORE_CFILES)" \
193 @cp ../version.entities xml
194 @touch sgml-build.stamp
196 sgml.stamp: sgml-build.stamp
201 html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
202 @echo ' DOC Building HTML'
205 @cp $(srcdir)/$(DOC_MAIN_SGML_FILE) html
206 @for f in $(content_files); do cp $(srcdir)/$$f html; done
208 @cp ../version.entities html
209 @mkhtml_options=""; \
210 if test "x$(V)" = "x1"; then \
211 mkhtml_options="--verbose"; \
213 cd html && gtkdoc-mkhtml $$mkhtml_options $(DOC_MODULE) $(DOC_MAIN_SGML_FILE)
214 @mv html/index.sgml html/index.sgml.bak
215 @$(SED) "s/ href=\"$(DOC_MODULE)\// href=\"$(DOC_MODULE)-@GST_MAJORMINOR@\//g" html/index.sgml.bak >html/index.sgml
216 @rm -f html/index.sgml.bak
217 @rm -f html/$(DOC_MAIN_SGML_FILE)
219 @rm -f html/version.entities
220 @test "x$(HTML_IMAGES)" = "x" || for i in "" $(HTML_IMAGES) ; do \
221 if test "$$i" != ""; then cp $(srcdir)/$$i html ; fi; done
222 @echo ' DOC Fixing cross-references'
223 @gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
224 @touch html-build.stamp
227 @rm -rf xml tmpl html
228 # clean files copied for nonsrcdir templates build
229 @if test x"$(srcdir)" != x. ; then \
230 rm -rf $(SCANOBJ_FILES) $(SCAN_FILES) $(REPORT_FILES) \
231 $(MAINTAINER_DOC_STAMPS); \
238 clean-local: clean-local-gtkdoc
243 @rm -f $(REPORT_FILES) \
244 $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
245 @rm -rf tmpl/*.sgml.bak
246 @rm -f $(DOC_MODULE).hierarchy
247 @rm -f *.stamp || true
248 @if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
249 rm -f $(DOC_MODULE)-docs.sgml ; \
250 rm -f $(DOC_MODULE).types ; \
251 rm -f $(DOC_MODULE).interfaces ; \
252 rm -f $(DOC_MODULE)-overrides.txt ; \
253 rm -f $(DOC_MODULE).prerequisites ; \
254 rm -f $(DOC_MODULE)-sections.txt ; \
255 rm -rf tmpl/*.sgml ; \
256 rm -rf $(INSPECT_DIR); \
260 MAINTAINERCLEANFILES = $(MAINTAINER_DOC_STAMPS)
262 # thomas: make docs parallel installable; devhelp requires majorminor too
264 (installfiles=`echo $(builddir)/html/*.sgml $(builddir)/html/*.html $(builddir)/html/*.png $(builddir)/html/*.css`; \
265 if test "$$installfiles" = '$(builddir)/html/*.sgml $(builddir)/html/*.html $(builddir)/html/*.png $(builddir)/html/*.css'; \
266 then echo '-- Nothing to install' ; \
268 $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR); \
269 for i in $$installfiles; do \
270 echo '-- Installing '$$i ; \
271 $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
273 pngfiles=`echo ./html/*.png`; \
274 if test "$$pngfiles" != './html/*.png'; then \
275 for i in $$pngfiles; do \
276 echo '-- Installing '$$i ; \
277 $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
280 echo '-- Installing $(builddir)/html/$(DOC_MODULE).devhelp2' ; \
281 if test -e $(builddir)/html/$(DOC_MODULE).devhelp2; then \
282 $(INSTALL_DATA) $(builddir)/html/$(DOC_MODULE).devhelp2 \
283 $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp2; \
285 (which gtkdoc-rebase >/dev/null && \
286 gtkdoc-rebase --relative --dest-dir=$(DESTDIR) --html-dir=$(DESTDIR)$(TARGET_DIR)) || true ; \
289 if test -d $(DESTDIR)$(TARGET_DIR); then \
290 rm -rf $(DESTDIR)$(TARGET_DIR)/*; \
291 rmdir -p $(DESTDIR)$(TARGET_DIR) 2>/dev/null || true; \
293 echo '-- Nothing to uninstall' ; \
300 check-hierarchy: $(DOC_MODULE).hierarchy
301 @if grep ' ' $(DOC_MODULE).hierarchy; then \
302 echo "$(DOC_MODULE).hierarchy contains tabs, please fix"; \
306 check: check-hierarchy
309 # wildcard is apparently not portable to other makes, hence the use of find
310 inspect_files = $(shell find $(srcdir)/$(INSPECT_DIR) -name '*.xml')
312 check-inspected-versions:
313 @echo Checking plugin versions of inspected plugin data ...; \
315 for each in $(inspect_files) ; do \
316 if (grep -H '<version>' $$each | grep -v '<version>$(VERSION)'); then \
317 echo $$each should be fixed to say version $(VERSION) or be removed ; \
318 echo "sed -i -e 's/<version.*version>/<version>$(VERSION)<\/version>/'" $$each; \
326 $(AM_V_GEN)echo Checking for outdated plugin inspect data ...; \
328 if [ -d $(top_srcdir)/.git/ ]; then \
329 files=`find $(srcdir)/inspect/ -name '*xml'`; \
330 for f in $$files; do \
331 ver=`grep '<version>$(PACKAGE_VERSION)</version>' $$f`; \
332 if test "x$$ver" = "x"; then \
333 plugin=`echo $$f | sed -e 's/^.*plugin-//' -e 's/.xml//'`; \
334 # echo "Checking $$plugin $$f"; \
335 pushd "$(top_srcdir)" >/dev/null; \
336 pinit=`git grep -A3 GST_PLUGIN_DEFINE -- ext/ gst/ sys/ | grep "\"$$plugin\""`; \
338 # echo "[$$pinit]"; \
339 if test "x$$pinit" = "x"; then \
340 printf " **** outdated docs for plugin %-15s: %s\n" $$plugin $$f; \
349 # Require gtk-doc when making dist
355 @echo "*** gtk-doc must be installed and enabled in order to make dist"
359 # FIXME: decide whether we want to dist generated html or not
360 # also this only works, if the project has been build before
361 # we could dist html only if its there, but that might lead to missing html in
363 dist-hook: dist-check-gtkdoc dist-hook-local
364 mkdir $(distdir)/html
365 cp html/* $(distdir)/html
366 -cp $(srcdir)/$(DOC_MODULE).types $(distdir)/
367 -cp $(srcdir)/$(DOC_MODULE)-sections.txt $(distdir)/
368 cd $(distdir) && rm -f $(DISTCLEANFILES)
369 -gtkdoc-rebase --online --relative --html-dir=$(distdir)/html
371 .PHONY : dist-hook-local docs check-outdated-docs inspect
373 # avoid spurious build errors when distchecking with -jN