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 \
43 CLEANFILES = $(SCANOBJ_FILES) $(DOC_MODULE)-unused.txt $(DOC_STAMPS)
46 all-local: html-build.stamp
50 # in the case of non-srcdir builds, the built gst directory gets added
51 # to gtk-doc scanning; but only then, to avoid duplicates
52 scan-build.stamp: $(HFILE_GLOB) $(SCANOBJ_DEPS) $(basefiles)
53 @echo '*** Scanning header files ***'
54 if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null; \
56 if test x"$(srcdir)" != x. ; then \
57 cp $(srcdir)/$(DOC_MODULE).types . ; \
58 chmod u+w $(DOC_MODULE).types ; \
60 GST_PLUGIN_PATH=`cd $(top_builddir) && pwd` \
61 GST_PLUGIN_PATH_ONLY=1 \
62 CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" \
63 CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" \
64 $(GTK_DOC_SCANOBJ) --type-init-func="gst_init(NULL,NULL)" \
65 --module=$(DOC_MODULE) ; \
68 for i in $(SCANOBJ_FILES) ; do \
69 test -f $$i || touch $$i ; \
72 if test "x$(top_srcdir)" != "x$(top_builddir)"; \
74 export BUILT_OPTIONS="--source-dir=$(top_builddir)/gst"; \
77 $(SCAN_OPTIONS) $(EXTRA_HFILES) \
78 --module=$(DOC_MODULE) \
79 --source-dir=$(DOC_SOURCE_DIR) \
81 --ignore-headers="$(IGNORE_HFILES)"
82 touch scan-build.stamp
84 $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp
89 ### FIXME: make this error out again when docs are fixed for 0.9
90 tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES)
91 @echo '*** Rebuilding template files ***'
92 if test x"$(srcdir)" != x. ; then \
93 cp $(srcdir)/$(DOC_MODULE)-sections.txt . ; \
94 touch $(DOC_MODULE)-decl.txt ; \
96 gtkdoc-mktmpl --module=$(DOC_MODULE) | tee tmpl-build.log
97 @cat $(DOC_MODULE)-unused.txt
98 @if ! test -z "`grep -v GstPoptOption gstreamer-unused.txt`"; then \
101 touch tmpl-build.stamp
103 tmpl.stamp: tmpl-build.stamp
108 ### FIXME: make this error out again when docs are fixed for 0.9
109 sgml-build.stamp: tmpl.stamp $(CFILE_GLOB)
110 @echo '*** Building XML ***'
111 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
112 @if grep "WARNING:" sgml-build.log > /dev/null; then true; fi # exit 1; fi
114 touch sgml-build.stamp
116 sgml.stamp: sgml-build.stamp
121 # FIXME: setting LANG=C is a hack to work with gtk-doc < 1.1, because
122 # that forces a non-utf8 locale. gtk-doc >= 1.1 solves this by calling
123 # use bytes; in gtkdoc-fixxref
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
130 cp ../version.entities html
131 cd html && gtkdoc-mkhtml $(DOC_MODULE) $(DOC_MAIN_SGML_FILE)
132 rm -f html/$(DOC_MAIN_SGML_FILE)
134 rm -f html/version.entities
135 test "x$(HTML_IMAGES)" = "x" || for i in "" $(HTML_IMAGES) ; do \
136 if test "$$i" != ""; then cp $(srcdir)/$$i html ; fi; done
137 @echo '-- Fixing Crossreferences'
138 LANG=C && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
139 touch html-build.stamp
149 maintainer-clean-local: clean
150 cd $(srcdir) && rm -rf xml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
152 # company: don't delete .sgml and -sections.txt as they're in CVS
153 # FIXME : thomas added all sgml files and some other things to make
154 # make distcheck work
155 distclean-local: clean
156 rm -f $(DOC_MODULE)-decl-list.txt
157 rm -f $(DOC_MODULE)-decl.txt
158 rm -f $(DOC_MODULE)-undocumented.txt
159 rm -f $(DOC_MODULE)-unused.txt
160 rm -rf tmpl/*.sgml.bak
161 rm -f $(DOC_MODULE).hierarchy
162 rm -f *.stamp || true
163 if test x"$(srcdir)" != x. ; then \
164 rm -f $(DOC_MODULE)-docs.sgml ; \
165 rm -f $(DOC_MODULE).types ; \
166 rm -f $(DOC_MODULE).interfaces ; \
167 rm -f $(DOC_MODULE)-overrides.txt ; \
168 rm -f $(DOC_MODULE).prerequisites ; \
169 rm -f $(DOC_MODULE)-sections.txt ; \
170 rm -rf tmpl/*.sgml ; \
174 # thomas: make docs parallel installable; devhelp requires majorminor too
176 $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
177 (installfiles=`echo ./html/*.html`; \
178 if test "$$installfiles" = './html/*.html'; \
179 then echo '-- Nothing to install' ; \
181 for i in $$installfiles; do \
182 echo '-- Installing '$$i ; \
183 $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
185 pngfiles=`echo ./html/*.png`; \
186 if test "$$pngfiles" != './html/*.png'; then \
187 for i in $$pngfiles; do \
188 echo '-- Installing '$$i ; \
189 $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
192 echo '-- Installing $(srcdir)/html/$(DOC_MODULE).devhelp' ; \
193 $(INSTALL_DATA) $(srcdir)/html/$(DOC_MODULE).devhelp \
194 $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp; \
195 echo '-- Installing $(srcdir)/html/index.sgml' ; \
196 $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
197 if test -e $(srcdir)/html/style.css; then \
198 echo '-- Installing $(srcdir)/html/style.css' ; \
199 $(INSTALL_DATA) $(srcdir)/html/style.css $(DESTDIR)$(TARGET_DIR); \
203 (installfiles=`echo ./html/*.html`; \
204 if test "$$installfiles" = './html/*.html'; \
205 then echo '-- Nothing to uninstall' ; \
207 for i in $$installfiles; do \
208 rmfile=`basename $$i` ; \
209 echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/'$$rmfile ; \
210 rm -f $(DESTDIR)$(TARGET_DIR)/$$rmfile; \
212 pngfiles=`echo ./html/*.png`; \
213 if test "$$pngfiles" != './html/*.png'; then \
214 for i in $$pngfiles; do \
215 rmfile=`basename $$i` ; \
216 echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/'$$rmfile ; \
217 rm -f $(DESTDIR)$(TARGET_DIR)/$$rmfile; \
220 echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE).devhelp' ; \
221 rm -f $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp; \
222 echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/index.sgml' ; \
223 rm -f $(DESTDIR)$(TARGET_DIR)/index.sgml; \
224 if test -e $(DESTDIR)$(TARGET_DIR)/style.css; then \
225 echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/style.css' ; \
226 rm -f $(DESTDIR)$(TARGET_DIR)/style.css; \
229 if test -d $(DESTDIR)$(TARGET_DIR); then rmdir -p --ignore-fail-on-non-empty $(DESTDIR)$(TARGET_DIR) 2>/dev/null; fi; true
232 # Require gtk-doc when making dist
238 @echo "*** gtk-doc must be installed and enabled in order to make dist"
242 dist-hook: dist-check-gtkdoc dist-hook-local
243 mkdir $(distdir)/tmpl
245 mkdir $(distdir)/html
246 -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
247 -cp $(srcdir)/sgml/*.xml $(distdir)/xml
248 -cp $(srcdir)/html/index.sgml $(distdir)/html
249 -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html
250 -cp $(srcdir)/html/gstreamer.devhelp $(distdir)/html
252 images=$(HTML_IMAGES) ; \
253 for i in "" $$images ; do \
254 if test "$$i" != ""; then cp $(srcdir)/$$i $(distdir)/html ; fi; \
257 .PHONY : dist-hook-local