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 $(expand_content_files) \
29 $(DOC_MAIN_SGML_FILE) \
30 $(DOC_MODULE)-sections.txt \
31 $(DOC_MODULE)-overrides.txt
37 DOC_STAMPS=setup-build.stamp scan-build.stamp sgml-build.stamp \
38 html-build.stamp pdf-build.stamp \
39 sgml.stamp html.stamp pdf.stamp
43 $(DOC_MODULE).hierarchy \
44 $(DOC_MODULE).interfaces \
45 $(DOC_MODULE).prerequisites \
49 $(DOC_MODULE)-undocumented.txt \
50 $(DOC_MODULE)-undeclared.txt \
51 $(DOC_MODULE)-unused.txt
53 gtkdoc-check.test: Makefile
54 $(AM_V_GEN)echo "#!/bin/sh -e" > $@; \
55 echo "$(GTKDOC_CHECK_PATH) || exit 1" >> $@; \
58 CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS) gtkdoc-check.test
61 HTML_BUILD_STAMP=html-build.stamp
66 PDF_BUILD_STAMP=pdf-build.stamp
71 all-gtk-doc: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP)
75 all-local: all-gtk-doc
78 docs: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP)
80 $(REPORT_FILES): sgml-build.stamp
84 GTK_DOC_V_SETUP=$(GTK_DOC_V_SETUP_$(V))
85 GTK_DOC_V_SETUP_=$(GTK_DOC_V_SETUP_$(AM_DEFAULT_VERBOSITY))
86 GTK_DOC_V_SETUP_0=@echo " DOC Preparing build";
89 -$(GTK_DOC_V_SETUP)if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
90 files=`echo $(SETUP_FILES) $(DOC_MODULE).types`; \
91 if test "x$$files" != "x" ; then \
92 for file in $$files ; do \
93 destdir=`dirname $(abs_builddir)/$$file`; \
94 test -d "$$destdir" || mkdir -p "$$destdir"; \
95 test -f $(abs_srcdir)/$$file && \
96 cp -pf $(abs_srcdir)/$$file $(abs_builddir)/$$file || true; \
100 $(AM_V_at)touch setup-build.stamp
105 GTK_DOC_V_SCAN=$(GTK_DOC_V_SCAN_$(V))
106 GTK_DOC_V_SCAN_=$(GTK_DOC_V_SCAN_$(AM_DEFAULT_VERBOSITY))
107 GTK_DOC_V_SCAN_0=@echo " DOC Scanning header files";
109 GTK_DOC_V_INTROSPECT=$(GTK_DOC_V_INTROSPECT_$(V))
110 GTK_DOC_V_INTROSPECT_=$(GTK_DOC_V_INTROSPECT_$(AM_DEFAULT_VERBOSITY))
111 GTK_DOC_V_INTROSPECT_0=@echo " DOC Introspecting gobjects";
113 scan-build.stamp: setup-build.stamp $(HFILE_GLOB) $(CFILE_GLOB)
114 $(GTK_DOC_V_SCAN)_source_dir='' ; \
115 for i in $(DOC_SOURCE_DIR) ; do \
116 _source_dir="$${_source_dir} --source-dir=$$i" ; \
118 gtkdoc-scan --module=$(DOC_MODULE) --ignore-headers="$(IGNORE_HFILES)" $${_source_dir} $(SCAN_OPTIONS) $(EXTRA_HFILES)
119 $(GTK_DOC_V_INTROSPECT)if grep -l '^..*$$' $(DOC_MODULE).types > /dev/null 2>&1 ; then \
120 scanobj_options=""; \
121 gtkdoc-scangobj 2>&1 --help | grep >/dev/null "\-\-verbose"; \
122 if test "$$?" = "0"; then \
123 if test "x$(V)" = "x1"; then \
124 scanobj_options="--verbose"; \
127 CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" RUN="$(GTKDOC_RUN)" CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS)" LDFLAGS="$(GTKDOC_LIBS) $(LDFLAGS)" \
128 gtkdoc-scangobj $(SCANGOBJ_OPTIONS) $$scanobj_options --module=$(DOC_MODULE); \
130 for i in $(SCANOBJ_FILES) ; do \
131 test -f $$i || touch $$i ; \
134 $(AM_V_at)touch scan-build.stamp
136 $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt: scan-build.stamp
141 GTK_DOC_V_XML=$(GTK_DOC_V_XML_$(V))
142 GTK_DOC_V_XML_=$(GTK_DOC_V_XML_$(AM_DEFAULT_VERBOSITY))
143 GTK_DOC_V_XML_0=@echo " DOC Building XML";
145 sgml-build.stamp: setup-build.stamp $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(HFILE_GLOB) $(CFILE_GLOB) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt $(expand_content_files) xml/gtkdocentities.ent
146 $(GTK_DOC_V_XML)_source_dir='' ; \
147 for i in $(DOC_SOURCE_DIR) ; do \
148 _source_dir="$${_source_dir} --source-dir=$$i" ; \
150 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)
151 $(AM_V_at)touch sgml-build.stamp
153 sgml.stamp: sgml-build.stamp
156 xml/gtkdocentities.ent: Makefile
157 $(GTK_DOC_V_XML)$(MKDIR_P) $(@D) && ( \
158 echo "<!ENTITY package \"$(PACKAGE)\">"; \
159 echo "<!ENTITY package_bugreport \"$(PACKAGE_BUGREPORT)\">"; \
160 echo "<!ENTITY package_name \"$(PACKAGE_NAME)\">"; \
161 echo "<!ENTITY package_string \"$(PACKAGE_STRING)\">"; \
162 echo "<!ENTITY package_tarname \"$(PACKAGE_TARNAME)\">"; \
163 echo "<!ENTITY package_url \"$(PACKAGE_URL)\">"; \
164 echo "<!ENTITY package_version \"$(PACKAGE_VERSION)\">"; \
169 GTK_DOC_V_HTML=$(GTK_DOC_V_HTML_$(V))
170 GTK_DOC_V_HTML_=$(GTK_DOC_V_HTML_$(AM_DEFAULT_VERBOSITY))
171 GTK_DOC_V_HTML_0=@echo " DOC Building HTML";
173 GTK_DOC_V_XREF=$(GTK_DOC_V_XREF_$(V))
174 GTK_DOC_V_XREF_=$(GTK_DOC_V_XREF_$(AM_DEFAULT_VERBOSITY))
175 GTK_DOC_V_XREF_0=@echo " DOC Fixing cross-references";
177 html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) $(expand_content_files)
178 $(GTK_DOC_V_HTML)rm -rf html && mkdir html && \
180 gtkdoc-mkhtml 2>&1 --help | grep >/dev/null "\-\-verbose"; \
181 if test "$$?" = "0"; then \
182 if test "x$(V)" = "x1"; then \
183 mkhtml_options="$$mkhtml_options --verbose"; \
186 gtkdoc-mkhtml 2>&1 --help | grep >/dev/null "\-\-path"; \
187 if test "$$?" = "0"; then \
188 mkhtml_options="$$mkhtml_options --path=\"$(abs_srcdir)\""; \
190 cd html && gtkdoc-mkhtml $$mkhtml_options $(MKHTML_OPTIONS) $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
191 -@test "x$(HTML_IMAGES)" = "x" || \
192 for file in $(HTML_IMAGES) ; do \
193 if test -f $(abs_srcdir)/$$file ; then \
194 cp $(abs_srcdir)/$$file $(abs_builddir)/html; \
196 if test -f $(abs_builddir)/$$file ; then \
197 cp $(abs_builddir)/$$file $(abs_builddir)/html; \
199 test -f $$file && cp $$file $(abs_builddir)/html; \
201 $(GTK_DOC_V_XREF)gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
202 $(AM_V_at)touch html-build.stamp
206 GTK_DOC_V_PDF=$(GTK_DOC_V_PDF_$(V))
207 GTK_DOC_V_PDF_=$(GTK_DOC_V_PDF_$(AM_DEFAULT_VERBOSITY))
208 GTK_DOC_V_PDF_0=@echo " DOC Building PDF";
210 pdf-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) $(expand_content_files)
211 $(GTK_DOC_V_PDF)rm -f $(DOC_MODULE).pdf && \
213 gtkdoc-mkpdf 2>&1 --help | grep >/dev/null "\-\-verbose"; \
214 if test "$$?" = "0"; then \
215 if test "x$(V)" = "x1"; then \
216 mkpdf_options="$$mkpdf_options --verbose"; \
219 if test "x$(HTML_IMAGES)" != "x"; then \
220 for img in $(HTML_IMAGES); do \
221 part=`dirname $$img`; \
222 echo $$mkpdf_options | grep >/dev/null "\-\-imgdir=$$part "; \
223 if test $$? != 0; then \
224 mkpdf_options="$$mkpdf_options --imgdir=$$part"; \
228 gtkdoc-mkpdf --path="$(abs_srcdir)" $$mkpdf_options $(DOC_MODULE) $(DOC_MAIN_SGML_FILE) $(MKPDF_OPTIONS)
229 $(AM_V_at)touch pdf-build.stamp
236 @if echo $(SCAN_OPTIONS) | grep -q "\-\-rebuild-types" ; then \
237 rm -f $(DOC_MODULE).types; \
239 @if echo $(SCAN_OPTIONS) | grep -q "\-\-rebuild-sections" ; then \
240 rm -f $(DOC_MODULE)-sections.txt; \
244 @rm -rf xml html $(REPORT_FILES) $(DOC_MODULE).pdf \
245 $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
246 @if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
247 rm -f $(SETUP_FILES) $(DOC_MODULE).types; \
250 maintainer-clean-local:
254 @installfiles=`echo $(builddir)/html/*`; \
255 if test "$$installfiles" = '$(builddir)/html/*'; \
256 then echo 1>&2 'Nothing to install' ; \
258 if test -n "$(DOC_MODULE_VERSION)"; then \
259 installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
261 installdir="$(DESTDIR)$(TARGET_DIR)"; \
263 $(mkinstalldirs) $${installdir} ; \
264 for i in $$installfiles; do \
265 echo ' $(INSTALL_DATA) '$$i ; \
266 $(INSTALL_DATA) $$i $${installdir}; \
268 if test -n "$(DOC_MODULE_VERSION)"; then \
269 mv -f $${installdir}/$(DOC_MODULE).devhelp2 \
270 $${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp2; \
272 $(GTKDOC_REBASE) --relative --dest-dir=$(DESTDIR) --html-dir=$${installdir}; \
276 @if test -n "$(DOC_MODULE_VERSION)"; then \
277 installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
279 installdir="$(DESTDIR)$(TARGET_DIR)"; \
281 rm -rf $${installdir}
284 # Require gtk-doc when making dist
287 dist-check-gtkdoc: docs
290 @echo "*** gtk-doc is needed to run 'make dist'. ***"
291 @echo "*** gtk-doc was not found when 'configure' ran. ***"
292 @echo "*** please install gtk-doc and rerun 'configure'. ***"
296 dist-hook: dist-check-gtkdoc all-gtk-doc dist-hook-local
297 @mkdir $(distdir)/html
298 @cp ./html/* $(distdir)/html
299 @-cp ./$(DOC_MODULE).pdf $(distdir)/
300 @-cp ./$(DOC_MODULE).types $(distdir)/
301 @-cp ./$(DOC_MODULE)-sections.txt $(distdir)/
302 @cd $(distdir) && rm -f $(DISTCLEANFILES)
303 @$(GTKDOC_REBASE) --online --relative --html-dir=$(distdir)/html
305 .PHONY : dist-hook-local docs