1 # -*- mode: makefile -*-
3 ####################################
4 # Everything below here is generic #
5 ####################################
8 GTKDOC_CC = $(LIBTOOL) --tag=CC --mode=compile $(CC) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
9 GTKDOC_LD = $(LIBTOOL) --tag=CC --mode=link $(CC) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS)
10 GTKDOC_RUN = $(LIBTOOL) --mode=execute
12 GTKDOC_CC = $(CC) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
13 GTKDOC_LD = $(CC) $(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
35 DOC_STAMPS=setup-build.stamp scan-build.stamp tmpl-build.stamp sgml-build.stamp \
36 html-build.stamp pdf-build.stamp \
37 setup.stamp tmpl.stamp sgml.stamp html.stamp pdf.stamp
41 $(DOC_MODULE).hierarchy \
42 $(DOC_MODULE).interfaces \
43 $(DOC_MODULE).prerequisites \
47 $(DOC_MODULE)-undocumented.txt \
48 $(DOC_MODULE)-undeclared.txt \
49 $(DOC_MODULE)-unused.txt
51 CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS)
55 HTML_BUILD_STAMP=html-build.stamp
60 PDF_BUILD_STAMP=pdf-build.stamp
65 all-local: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP)
70 docs: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP)
72 $(REPORT_FILES): sgml-build.stamp
77 -@if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
78 echo 'gtk-doc: Preparing build'; \
79 files=`echo $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types`; \
80 if test "x$$files" != "x" ; then \
81 for file in $$files ; do \
82 test -f $(abs_srcdir)/$$file && \
83 cp -p $(abs_srcdir)/$$file $(abs_builddir)/; \
86 test -f $(abs_srcdir)/tmpl && \
87 cp -rp $(abs_srcdir)/tmpl $(abs_builddir)/; \
89 @touch setup-build.stamp
92 setup.stamp: setup-build.stamp
98 scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB)
99 @echo 'gtk-doc: Scanning header files'
101 for i in $(DOC_SOURCE_DIR) ; do \
102 _source_dir="$${_source_dir} --source-dir=$$i" ; \
104 gtkdoc-scan --module=$(DOC_MODULE) --ignore-headers="$(IGNORE_HFILES)" $${_source_dir} $(SCAN_OPTIONS) $(EXTRA_HFILES)
105 @if grep -l '^..*$$' $(DOC_MODULE).types > /dev/null 2>&1 ; then \
106 CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" RUN="$(GTKDOC_RUN)" CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS)" LDFLAGS="$(GTKDOC_LIBS) $(LDFLAGS)" gtkdoc-scangobj $(SCANGOBJ_OPTIONS) --module=$(DOC_MODULE) ; \
108 for i in $(SCANOBJ_FILES) ; do \
109 test -f $$i || touch $$i ; \
112 @touch scan-build.stamp
114 $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt: scan-build.stamp
119 tmpl-build.stamp: setup.stamp $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt
120 @echo 'gtk-doc: Rebuilding template files'
121 @gtkdoc-mktmpl --module=$(DOC_MODULE) $(MKTMPL_OPTIONS)
122 @if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
123 if test -w $(abs_srcdir) ; then \
124 cp -rp $(abs_builddir)/tmpl $(abs_srcdir)/; \
127 @touch tmpl-build.stamp
129 tmpl.stamp: tmpl-build.stamp
132 $(srcdir)/tmpl/*.sgml:
137 sgml-build.stamp: tmpl.stamp $(DOC_MODULE)-sections.txt $(srcdir)/tmpl/*.sgml $(expand_content_files)
138 @echo 'gtk-doc: Building XML'
139 @-chmod -R u+w $(srcdir)
141 for i in $(DOC_SOURCE_DIR) ; do \
142 _source_dir="$${_source_dir} --source-dir=$$i" ; \
144 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)
145 @touch sgml-build.stamp
147 sgml.stamp: sgml-build.stamp
152 html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
153 @echo 'gtk-doc: Building HTML'
156 @mkhtml_options=""; \
157 gtkdoc-mkhtml 2>&1 --help | grep >/dev/null "\-\-path"; \
158 if test "$(?)" = "0"; then \
159 mkhtml_options=--path="$(abs_srcdir)"; \
161 cd html && gtkdoc-mkhtml $$mkhtml_options $(MKHTML_OPTIONS) $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
162 -@test "x$(HTML_IMAGES)" = "x" || \
163 for file in $(HTML_IMAGES) ; do \
164 if test -f $(abs_srcdir)/$$file ; then \
165 cp $(abs_srcdir)/$$file $(abs_builddir)/html; \
167 if test -f $(abs_builddir)/$$file ; then \
168 cp $(abs_builddir)/$$file $(abs_builddir)/html; \
171 @echo 'gtk-doc: Fixing cross-references'
172 @gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
173 @touch html-build.stamp
177 pdf-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
178 @echo 'gtk-doc: Building PDF'
179 @rm -rf $(DOC_MODULE).pdf
181 if test "x$(HTML_IMAGES)" != "x"; then \
182 for img in $(HTML_IMAGES); do \
183 part=`dirname $$img`; \
184 echo $$mkpdf_imgdirs | grep >/dev/null "\-\-imgdir=$$part "; \
185 if test $$? != 0; then \
186 mkpdf_imgdirs="$$mkpdf_imgdirs --imgdir=$$part"; \
190 gtkdoc-mkpdf --path="$(abs_srcdir)" $$mkpdf_imgdirs $(DOC_MODULE) $(DOC_MAIN_SGML_FILE) $(MKPDF_OPTIONS)
191 @touch pdf-build.stamp
200 rm -rf xml html $(REPORT_FILES) $(DOC_MODULE).pdf \
201 $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
202 if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
203 rm -f $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types; \
207 maintainer-clean-local: clean
211 @installfiles=`echo $(srcdir)/html/*`; \
212 if test "$$installfiles" = '$(srcdir)/html/*'; \
213 then echo '-- Nothing to install' ; \
215 if test -n "$(DOC_MODULE_VERSION)"; then \
216 installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
218 installdir="$(DESTDIR)$(TARGET_DIR)"; \
220 $(mkinstalldirs) $${installdir} ; \
221 for i in $$installfiles; do \
222 echo '-- Installing '$$i ; \
223 $(INSTALL_DATA) $$i $${installdir}; \
225 if test -n "$(DOC_MODULE_VERSION)"; then \
226 mv -f $${installdir}/$(DOC_MODULE).devhelp2 \
227 $${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp2; \
228 mv -f $${installdir}/$(DOC_MODULE).devhelp \
229 $${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp; \
231 $(GTKDOC_REBASE) --relative --dest-dir=$(DESTDIR) --html-dir=$${installdir}; \
235 @if test -n "$(DOC_MODULE_VERSION)"; then \
236 installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
238 installdir="$(DESTDIR)$(TARGET_DIR)"; \
240 rm -rf $${installdir}
243 # Require gtk-doc when making dist
249 @echo "*** gtk-doc must be installed and enabled in order to make dist"
253 dist-hook: dist-check-gtkdoc dist-hook-local
254 mkdir $(distdir)/tmpl
255 mkdir $(distdir)/html
256 -cp $(build)/tmpl/*.sgml $(distdir)/tmpl
257 cp $(builddir)/html/* $(distdir)/html
258 -cp $(builddir)/$(DOC_MODULE).pdf $(distdir)/
259 -cp $(build)/$(DOC_MODULE).types $(distdir)/
260 -cp $(build)/$(DOC_MODULE)-sections.txt $(distdir)/
261 cd $(distdir) && rm -f $(DISTCLEANFILES)
262 $(GTKDOC_REBASE) --online --relative --html-dir=$(distdir)/html
264 .PHONY : dist-hook-local docs