plugin-docs: also allow updating docs in out-of-srcdir setup
[platform/upstream/gst-common.git] / gtk-doc-plugins.mak
1 # This is an include file specifically tuned for building documentation
2 # for GStreamer plug-ins
3
4 help:
5         @echo
6         @echo "If you are a doc maintainer, run 'make update' to update"
7         @echo "the documentation files maintained in git"
8         @echo
9         @echo Other useful make targets:
10         @echo
11         @echo  check-inspected-versions: make sure the inspected plugin info
12         @echo                            is up to date before a release
13         @echo
14
15 # update the stuff maintained by doc maintainers
16 update:
17         $(MAKE) scanobj-update
18         $(MAKE) check-outdated-docs
19
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.
24 #
25 GPATH = $(srcdir)
26
27 # thomas: make docs parallel installable
28 TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@
29
30 MAINTAINER_DOC_STAMPS =                 \
31         scanobj-build.stamp
32
33 EXTRA_DIST =                            \
34         $(MAINTAINER_DOC_STAMPS)                \
35         $(srcdir)/inspect/*.xml         \
36         $(SCANOBJ_FILES)                \
37         $(content_files)                \
38         $(extra_files)                  \
39         $(HTML_IMAGES)                  \
40         $(DOC_MAIN_SGML_FILE)   \
41         $(DOC_OVERRIDES)                \
42         $(DOC_MODULE)-sections.txt
43
44 # we don't add scanobj-build.stamp here since they are built manually by docs
45 # maintainers and result is commited to git
46 DOC_STAMPS =                            \
47         scan-build.stamp                \
48         tmpl-build.stamp                \
49         sgml-build.stamp                \
50         html-build.stamp                \
51         scan.stamp                      \
52         tmpl.stamp                      \
53         sgml.stamp                      \
54         html.stamp
55
56 # files generated/updated by gtkdoc-scangobj
57 SCANOBJ_FILES =                         \
58         $(DOC_MODULE).signals           \
59         $(DOC_MODULE).hierarchy         \
60         $(DOC_MODULE).interfaces        \
61         $(DOC_MODULE).prerequisites     \
62         $(DOC_MODULE).types             \
63         $(DOC_MODULE).args
64
65 SCANOBJ_FILES_O =                       \
66         .libs/$(DOC_MODULE)-scan.o
67
68 # files generated/updated by gtkdoc-scan
69 SCAN_FILES =                            \
70         $(DOC_MODULE)-sections.txt      \
71         $(DOC_MODULE)-overrides.txt     \
72         $(DOC_MODULE)-decl.txt          \
73         $(DOC_MODULE)-decl-list.txt
74
75
76 REPORT_FILES = \
77         $(DOC_MODULE)-undocumented.txt \
78         $(DOC_MODULE)-undeclared.txt \
79         $(DOC_MODULE)-unused.txt
80
81 # FC3 seems to need -scan.c to be part of CLEANFILES for distcheck
82 # no idea why FC4 can do without
83 CLEANFILES = \
84         $(SCANOBJ_FILES_O) \
85         $(DOC_MODULE)-scan.c \
86         $(REPORT_FILES) \
87         $(DOC_STAMPS) \
88         inspect-registry.xml
89
90 INSPECT_DIR = inspect
91
92 if ENABLE_GTK_DOC
93 all-local: html-build.stamp
94
95 ### inspect GStreamer plug-ins; done by documentation maintainer ###
96
97 # only look at the plugins in this module when building inspect .xml stuff
98 INSPECT_REGISTRY=$(top_builddir)/docs/plugins/inspect-registry.xml
99 INSPECT_ENVIRONMENT=\
100         LC_ALL=C \
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)
106
107 # update the element and plugin XML descriptions; store in inspect/
108 inspect:
109         @-mkdir -p $(INSPECT_DIR)
110
111 #### scan gobjects; done by documentation maintainer ####
112 scanobj-update:
113         -rm scanobj-build.stamp
114         $(MAKE) scanobj-build.stamp
115
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 '*** Scanning GObjects ***'
121         @if test x"$(srcdir)" != x. ; then                              \
122             for f in $(SCANOBJ_FILES) $(SCAN_FILES);                    \
123             do                                                          \
124                 cp $(srcdir)/$$f . ;                                    \
125             done;                                                       \
126         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) &&          \
133             $(PYTHON)                                           \
134             $(top_srcdir)/common/scangobj-merge.py $(DOC_MODULE);       \
135         if test x"$(srcdir)" != x. ; then                               \
136             for f in $(SCANOBJ_FILES);                                  \
137             do                                                          \
138                 cmp -s ./$$f $(srcdir)/$$f || cp ./$$f $(srcdir)/ ;             \
139             done;                                                       \
140         fi;                                                             \
141         touch scanobj-build.stamp
142
143 $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(SCANOBJ_FILES_O): scan-build.stamp
144         @true
145
146 ### scan headers; done on every build ###
147 scan-build.stamp: $(HFILE_GLOB) $(EXTRA_HFILES) $(basefiles) scanobj-build.stamp
148         @echo '*** Scanning header files ***'
149         gtkdoc-scan                                                     \
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
155
156 #### update templates; done on every build ####
157
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 '*** Rebuilding template files ***'
163         @if test x"$(srcdir)" != x. ; then                              \
164             for f in $(SCANOBJ_FILES) $(SCAN_FILES);                    \
165             do                                                          \
166                 if test -e $(srcdir)/$$f; then cp -u $(srcdir)/$$f . ; fi; \
167             done;                                                       \
168         fi
169         gtkdoc-mktmpl --module=$(DOC_MODULE) | tee tmpl-build.log
170         $(PYTHON) \
171                 $(top_srcdir)/common/mangle-tmpl.py $(srcdir)/$(INSPECT_DIR) tmpl
172         @cat $(DOC_MODULE)-unused.txt
173         @rm -f tmpl-build.log
174         touch tmpl-build.stamp
175
176 tmpl.stamp: tmpl-build.stamp
177         @true
178
179 #### build xml; done on every build ####
180
181 ### FIXME: make this error out again when docs are fixed for 0.9
182 sgml-build.stamp: tmpl.stamp scan-build.stamp $(CFILE_GLOB) $(top_srcdir)/common/plugins.xsl $(expand_content_files)
183         @echo '*** Building XML ***'
184         @-mkdir -p xml
185         @for a in $(srcdir)/$(INSPECT_DIR)/*.xml; do \
186             xsltproc --stringparam module $(MODULE) \
187                 $(top_srcdir)/common/plugins.xsl $$a > xml/`basename $$a`; done
188         @for f in $(EXAMPLE_CFILES); do \
189                 $(PYTHON) $(top_srcdir)/common/c-to-xml.py $$f > xml/element-`basename $$f .c`.xml; done
190         gtkdoc-mkdb \
191                 --module=$(DOC_MODULE) \
192                 --source-dir=$(DOC_SOURCE_DIR) \
193                  --expand-content-files="$(expand_content_files)" \
194                 --main-sgml-file=$(srcdir)/$(DOC_MAIN_SGML_FILE) \
195                 --output-format=xml \
196                 --ignore-files="$(IGNORE_HFILES) $(IGNORE_CFILES)" \
197                 $(MKDB_OPTIONS) \
198                 | tee sgml-build.log
199         @if grep "WARNING:" sgml-build.log > /dev/null; then true; fi # exit 1; fi
200         cp ../version.entities xml
201         rm sgml-build.log
202         touch sgml-build.stamp
203
204 sgml.stamp: sgml-build.stamp
205         @true
206
207 #### build html; done on every step ####
208
209 html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
210         @echo '*** Building HTML ***'
211         if test -d html; then rm -rf html; fi
212         mkdir html
213         cp $(srcdir)/$(DOC_MAIN_SGML_FILE) html
214         @for f in $(content_files); do cp $(srcdir)/$$f html; done
215         cp -pr xml html
216         cp ../version.entities html
217         cd html && gtkdoc-mkhtml $(DOC_MODULE) $(DOC_MAIN_SGML_FILE)
218         mv html/index.sgml html/index.sgml.bak
219         $(SED) "s/ href=\"$(DOC_MODULE)\// href=\"$(DOC_MODULE)-@GST_MAJORMINOR@\//g" html/index.sgml.bak >html/index.sgml
220         rm -f html/index.sgml.bak
221         rm -f html/$(DOC_MAIN_SGML_FILE)
222         rm -rf html/xml
223         rm -f html/version.entities
224         test "x$(HTML_IMAGES)" = "x" || for i in "" $(HTML_IMAGES) ; do \
225             if test "$$i" != ""; then cp $(srcdir)/$$i html ; fi; done
226         @echo '-- Fixing Crossreferences'
227         gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
228         touch html-build.stamp
229
230 clean-local-gtkdoc:
231         rm -rf xml tmpl html
232 # clean files copied for nonsrcdir templates build
233         if test x"$(srcdir)" != x. ; then \
234             rm -rf $(SCANOBJ_FILES) $(SCAN_FILES) $(REPORT_FILES) \
235                 $(MAINTAINER_DOC_STAMPS); \
236         fi
237 else
238 all-local:
239 clean-local-gtkdoc:
240 endif
241
242 clean-local: clean-local-gtkdoc
243         rm -f *~ *.bak
244         rm -rf .libs
245
246 distclean-local:
247         rm -f $(REPORT_FILES) \
248                 $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
249         rm -rf tmpl/*.sgml.bak
250         rm -f $(DOC_MODULE).hierarchy
251         rm -f *.stamp || true
252         if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
253             rm -f $(DOC_MODULE)-docs.sgml ; \
254             rm -f $(DOC_MODULE).types ; \
255             rm -f $(DOC_MODULE).interfaces ; \
256             rm -f $(DOC_MODULE)-overrides.txt ; \
257             rm -f $(DOC_MODULE).prerequisites ; \
258             rm -f $(DOC_MODULE)-sections.txt ; \
259             rm -rf tmpl/*.sgml ; \
260         fi
261         rm -rf *.o
262
263 MAINTAINERCLEANFILES = $(MAINTAINER_DOC_STAMPS)
264
265 # thomas: make docs parallel installable; devhelp requires majorminor too
266 install-data-local:
267         (installfiles=`echo $(builddir)/html/*.sgml $(builddir)/html/*.html $(builddir)/html/*.png $(builddir)/html/*.css`; \
268         if test "$$installfiles" = '$(builddir)/html/*.sgml $(builddir)/html/*.html $(builddir)/html/*.png $(builddir)/html/*.css'; \
269         then echo '-- Nothing to install' ; \
270         else \
271           $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR); \
272           for i in $$installfiles; do \
273             echo '-- Installing '$$i ; \
274             $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
275           done; \
276           pngfiles=`echo ./html/*.png`; \
277           if test "$$pngfiles" != './html/*.png'; then \
278             for i in $$pngfiles; do \
279               echo '-- Installing '$$i ; \
280               $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
281             done; \
282           fi; \
283           echo '-- Installing $(builddir)/html/$(DOC_MODULE).devhelp' ; \
284           $(INSTALL_DATA) $(builddir)/html/$(DOC_MODULE).devhelp \
285             $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp; \
286           if test -e $(builddir)/html/$(DOC_MODULE).devhelp2; then \
287                     $(INSTALL_DATA) $(builddir)/html/$(DOC_MODULE).devhelp2 \
288                     $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp2; \
289           fi; \
290           (which gtkdoc-rebase >/dev/null && \
291             gtkdoc-rebase --relative --dest-dir=$(DESTDIR) --html-dir=$(DESTDIR)$(TARGET_DIR)) || true ; \
292         fi)
293 uninstall-local:
294         if test -d $(DESTDIR)$(TARGET_DIR); then \
295           rm -rf $(DESTDIR)$(TARGET_DIR)/*; \
296           rmdir -p $(DESTDIR)$(TARGET_DIR) 2>/dev/null || true; \
297         else \
298           echo '-- Nothing to uninstall' ; \
299         fi;
300
301 #
302 # Checks
303 #
304 check-hierarchy: $(DOC_MODULE).hierarchy
305         @if grep '      ' $(DOC_MODULE).hierarchy; then \
306             echo "$(DOC_MODULE).hierarchy contains tabs, please fix"; \
307             /bin/false; \
308         fi
309
310 check: check-hierarchy
311
312 # wildcard is apparently not portable to other makes, hence the use of find
313 inspect_files = $(shell find $(srcdir)/$(INSPECT_DIR) -name '*.xml')
314
315 check-inspected-versions:
316         @echo Checking plugin versions of inspected plugin data ...; \
317         fail=0 ; \
318         for each in $(inspect_files) ; do \
319           if (grep -H '<version>' $$each | grep -v '<version>$(VERSION)'); then \
320             echo $$each should be fixed to say version $(VERSION) or be removed ; \
321             echo "sed -i -e 's/<version.*version>/<version>$(VERSION)<\/version>/'" $$each; \
322             echo ; \
323             fail=1; \
324           fi ; \
325         done ; \
326         exit $$fail
327
328 check-outdated-docs:
329         $(AM_V_GEN)echo Checking for outdated plugin inspect data ...; \
330         fail=0 ; \
331         if [ -d $(top_srcdir)/.git/ ]; then \
332           files=`find $(srcdir)/inspect/ -name '*xml'`; \
333           for f in $$files; do \
334             ver=`grep '<version>$(PACKAGE_VERSION)</version>' $$f`; \
335             if test "x$$ver" = "x"; then \
336               plugin=`echo $$f | sed -e 's/^.*plugin-//' -e 's/.xml//'`; \
337               # echo "Checking $$plugin $$f"; \
338               pushd "$(top_srcdir)" >/dev/null; \
339               pinit=`git grep -A3 GST_PLUGIN_DEFINE -- ext/ gst/ sys/ | grep "\"$$plugin\""`; \
340               popd >/dev/null; \
341               # echo "[$$pinit]"; \
342               if test "x$$pinit" = "x"; then \
343                 printf " **** outdated docs for plugin %-15s: %s\n" $$plugin $$f; \
344                 fail=1; \
345               fi; \
346             fi; \
347           done; \
348         fi ; \
349         exit $$fail
350
351 #
352 # Require gtk-doc when making dist
353 #
354 if ENABLE_GTK_DOC
355 dist-check-gtkdoc:
356 else
357 dist-check-gtkdoc:
358         @echo "*** gtk-doc must be installed and enabled in order to make dist"
359         @false
360 endif
361
362 # FIXME: decide whether we want to dist generated html or not
363 # also this only works, if the project has been build before
364 # we could dist html only if its there, but that might lead to missing html in
365 # tarballs
366 dist-hook: dist-check-gtkdoc dist-hook-local
367         mkdir $(distdir)/html
368         cp html/* $(distdir)/html
369         -cp $(srcdir)/$(DOC_MODULE).types $(distdir)/
370         -cp $(srcdir)/$(DOC_MODULE)-sections.txt $(distdir)/
371         cd $(distdir) && rm -f $(DISTCLEANFILES)
372         -gtkdoc-rebase --online --relative --html-dir=$(distdir)/html
373
374 .PHONY : dist-hook-local docs check-outdated-docs inspect
375
376 # avoid spurious build errors when distchecking with -jN
377 .NOTPARALLEL: