Change CVS -> git in various places
[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) inspect-update
18         $(MAKE) scanobj-update
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 EXTRA_DIST =                            \
31         scanobj-build.stamp             \
32         $(srcdir)/inspect/*.xml         \
33         inspect.stamp                   \
34         inspect-build.stamp             \
35         $(SCANOBJ_FILES)                \
36         $(content_files)                \
37         $(extra_files)                  \
38         $(HTML_IMAGES)                  \
39         $(DOC_MAIN_SGML_FILE)   \
40         $(DOC_OVERRIDES)                \
41         $(DOC_MODULE)-sections.txt
42
43 MAINTAINER_DOC_STAMPS =                 \
44         scanobj-build.stamp             \
45         inspect-build.stamp             \
46         inspect.stamp
47
48 # we don't add inspect-build.stamp and scanobj-build.stamp here since they are
49 # built manually by docs maintainers and result is commited to git
50 DOC_STAMPS =                            \
51         scan-build.stamp                \
52         tmpl-build.stamp                \
53         sgml-build.stamp                \
54         html-build.stamp                \
55         scan.stamp                      \
56         tmpl.stamp                      \
57         sgml.stamp                      \
58         html.stamp
59
60 # files generated/updated by gtkdoc-scangobj
61 SCANOBJ_FILES =                         \
62         $(DOC_MODULE).signals           \
63         $(DOC_MODULE).hierarchy         \
64         $(DOC_MODULE).interfaces        \
65         $(DOC_MODULE).prerequisites     \
66         $(DOC_MODULE).types             \
67         $(DOC_MODULE).args
68
69 SCANOBJ_FILES_O =                       \
70         .libs/$(DOC_MODULE)-scan.o
71
72 # files generated/updated by gtkdoc-scan
73 SCAN_FILES =                            \
74         $(DOC_MODULE)-sections.txt      \
75         $(DOC_MODULE)-overrides.txt     \
76         $(DOC_MODULE)-undocumented.txt  \
77         $(DOC_MODULE)-decl.txt          \
78         $(DOC_MODULE)-decl-list.txt
79
80
81 REPORT_FILES = \
82         $(DOC_MODULE)-undocumented.txt \
83         $(DOC_MODULE)-undeclared.txt \
84         $(DOC_MODULE)-unused.txt
85
86 # FC3 seems to need -scan.c to be part of CLEANFILES for distcheck
87 # no idea why FC4 can do without
88 CLEANFILES = \
89         $(SCANOBJ_FILES_O) \
90         $(DOC_MODULE)-scan.c \
91         $(REPORT_FILES) \
92         $(DOC_STAMPS) \
93         inspect-registry.xml
94
95
96 if ENABLE_GTK_DOC
97 all-local: html-build.stamp
98
99 #### scan gobjects; done by documentation maintainer ####
100 scanobj-update:
101         -rm scanobj-build.stamp
102         $(MAKE) scanobj-build.stamp
103
104 # in the case of non-srcdir builds, the built gst directory gets added
105 # to gtk-doc scanning; but only then, to avoid duplicates
106 # FIXME: since we don't have the scan step as part of the build anymore,
107 # we could remove that
108 # TODO: finish elite script that updates the output files of this step
109 # instead of rewriting them, so that multiple maintainers can generate
110 # a collective set of args and signals
111 scanobj-build.stamp: $(SCANOBJ_DEPS) $(basefiles)
112         @echo '*** Scanning GObjects ***'
113         if test x"$(srcdir)" != x. ; then                               \
114             for f in $(SCANOBJ_FILES);                                  \
115             do                                                          \
116                 cp $(srcdir)/$$f . ;                                    \
117             done;                                                       \
118         else                                                            \
119             $(INSPECT_ENVIRONMENT)                                      \
120             CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)"                         \
121             CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS)"                         \
122             LDFLAGS="$(GTKDOC_LIBS) $(LDFLAGS)"                         \
123             $(GST_DOC_SCANOBJ) --type-init-func="gst_init(NULL,NULL)"   \
124                 --module=$(DOC_MODULE) --source=$(PACKAGE) &&           \
125                 $(PYTHON)                                               \
126                 $(top_srcdir)/common/scangobj-merge.py $(DOC_MODULE);   \
127         fi
128         touch scanobj-build.stamp
129
130 $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(SCANOBJ_FILES_O): scan-build.stamp
131         @true
132
133 ### inspect GStreamer plug-ins; done by documentation maintainer ###
134
135 # only look at the plugins in this module when building inspect .xml stuff
136 INSPECT_REGISTRY=$(top_builddir)/docs/plugins/inspect-registry.xml
137 INSPECT_ENVIRONMENT=\
138         GST_PLUGIN_SYSTEM_PATH= \
139         GST_PLUGIN_PATH=$(top_builddir)/gst:$(top_builddir)/sys:$(top_builddir)/ext:$(top_builddir)/plugins:$(top_builddir)/src:$(top_builddir)/gnl \
140         GST_REGISTRY=$(INSPECT_REGISTRY)
141
142 # update the element and plugin XML descriptions; store in inspect/
143 inspect:
144         mkdir inspect
145
146 inspect-update: inspect
147         -rm -f $(INSPECT_REGISTRY) inspect-build.stamp
148         $(MAKE) inspect-build.stamp
149
150 # FIXME: inspect.stamp should be written to by gst-xmlinspect.py
151 # IF the output changed; see gtkdoc-mktmpl
152 inspect-build.stamp:
153         @echo '*** Rebuilding plugin inspection files ***'
154         if test x"$(srcdir)" != x. ; then \
155             cp $(srcdir)/inspect.stamp . ; \
156             cp $(srcdir)/inspect-build.stamp . ; \
157         else \
158             $(INSPECT_ENVIRONMENT) $(PYTHON) \
159                 $(top_srcdir)/common/gst-xmlinspect.py $(PACKAGE) inspect && \
160             echo -n "timestamp" > inspect.stamp && \
161             touch inspect-build.stamp; \
162         fi
163
164 ### scan headers; done on every build ###
165 scan-build.stamp: $(HFILE_GLOB) $(EXTRA_HFILES) $(basefiles) scanobj-build.stamp inspect-build.stamp
166         if test "x$(top_srcdir)" != "x$(top_builddir)" &&               \
167            test -d "$(top_builddir)/gst";                               \
168         then                                                            \
169             export BUILT_OPTIONS="--source-dir=$(top_builddir)/gst";    \
170         fi;                                                             \
171         gtkdoc-scan                                                     \
172             $(SCAN_OPTIONS) $(EXTRA_HFILES)                             \
173             --module=$(DOC_MODULE)                                      \
174             $$BUILT_OPTIONS                                             \
175             --ignore-headers="$(IGNORE_HFILES)";                        \
176         touch scan-build.stamp
177
178 #### update templates; done on every build ####
179
180 ### FIXME: make this error out again when docs are fixed for 0.9
181 # in a non-srcdir build, we need to copy files from the previous step
182 # and the files from previous runs of this step
183 tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES)
184         @echo '*** Rebuilding template files ***'
185         if test x"$(srcdir)" != x. ; then                               \
186             for f in $(SCANOBJ_FILES) $(SCAN_FILES);                    \
187             do                                                          \
188                 if test -e $(srcdir)/$$f; then cp $(srcdir)/$$f . ; fi; \
189             done;                                                       \
190         fi
191         gtkdoc-mktmpl --module=$(DOC_MODULE) | tee tmpl-build.log
192         $(PYTHON) \
193                 $(top_srcdir)/common/mangle-tmpl.py $(srcdir)/inspect tmpl
194         @cat $(DOC_MODULE)-unused.txt
195         rm -f tmpl-build.log
196         touch tmpl-build.stamp
197
198 tmpl.stamp: tmpl-build.stamp
199         @true
200
201 #### build xml; done on every build ####
202
203 ### FIXME: make this error out again when docs are fixed for 0.9
204 sgml-build.stamp: tmpl.stamp inspect.stamp $(CFILE_GLOB) $(top_srcdir)/common/plugins.xsl $(expand_content_files)
205         @echo '*** Building XML ***'
206         @-mkdir -p xml
207         @for a in $(srcdir)/inspect/*.xml; do \
208             xsltproc --stringparam module $(MODULE) \
209                 $(top_srcdir)/common/plugins.xsl $$a > xml/`basename $$a`; done
210         @for f in $(EXAMPLE_CFILES); do \
211                 $(PYTHON) $(top_srcdir)/common/c-to-xml.py $$f > xml/element-`basename $$f .c`.xml; done
212         gtkdoc-mkdb \
213                 --module=$(DOC_MODULE) \
214                 --source-dir=$(DOC_SOURCE_DIR) \
215                  --expand-content-files="$(expand_content_files)" \
216                 --main-sgml-file=$(srcdir)/$(DOC_MAIN_SGML_FILE) \
217                 --output-format=xml \
218                 --ignore-files="$(IGNORE_HFILES) $(IGNORE_CFILES)" \
219                 $(MKDB_OPTIONS) \
220                 | tee sgml-build.log
221         @if grep "WARNING:" sgml-build.log > /dev/null; then true; fi # exit 1; fi
222         cp ../version.entities xml
223         rm sgml-build.log
224         touch sgml-build.stamp
225
226 sgml.stamp: sgml-build.stamp
227         @true
228
229 #### build html; done on every step ####
230
231 html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
232         @echo '*** Building HTML ***'
233         if test -d html; then rm -rf html; fi
234         mkdir html
235         cp $(srcdir)/$(DOC_MAIN_SGML_FILE) html
236         @for f in $(content_files); do cp $(srcdir)/$$f html; done
237         cp -pr xml html
238         cp ../version.entities html
239         cd html && gtkdoc-mkhtml $(DOC_MODULE) $(DOC_MAIN_SGML_FILE) \
240             2>&1 | tee ../html-build.log
241         @if grep "warning:" html-build.log > /dev/null; then \
242                 echo "ERROR"; grep "warning:" html-build.log; exit 1; fi
243         @rm html-build.log
244         mv html/index.sgml html/index.sgml.bak
245         $(SED) "s/ href=\"$(DOC_MODULE)\// href=\"$(DOC_MODULE)-@GST_MAJORMINOR@\//g" html/index.sgml.bak >html/index.sgml
246         rm -f html/index.sgml.bak
247         rm -f html/$(DOC_MAIN_SGML_FILE)
248         rm -rf html/xml
249         rm -f html/version.entities
250         test "x$(HTML_IMAGES)" = "x" || for i in "" $(HTML_IMAGES) ; do \
251             if test "$$i" != ""; then cp $(srcdir)/$$i html ; fi; done
252         @echo '-- Fixing Crossreferences'
253         gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
254         touch html-build.stamp
255
256 clean-local-gtkdoc:
257         rm -rf xml tmpl html
258 # clean files copied for nonsrcdir templates build
259         if test x"$(srcdir)" != x. ; then \
260             rm -rf $(SCANOBJ_FILES) $(SCAN_FILES); \
261         fi
262 else
263 all-local:
264 clean-local-gtkdoc:
265 endif
266
267 clean-local: clean-local-gtkdoc
268         rm -f *~ *.bak
269         rm -rf .libs
270
271 distclean-local:
272         rm -rf tmpl/*.sgml.bak
273         rm -rf *.o
274
275 MAINTAINERCLEANFILES = $(MAINTAINER_DOC_STAMPS)
276
277 # thomas: make docs parallel installable; devhelp requires majorminor too
278 install-data-local:
279         (installfiles=`echo $(srcdir)/html/*.sgml $(srcdir)/html/*.html $(srcdir)/html/*.png $(srcdir)/html/*.css`; \
280         if test "$$installfiles" = '$(srcdir)/html/*.sgml $(srcdir)/html/*.html $(srcdir)/html/*.png $(srcdir)/html/*.css'; \
281         then echo '-- Nothing to install' ; \
282         else \
283           $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR); \
284           for i in $$installfiles; do \
285             echo '-- Installing '$$i ; \
286             $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
287           done; \
288           pngfiles=`echo ./html/*.png`; \
289           if test "$$pngfiles" != './html/*.png'; then \
290             for i in $$pngfiles; do \
291               echo '-- Installing '$$i ; \
292               $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
293             done; \
294           fi; \
295           echo '-- Installing $(srcdir)/html/$(DOC_MODULE).devhelp' ; \
296           $(INSTALL_DATA) $(srcdir)/html/$(DOC_MODULE).devhelp \
297             $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp; \
298           if test -e $(srcdir)/html/$(DOC_MODULE).devhelp2; then \
299                     $(INSTALL_DATA) $(srcdir)/html/$(DOC_MODULE).devhelp2 \
300                    $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp2; \
301           fi; \
302           (which gtkdoc-rebase >/dev/null && \
303             gtkdoc-rebase --relative --dest-dir=$(DESTDIR) --html-dir=$(DESTDIR)$(TARGET_DIR)) || true ; \
304         fi)
305 uninstall-local:
306         if test -d $(DESTDIR)$(TARGET_DIR); then \
307           rm -rf $(DESTDIR)$(TARGET_DIR)/*; \
308           rmdir -p $(DESTDIR)$(TARGET_DIR) 2>/dev/null || true; \
309         else \
310           echo '-- Nothing to uninstall' ; \
311         fi;
312
313 #
314 # Checks
315 #
316 check-hierarchy: $(DOC_MODULE).hierarchy
317         @if grep '      ' $(DOC_MODULE).hierarchy; then \
318             echo "$(DOC_MODULE).hierarchy contains tabs, please fix"; \
319             /bin/false; \
320         fi
321
322 check: check-hierarchy
323
324 # wildcard is apparently not portable to other makes, hence the use of find
325 inspect_files = $(shell find $(srcdir)/inspect -name '*.xml')
326
327 check-inspected-versions:
328         @echo Checking plugin versions of inspected plugin data ...; \
329         fail=0 ; \
330         for each in $(inspect_files) ; do \
331           if (grep -H '<version>' $$each | grep -v '<version>$(VERSION)'); then \
332             echo $$each should be fixed to say version $(VERSION) or be removed ; \
333             echo "sed -i -e 's/<version.*version>/<version>$(VERSION)<\/version>/'" $$each; \
334             echo ; \
335             fail=1; \
336           fi ; \
337         done ; \
338         exit $$fail
339
340 #
341 # Require gtk-doc when making dist
342 #
343 if ENABLE_GTK_DOC
344 dist-check-gtkdoc:
345 else
346 dist-check-gtkdoc:
347         @echo "*** gtk-doc must be installed and enabled in order to make dist"
348         @false
349 endif
350
351 # FIXME: decide whether we want to dist generated html or not
352 dist-hook: dist-check-gtkdoc dist-hook-local
353         mkdir $(distdir)/html
354         cp $(srcdir)/html/* $(distdir)/html
355         -cp $(srcdir)/$(DOC_MODULE).types $(distdir)/
356         -cp $(srcdir)/$(DOC_MODULE)-sections.txt $(distdir)/
357         cd $(distdir) && rm -f $(DISTCLEANFILES)
358         -gtkdoc-rebase --online --relative --html-dir=$(distdir)/html
359
360 .PHONY : dist-hook-local docs
361