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
37 $(DOC_MODULE).hierarchy \
38 $(DOC_MODULE).interfaces \
39 $(DOC_MODULE).prerequisites \
40 $(DOC_MODULE).signals \
41 .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) doc-registry.xml
51 all-local: html-build.stamp
55 setup.stamp: $(content_files)
56 -@if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
57 cp -p $(abs_srcdir)/$(DOC_MAIN_SGML_FILE) \
58 $(abs_srcdir)/$(DOC_MODULE)-overrides.txt \
59 $(abs_srcdir)/$(DOC_MODULE)-sections.txt \
60 $(abs_srcdir)/$(DOC_MODULE).types \
62 if test "x$(content_files)" != "x" ; then \
63 for file in $(content_files) ; do \
64 test -f $(abs_srcdir)/$$file || \
65 cp -p $(abs_srcdir)/$$file $(abs_builddir)/; \
73 # in the case of non-srcdir builds, the built gst directory gets added
74 # to gtk-doc scanning; but only then, to avoid duplicates
75 scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB)
76 @echo '*** Scanning header files ***'
77 if grep -l '^..*$$' $(DOC_MODULE).types > /dev/null; \
79 GST_PLUGIN_SYSTEM_PATH=`cd $(top_builddir) && pwd` \
81 GST_REGISTRY=doc-registry.xml \
82 $(GTKDOC_EXTRA_ENVIRONMENT) \
83 CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" \
84 CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS)" \
85 LDFLAGS="$(GTKDOC_LIBS) $(LDFLAGS)" \
86 gtkdoc-scangobj --type-init-func="gst_init(NULL,NULL)" \
87 --module=$(DOC_MODULE) ; \
89 for i in $(SCANOBJ_FILES) ; do \
90 test -f $$i || touch $$i ; \
93 if test "x$(top_srcdir)" != "x$(top_builddir)"; \
95 export BUILT_OPTIONS="--source-dir=$(DOC_BUILD_DIR)"; \
98 $(SCAN_OPTIONS) $(EXTRA_HFILES) \
99 --module=$(DOC_MODULE) \
100 --source-dir=$(DOC_SOURCE_DIR) \
102 --ignore-headers="$(IGNORE_HFILES)"
103 touch scan-build.stamp
105 $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt: scan-build.stamp
110 ### FIXME: make this error out again when docs are complete
111 sgml-build.stamp: setup.stamp $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(expand_content_files)
112 @echo '*** Building XML ***'
113 gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --expand-content-files="$(expand_content_files)" --main-sgml-file=$(DOC_MAIN_SGML_FILE) --output-format=xml $(MKDB_OPTIONS) | tee sgml-build.log
114 @if grep "WARNING:" sgml-build.log > /dev/null; then true; fi # exit 1; fi
115 cp ../version.entities xml
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 ***'
129 cp ../version.entities ./
130 @mkhtml_options=""; \
131 gtkdoc-mkhtml 2>&1 --help | grep >/dev/null "\-\-path"; \
132 if test "$(?)" = "0"; then \
133 mkhtml_options=--path="$(abs_srcdir)"; \
135 cd html && gtkdoc-mkhtml $$mkhtml_options $(MKHTML_OPTIONS) $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
136 mv html/index.sgml html/index.sgml.bak
137 $(SED) "s/ href=\"$(DOC_MODULE)\// href=\"$(DOC_MODULE)-@GST_MAJORMINOR@\//g" html/index.sgml.bak >html/index.sgml
138 rm -f html/index.sgml.bak
140 rm -f version.entities
141 test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) $(abs_builddir)/html )
142 @echo '-- Fixing Crossreferences'
143 gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
144 touch html-build.stamp
148 # clean files copied for nonsrcdir templates build
149 if test x"$(srcdir)" != x. ; then \
150 rm -rf $(DOC_MODULE).types; \
157 clean-local: clean-local-gtkdoc
162 rm -f $(REPORT_FILES) \
163 $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
164 rm -rf tmpl/*.sgml.bak
165 rm -f $(DOC_MODULE).hierarchy
166 rm -f *.stamp || true
167 if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
168 rm -f $(DOC_MODULE)-docs.sgml ; \
169 rm -f $(DOC_MODULE).types ; \
170 rm -f $(DOC_MODULE).interfaces ; \
171 rm -f $(DOC_MODULE)-overrides.txt ; \
172 rm -f $(DOC_MODULE).prerequisites ; \
173 rm -f $(DOC_MODULE)-sections.txt ; \
174 rm -rf tmpl/*.sgml ; \
178 maintainer-clean-local: clean
179 cd $(srcdir) && rm -rf html \
180 xml $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
182 # thomas: make docs parallel installable; devhelp requires majorminor too
184 (installfiles=`echo $(builddir)/html/*.sgml $(builddir)/html/*.html $(builddir)/html/*.png $(builddir)/html/*.css`; \
185 if test "$$installfiles" = '$(builddir)/html/*.sgml $(builddir)/html/*.html $(builddir)/html/*.png $(builddir)/html/*.css'; \
186 then echo '-- Nothing to install' ; \
188 $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR); \
189 for i in $$installfiles; do \
190 echo '-- Installing '$$i ; \
191 $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
193 echo '-- Installing $(srcdir)/html/$(DOC_MODULE).devhelp' ; \
194 $(INSTALL_DATA) $(srcdir)/html/$(DOC_MODULE).devhelp \
195 $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp; \
196 if test -e $(srcdir)/html/$(DOC_MODULE).devhelp2; then \
197 $(INSTALL_DATA) $(srcdir)/html/$(DOC_MODULE).devhelp2 \
198 $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp2; \
200 (which gtkdoc-rebase >/dev/null && \
201 gtkdoc-rebase --relative --dest-dir=$(DESTDIR) --html-dir=$(DESTDIR)$(TARGET_DIR)) || true ; \
204 if test -d $(DESTDIR)$(TARGET_DIR); then \
205 rm -rf $(DESTDIR)$(TARGET_DIR)/*; \
206 rmdir -p $(DESTDIR)$(TARGET_DIR) 2>/dev/null || true; \
208 echo '-- Nothing to uninstall' ; \
213 # Require gtk-doc when making dist
219 @echo "*** gtk-doc must be installed and enabled in order to make dist"
223 dist-hook: dist-check-gtkdoc dist-hook-local
224 mkdir $(distdir)/html
225 cp html/* $(distdir)/html
226 -cp $(srcdir)/$(DOC_MODULE).types $(distdir)/
227 -cp $(srcdir)/$(DOC_MODULE)-sections.txt $(distdir)/
228 cd $(distdir) && rm -f $(DISTCLEANFILES)
229 -gtkdoc-rebase --online --relative --html-dir=$(distdir)/html
231 .PHONY : dist-hook-local docs