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
CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS)
56
HTML_BUILD_STAMP=html-build.stamp
61
PDF_BUILD_STAMP=pdf-build.stamp
66
all-local: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP)
71
docs: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP)
73
$(REPORT_FILES): sgml-build.stamp
78
-@if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
79
echo ' DOC Preparing build'; \
80
files=`echo $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types`; \
81
if test "x$$files" != "x" ; then \
82
for file in $$files ; do \
83
test -f $(abs_srcdir)/$$file && \
84
cp -pu $(abs_srcdir)/$$file $(abs_builddir)/ || true; \
87
test -d $(abs_srcdir)/tmpl && \
88
{ cp -rp $(abs_srcdir)/tmpl $(abs_builddir)/; \
89
chmod -R u+w $(abs_builddir)/tmpl; } \
91
@touch setup-build.stamp
95
scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB)
96
@echo ' DOC Scanning header files'
98
for i in $(DOC_SOURCE_DIR) ; do \
99
_source_dir="$${_source_dir} --source-dir=$$i" ; \
101
gtkdoc-scan --module=$(DOC_MODULE) --ignore-headers="$(IGNORE_HFILES)" $${_source_dir} $(SCAN_OPTIONS) $(EXTRA_HFILES)
102
@if grep -l '^..*$$' $(DOC_MODULE).types > /dev/null 2>&1 ; then \
103
echo " DOC Introspecting gobjects"; \
104
scanobj_options=""; \
105
gtkdoc-scangobj 2>&1 --help | grep >/dev/null "\-\-verbose"; \
106
if test "$(?)" = "0"; then \
107
if test "x$(V)" = "x1"; then \
108
scanobj_options="--verbose"; \
111
CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" RUN="$(GTKDOC_RUN)" CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS)" LDFLAGS="$(GTKDOC_LIBS) $(LDFLAGS)" \
112
gtkdoc-scangobj $(SCANGOBJ_OPTIONS) $$scanobj_options --module=$(DOC_MODULE); \
114
for i in $(SCANOBJ_FILES) ; do \
115
test -f $$i || touch $$i ; \
118
@touch scan-build.stamp
120
$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt: scan-build.stamp
125
tmpl-build.stamp: setup-build.stamp $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt
126
@echo ' DOC Rebuilding template files'
127
@gtkdoc-mktmpl --module=$(DOC_MODULE) $(MKTMPL_OPTIONS)
128
@if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
129
if test -w $(abs_srcdir) ; then \
130
cp -rp $(abs_builddir)/tmpl $(abs_srcdir)/; \
133
@touch tmpl-build.stamp
135
tmpl.stamp: tmpl-build.stamp
138
$(srcdir)/tmpl/*.sgml:
143
sgml-build.stamp: tmpl.stamp $(DOC_MODULE)-sections.txt $(srcdir)/tmpl/*.sgml $(expand_content_files)
144
@echo ' DOC Building XML'
145
@-chmod -R u+w $(srcdir)
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
@touch sgml-build.stamp
153
sgml.stamp: sgml-build.stamp
158
html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
159
@echo ' DOC Building HTML'
162
@mkhtml_options=""; \
163
gtkdoc-mkhtml 2>&1 --help | grep >/dev/null "\-\-verbose"; \
164
if test "$(?)" = "0"; then \
165
if test "x$(V)" = "x1"; then \
166
mkhtml_options="$$mkhtml_options --verbose"; \
169
gtkdoc-mkhtml 2>&1 --help | grep >/dev/null "\-\-path"; \
170
if test "$(?)" = "0"; then \
171
mkhtml_options="$$mkhtml_options --path=\"$(abs_srcdir)\""; \
173
cd html && gtkdoc-mkhtml $$mkhtml_options $(MKHTML_OPTIONS) $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
174
-@test "x$(HTML_IMAGES)" = "x" || \
175
for file in $(HTML_IMAGES) ; do \
176
if test -f $(abs_srcdir)/$$file ; then \
177
cp $(abs_srcdir)/$$file $(abs_builddir)/html; \
179
if test -f $(abs_builddir)/$$file ; then \
180
cp $(abs_builddir)/$$file $(abs_builddir)/html; \
183
@echo ' DOC Fixing cross-references'
184
@gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
185
@touch html-build.stamp
189
pdf-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
190
@echo ' DOC Building PDF'
191
@rm -f $(DOC_MODULE).pdf
193
gtkdoc-mkpdf 2>&1 --help | grep >/dev/null "\-\-verbose"; \
194
if test "$(?)" = "0"; then \
195
if test "x$(V)" = "x1"; then \
196
mkpdf_options="$$mkpdf_options --verbose"; \
199
if test "x$(HTML_IMAGES)" != "x"; then \
200
for img in $(HTML_IMAGES); do \
201
part=`dirname $$img`; \
202
echo $$mkpdf_options | grep >/dev/null "\-\-imgdir=$$part "; \
203
if test $$? != 0; then \
204
mkpdf_options="$$mkpdf_options --imgdir=$$part"; \
208
gtkdoc-mkpdf --path="$(abs_srcdir)" $$mkpdf_options $(DOC_MODULE) $(DOC_MAIN_SGML_FILE) $(MKPDF_OPTIONS)
209
@touch pdf-build.stamp
218
@rm -rf xml html $(REPORT_FILES) $(DOC_MODULE).pdf \
219
$(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
220
@if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
221
rm -f $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types; \
225
maintainer-clean-local: clean
229
@installfiles=`echo $(builddir)/html/*`; \
230
if test "$$installfiles" = '$(builddir)/html/*'; \
231
then echo 1>&2 'Nothing to install' ; \
233
if test -n "$(DOC_MODULE_VERSION)"; then \
234
installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
236
installdir="$(DESTDIR)$(TARGET_DIR)"; \
238
$(mkinstalldirs) $${installdir} ; \
239
for i in $$installfiles; do \
240
echo ' $(INSTALL_DATA) '$$i ; \
241
$(INSTALL_DATA) $$i $${installdir}; \
243
if test -n "$(DOC_MODULE_VERSION)"; then \
244
mv -f $${installdir}/$(DOC_MODULE).devhelp2 \
245
$${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp2; \
247
$(GTKDOC_REBASE) --relative --dest-dir=$(DESTDIR) --html-dir=$${installdir}; \
251
@if test -n "$(DOC_MODULE_VERSION)"; then \
252
installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
254
installdir="$(DESTDIR)$(TARGET_DIR)"; \
256
rm -rf $${installdir}
259
# Require gtk-doc when making dist
265
@echo "*** gtk-doc must be installed and enabled in order to make dist"
269
dist-hook: dist-check-gtkdoc dist-hook-local
270
@mkdir $(distdir)/tmpl
271
@mkdir $(distdir)/html
272
@-cp ./tmpl/*.sgml $(distdir)/tmpl
273
@cp ./html/* $(distdir)/html
274
@-cp ./$(DOC_MODULE).pdf $(distdir)/
275
@-cp ./$(DOC_MODULE).types $(distdir)/
276
@-cp ./$(DOC_MODULE)-sections.txt $(distdir)/
277
@cd $(distdir) && rm -f $(DISTCLEANFILES)
278
@$(GTKDOC_REBASE) --online --relative --html-dir=$(distdir)/html
280
.PHONY : dist-hook-local docs