1 ###########################################################################
2 # Everything below here is generic and you shouldn't need to change it.
3 ###########################################################################
4 # thomas: except of course that we did
6 # thomas: copied from glib-2
7 # We set GPATH here; this gives us semantics for GNU make
8 # which are more like other make's VPATH, when it comes to
9 # whether a source that is a target of one rule is then
10 # searched for in VPATH/GPATH.
14 # thomas: make docs parallel installable
15 TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@
21 $(DOC_MAIN_SGML_FILE) \
24 $(DOC_MODULE)-sections.txt
31 $(srcdir)/tmpl.stamp \
32 $(srcdir)/sgml.stamp \
37 $(DOC_MODULE).hierarchy \
38 $(DOC_MODULE).interfaces \
39 $(DOC_MODULE).prerequisites \
40 .libs/$(DOC_MODULE)-scan.o \
44 $(DOC_MODULE)-undocumented.txt \
45 $(DOC_MODULE)-undeclared.txt \
46 $(DOC_MODULE)-unused.txt
48 CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS)
51 all-local: html-build.stamp
55 # in the case of non-srcdir builds, the built gst directory gets added
56 # to gtk-doc scanning; but only then, to avoid duplicates
57 scan-build.stamp: $(HFILE_GLOB) $(SCANOBJ_DEPS) $(basefiles)
58 @echo '*** Scanning header files ***'
59 if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null; \
61 if test x"$(srcdir)" != x. ; then \
62 cp $(srcdir)/$(DOC_MODULE).types . ; \
63 chmod u+w $(DOC_MODULE).types ; \
65 GST_PLUGIN_SYSTEM_PATH=`cd $(top_builddir) && pwd` \
67 CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" \
68 CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" \
69 gtkdoc-scangobj --type-init-func="gst_init(NULL,NULL)" \
70 --module=$(DOC_MODULE) ; \
73 for i in $(SCANOBJ_FILES) ; do \
74 test -f $$i || touch $$i ; \
77 if test "x$(top_srcdir)" != "x$(top_builddir)"; \
79 export BUILT_OPTIONS="--source-dir=$(DOC_BUILD_DIR)"; \
82 $(SCAN_OPTIONS) $(EXTRA_HFILES) \
83 --module=$(DOC_MODULE) \
84 --source-dir=$(DOC_SOURCE_DIR) \
86 --ignore-headers="$(IGNORE_HFILES)"
87 touch scan-build.stamp
89 $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp
94 tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES)
95 @echo '*** Rebuilding template files ***'
96 if test x"$(srcdir)" != x. ; then \
97 cp $(srcdir)/$(DOC_MODULE)-sections.txt . ; \
98 touch $(DOC_MODULE)-decl.txt ; \
100 gtkdoc-mktmpl --module=$(DOC_MODULE) | tee tmpl-build.log
101 @if test -s $(DOC_MODULE)-unused.txt; then \
102 exit $(if $(DOCS_ARE_INCOMPLETE_PLEASE_FIXME),0,1); fi
104 touch tmpl-build.stamp
106 tmpl.stamp: tmpl-build.stamp
111 ### FIXME: make this error out again when docs are complete
112 sgml-build.stamp: tmpl.stamp $(CFILE_GLOB)
113 @echo '*** Building XML ***'
114 gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --main-sgml-file=$(srcdir)/$(DOC_MAIN_SGML_FILE) --output-format=xml $(MKDB_OPTIONS) | tee sgml-build.log
115 @if grep "WARNING:" sgml-build.log > /dev/null; then true; fi # exit 1; fi
117 touch sgml-build.stamp
119 sgml.stamp: sgml-build.stamp
124 html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
125 @echo '*** Building HTML ***'
126 if test -d html; then rm -rf html; fi
128 cp $(srcdir)/$(DOC_MAIN_SGML_FILE) html
129 @for f in $(content_files); do cp $(srcdir)/$$f html; done
131 cp ../version.entities html
132 cd html && gtkdoc-mkhtml $(DOC_MODULE) $(DOC_MAIN_SGML_FILE)
133 mv html/index.sgml html/index.sgml.bak
134 $(SED) "s/ href=\"$(DOC_MODULE)\// href=\"$(DOC_MODULE)-@GST_MAJORMINOR@\//g" html/index.sgml.bak >html/index.sgml
135 rm -f html/index.sgml.bak
136 rm -f html/$(DOC_MAIN_SGML_FILE)
138 rm -f html/version.entities
139 test "x$(HTML_IMAGES)" = "x" || for i in "" $(HTML_IMAGES) ; do \
140 if test "$$i" != ""; then cp $(srcdir)/$$i html ; fi; done
141 @echo '-- Fixing Crossreferences'
142 gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
143 touch html-build.stamp
153 maintainer-clean-local: clean
154 cd $(srcdir) && rm -rf xml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
156 # company: don't delete .sgml and -sections.txt as they're in CVS
157 # FIXME : thomas added all sgml files and some other things to make
158 # make distcheck work
159 distclean-local: clean
160 rm -f $(DOC_MODULE)-decl-list.txt
161 rm -f $(DOC_MODULE)-decl.txt
162 rm -f $(REPORT_FILES)
163 rm -rf tmpl/*.sgml.bak
164 rm -f $(DOC_MODULE).hierarchy
165 rm -f *.stamp || true
166 if test x"$(srcdir)" != x. ; then \
167 rm -f $(DOC_MODULE)-docs.sgml ; \
168 rm -f $(DOC_MODULE).types ; \
169 rm -f $(DOC_MODULE).interfaces ; \
170 rm -f $(DOC_MODULE)-overrides.txt ; \
171 rm -f $(DOC_MODULE).prerequisites ; \
172 rm -f $(DOC_MODULE)-sections.txt ; \
173 rm -rf tmpl/*.sgml ; \
177 # thomas: make docs parallel installable; devhelp requires majorminor too
179 $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
180 (installfiles=`echo ./html/*.html`; \
181 if test "$$installfiles" = './html/*.html'; \
182 then echo '-- Nothing to install' ; \
184 for i in $$installfiles; do \
185 echo '-- Installing '$$i ; \
186 $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
188 pngfiles=`echo ./html/*.png`; \
189 if test "$$pngfiles" != './html/*.png'; then \
190 for i in $$pngfiles; do \
191 echo '-- Installing '$$i ; \
192 $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
195 echo '-- Installing $(srcdir)/html/$(DOC_MODULE).devhelp' ; \
196 $(INSTALL_DATA) $(srcdir)/html/$(DOC_MODULE).devhelp \
197 $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp; \
198 if test -e $(srcdir)/html/$(DOC_MODULE).devhelp2; then \
199 $(INSTALL_DATA) $(srcdir)/html/$(DOC_MODULE).devhelp2 \
200 $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp2; \
202 echo '-- Installing $(srcdir)/html/index.sgml' ; \
203 $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
204 if test -e $(srcdir)/html/style.css; then \
205 echo '-- Installing $(srcdir)/html/style.css' ; \
206 $(INSTALL_DATA) $(srcdir)/html/style.css $(DESTDIR)$(TARGET_DIR); \
210 (installfiles=`echo ./html/*.html`; \
211 if test "$$installfiles" = './html/*.html'; \
212 then echo '-- Nothing to uninstall' ; \
214 for i in $$installfiles; do \
215 rmfile=`basename $$i` ; \
216 echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/'$$rmfile ; \
217 rm -f $(DESTDIR)$(TARGET_DIR)/$$rmfile; \
219 pngfiles=`echo ./html/*.png`; \
220 if test "$$pngfiles" != './html/*.png'; then \
221 for i in $$pngfiles; do \
222 rmfile=`basename $$i` ; \
223 echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/'$$rmfile ; \
224 rm -f $(DESTDIR)$(TARGET_DIR)/$$rmfile; \
227 echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE).devhelp' ; \
228 rm -f $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp; \
229 if test -e $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp2; then \
230 rm -f $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp2; \
232 echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/index.sgml' ; \
233 rm -f $(DESTDIR)$(TARGET_DIR)/index.sgml; \
234 if test -e $(DESTDIR)$(TARGET_DIR)/style.css; then \
235 echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/style.css' ; \
236 rm -f $(DESTDIR)$(TARGET_DIR)/style.css; \
239 if test -d $(DESTDIR)$(TARGET_DIR); then rmdir -p --ignore-fail-on-non-empty $(DESTDIR)$(TARGET_DIR) 2>/dev/null; fi; true
242 # Require gtk-doc when making dist
248 @echo "*** gtk-doc must be installed and enabled in order to make dist"
252 dist-hook: dist-check-gtkdoc dist-hook-local
253 mkdir $(distdir)/tmpl
255 mkdir $(distdir)/html
256 -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
257 -cp $(srcdir)/sgml/*.xml $(distdir)/xml
258 -cp $(srcdir)/html/index.sgml $(distdir)/html
259 -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html
260 -cp $(srcdir)/html/$(DOC_MODULE).devhelp* $(distdir)/html
262 images=$(HTML_IMAGES) ; \
263 for i in "" $$images ; do \
264 if test "$$i" != ""; then cp $(srcdir)/$$i $(distdir)/html ; fi; \
267 .PHONY : dist-hook-local