1 # -*- mode: makefile -*-
3 ####################################
4 # Everything below here is generic #
5 ####################################
8 GTKDOC_CC = $(LIBTOOL) --tag=CC --mode=compile $(CC) $(INCLUDES) $(GTKDOC_DEPS_CFLAGS) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
9 GTKDOC_LD = $(LIBTOOL) --tag=CC --mode=link $(CC) $(GTKDOC_DEPS_LIBS) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS)
10 GTKDOC_RUN = $(LIBTOOL) --mode=execute
12 GTKDOC_CC = $(CC) $(INCLUDES) $(GTKDOC_DEPS_CFLAGS) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
13 GTKDOC_LD = $(CC) $(GTKDOC_DEPS_LIBS) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS)
17 # We set GPATH here; this gives us semantics for GNU make
18 # which are more like other make's VPATH, when it comes to
19 # whether a source that is a target of one rule is then
20 # searched for in VPATH/GPATH.
24 TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
28 $(DOC_MAIN_SGML_FILE) \
29 $(DOC_MODULE)-sections.txt \
30 $(DOC_MODULE)-overrides.txt
36 DOC_STAMPS=setup-build.stamp scan-build.stamp tmpl-build.stamp sgml-build.stamp \
37 html-build.stamp pdf-build.stamp \
38 tmpl.stamp sgml.stamp html.stamp pdf.stamp
42 $(DOC_MODULE).hierarchy \
43 $(DOC_MODULE).interfaces \
44 $(DOC_MODULE).prerequisites \
48 $(DOC_MODULE)-undocumented.txt \
49 $(DOC_MODULE)-undeclared.txt \
50 $(DOC_MODULE)-unused.txt
52 gtkdoc-check.test: Makefile
53 $(AM_V_GEN)echo "#!/bin/sh -e" > $@; \
54 echo "$(GTKDOC_CHECK_PATH) || exit 1" >> $@; \
57 CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS) gtkdoc-check.test
60 HTML_BUILD_STAMP=html-build.stamp
65 PDF_BUILD_STAMP=pdf-build.stamp
70 all-gtk-doc: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP)
74 all-local: all-gtk-doc
77 docs: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP)
79 $(REPORT_FILES): sgml-build.stamp
83 GTK_DOC_V_SETUP=$(GTK_DOC_V_SETUP_$(V))
84 GTK_DOC_V_SETUP_=$(GTK_DOC_V_SETUP_$(AM_DEFAULT_VERBOSITY))
85 GTK_DOC_V_SETUP_0=@echo " DOC Preparing build";
88 -$(GTK_DOC_V_SETUP)if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
89 files=`echo $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types`; \
90 if test "x$$files" != "x" ; then \
91 for file in $$files ; do \
92 destdir=`dirname $(abs_builddir)/$$file` ;\
93 test -d "$$destdir" || mkdir -p "$$destdir"; \
94 test -f $(abs_srcdir)/$$file && \
95 cp -pf $(abs_srcdir)/$$file $(abs_builddir)/$$file || true; \
98 test -d $(abs_srcdir)/tmpl && \
99 { cp -pR $(abs_srcdir)/tmpl $(abs_builddir)/; \
100 chmod -R u+w $(abs_builddir)/tmpl; } \
102 $(AM_V_at)touch setup-build.stamp
106 GTK_DOC_V_SCAN=$(GTK_DOC_V_SCAN_$(V))
107 GTK_DOC_V_SCAN_=$(GTK_DOC_V_SCAN_$(AM_DEFAULT_VERBOSITY))
108 GTK_DOC_V_SCAN_0=@echo " DOC Scanning header files";
110 GTK_DOC_V_INTROSPECT=$(GTK_DOC_V_INTROSPECT_$(V))
111 GTK_DOC_V_INTROSPECT_=$(GTK_DOC_V_INTROSPECT_$(AM_DEFAULT_VERBOSITY))
112 GTK_DOC_V_INTROSPECT_0=@echo " DOC Introspecting gobjects";
114 scan-build.stamp: setup-build.stamp $(HFILE_GLOB) $(CFILE_GLOB)
115 $(GTK_DOC_V_SCAN)_source_dir='' ; \
116 for i in $(DOC_SOURCE_DIR) ; do \
117 _source_dir="$${_source_dir} --source-dir=$$i" ; \
119 gtkdoc-scan --module=$(DOC_MODULE) --ignore-headers="$(IGNORE_HFILES)" $${_source_dir} $(SCAN_OPTIONS) $(EXTRA_HFILES)
120 $(GTK_DOC_V_INTROSPECT)if grep -l '^..*$$' $(DOC_MODULE).types > /dev/null 2>&1 ; then \
121 scanobj_options=""; \
122 gtkdoc-scangobj 2>&1 --help | grep >/dev/null "\-\-verbose"; \
123 if test "$(?)" = "0"; then \
124 if test "x$(V)" = "x1"; then \
125 scanobj_options="--verbose"; \
128 CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" RUN="$(GTKDOC_RUN)" CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS)" LDFLAGS="$(GTKDOC_LIBS) $(LDFLAGS)" \
129 gtkdoc-scangobj $(SCANGOBJ_OPTIONS) $$scanobj_options --module=$(DOC_MODULE); \
131 for i in $(SCANOBJ_FILES) ; do \
132 test -f $$i || touch $$i ; \
135 $(AM_V_at)touch scan-build.stamp
137 $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt: scan-build.stamp
142 GTK_DOC_V_TMPL=$(GTK_DOC_V_TMPL_$(V))
143 GTK_DOC_V_TMPL_=$(GTK_DOC_V_TMPL_$(AM_DEFAULT_VERBOSITY))
144 GTK_DOC_V_TMPL_0=@echo " DOC Rebuilding template files";
146 tmpl-build.stamp: setup-build.stamp $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt
147 $(GTK_DOC_V_TMPL)gtkdoc-mktmpl --module=$(DOC_MODULE) $(MKTMPL_OPTIONS)
148 $(AM_V_at)if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
149 if test -w $(abs_srcdir) ; then \
150 cp -pR $(abs_builddir)/tmpl $(abs_srcdir)/; \
153 $(AM_V_at)touch tmpl-build.stamp
155 tmpl.stamp: tmpl-build.stamp
158 $(srcdir)/tmpl/*.sgml:
163 GTK_DOC_V_XML=$(GTK_DOC_V_XML_$(V))
164 GTK_DOC_V_XML_=$(GTK_DOC_V_XML_$(AM_DEFAULT_VERBOSITY))
165 GTK_DOC_V_XML_0=@echo " DOC Building XML";
167 sgml-build.stamp: tmpl.stamp $(DOC_MODULE)-sections.txt $(srcdir)/tmpl/*.sgml $(expand_content_files)
168 -$(GTK_DOC_V_XML)chmod -R u+w $(srcdir) && _source_dir='' ; \
169 for i in $(DOC_SOURCE_DIR) ; do \
170 _source_dir="$${_source_dir} --source-dir=$$i" ; \
172 gtkdoc-mkdb --module=$(DOC_MODULE) --output-format=xml --expand-content-files="$(expand_content_files)" --main-sgml-file=$(DOC_MAIN_SGML_FILE) $${_source_dir} $(MKDB_OPTIONS)
173 $(AM_V_at)touch sgml-build.stamp
175 sgml.stamp: sgml-build.stamp
180 GTK_DOC_V_HTML=$(GTK_DOC_V_HTML_$(V))
181 GTK_DOC_V_HTML_=$(GTK_DOC_V_HTML_$(AM_DEFAULT_VERBOSITY))
182 GTK_DOC_V_HTML_0=@echo " DOC Building HTML";
184 GTK_DOC_V_XREF=$(GTK_DOC_V_XREF_$(V))
185 GTK_DOC_V_XREF_=$(GTK_DOC_V_XREF_$(AM_DEFAULT_VERBOSITY))
186 GTK_DOC_V_XREF_0=@echo " DOC Fixing cross-references";
188 html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
189 $(GTK_DOC_V_HTML)rm -rf html && mkdir html && \
191 gtkdoc-mkhtml 2>&1 --help | grep >/dev/null "\-\-verbose"; \
192 if test "$(?)" = "0"; then \
193 if test "x$(V)" = "x1"; then \
194 mkhtml_options="$$mkhtml_options --verbose"; \
197 gtkdoc-mkhtml 2>&1 --help | grep >/dev/null "\-\-path"; \
198 if test "$(?)" = "0"; then \
199 mkhtml_options="$$mkhtml_options --path=\"$(abs_srcdir)\""; \
201 cd html && gtkdoc-mkhtml $$mkhtml_options $(MKHTML_OPTIONS) $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
202 -@test "x$(HTML_IMAGES)" = "x" || \
203 for file in $(HTML_IMAGES) ; do \
204 if test -f $(abs_srcdir)/$$file ; then \
205 cp $(abs_srcdir)/$$file $(abs_builddir)/html; \
207 if test -f $(abs_builddir)/$$file ; then \
208 cp $(abs_builddir)/$$file $(abs_builddir)/html; \
211 $(GTK_DOC_V_XREF)gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
212 $(AM_V_at)touch html-build.stamp
216 GTK_DOC_V_PDF=$(GTK_DOC_V_PDF_$(V))
217 GTK_DOC_V_PDF_=$(GTK_DOC_V_PDF_$(AM_DEFAULT_VERBOSITY))
218 GTK_DOC_V_PDF_0=@echo " DOC Building PDF";
220 pdf-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
221 $(GTK_DOC_V_PDF)rm -f $(DOC_MODULE).pdf && \
223 gtkdoc-mkpdf 2>&1 --help | grep >/dev/null "\-\-verbose"; \
224 if test "$(?)" = "0"; then \
225 if test "x$(V)" = "x1"; then \
226 mkpdf_options="$$mkpdf_options --verbose"; \
229 if test "x$(HTML_IMAGES)" != "x"; then \
230 for img in $(HTML_IMAGES); do \
231 part=`dirname $$img`; \
232 echo $$mkpdf_options | grep >/dev/null "\-\-imgdir=$$part "; \
233 if test $$? != 0; then \
234 mkpdf_options="$$mkpdf_options --imgdir=$$part"; \
238 gtkdoc-mkpdf --path="$(abs_srcdir)" $$mkpdf_options $(DOC_MODULE) $(DOC_MAIN_SGML_FILE) $(MKPDF_OPTIONS)
239 $(AM_V_at)touch pdf-build.stamp
246 @if echo $(SCAN_OPTIONS) | grep -q "\-\-rebuild-types" ; then \
247 rm -f $(DOC_MODULE).types; \
251 @rm -rf xml html $(REPORT_FILES) $(DOC_MODULE).pdf \
252 $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
253 @if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
254 rm -f $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types; \
258 maintainer-clean-local:
262 @installfiles=`echo $(builddir)/html/*`; \
263 if test "$$installfiles" = '$(builddir)/html/*'; \
264 then echo 1>&2 'Nothing to install' ; \
266 if test -n "$(DOC_MODULE_VERSION)"; then \
267 installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
269 installdir="$(DESTDIR)$(TARGET_DIR)"; \
271 $(mkinstalldirs) $${installdir} ; \
272 for i in $$installfiles; do \
273 echo ' $(INSTALL_DATA) '$$i ; \
274 $(INSTALL_DATA) $$i $${installdir}; \
276 if test -n "$(DOC_MODULE_VERSION)"; then \
277 mv -f $${installdir}/$(DOC_MODULE).devhelp2 \
278 $${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp2; \
280 $(GTKDOC_REBASE) --relative --dest-dir=$(DESTDIR) --html-dir=$${installdir}; \
284 @if test -n "$(DOC_MODULE_VERSION)"; then \
285 installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
287 installdir="$(DESTDIR)$(TARGET_DIR)"; \
289 rm -rf $${installdir}
292 # Require gtk-doc when making dist
295 dist-check-gtkdoc: docs
298 @echo "*** gtk-doc is needed to run 'make dist'. ***"
299 @echo "*** gtk-doc was not found when 'configure' ran. ***"
300 @echo "*** please install gtk-doc and rerun 'configure'. ***"
304 dist-hook: dist-check-gtkdoc all-gtk-doc dist-hook-local
305 @mkdir $(distdir)/tmpl
306 @mkdir $(distdir)/html
307 @-cp ./tmpl/*.sgml $(distdir)/tmpl
308 @cp ./html/* $(distdir)/html
309 @-cp ./$(DOC_MODULE).pdf $(distdir)/
310 @-cp ./$(DOC_MODULE).types $(distdir)/
311 @-cp ./$(DOC_MODULE)-sections.txt $(distdir)/
312 @cd $(distdir) && rm -f $(DISTCLEANFILES)
313 @$(GTKDOC_REBASE) --online --relative --html-dir=$(distdir)/html
315 .PHONY : dist-hook-local docs