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 tmpl-build.stamp sgml-build.stamp \
38 html-build.stamp pdf-build.stamp \
39 tmpl.stamp 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
; \
99 test -d
$(abs_srcdir
)/tmpl
&& \
100 { cp
-pR
$(abs_srcdir
)/tmpl
$(abs_builddir
)/; \
101 chmod
-R u
+w
$(abs_builddir
)/tmpl
; } \
103 $(AM_V_at
)touch setup-build.stamp
107 GTK_DOC_V_SCAN
=$(GTK_DOC_V_SCAN_
$(V
))
108 GTK_DOC_V_SCAN_
=$(GTK_DOC_V_SCAN_
$(AM_DEFAULT_VERBOSITY
))
109 GTK_DOC_V_SCAN_0
=@echo
" DOC Scanning header files";
111 GTK_DOC_V_INTROSPECT
=$(GTK_DOC_V_INTROSPECT_
$(V
))
112 GTK_DOC_V_INTROSPECT_
=$(GTK_DOC_V_INTROSPECT_
$(AM_DEFAULT_VERBOSITY
))
113 GTK_DOC_V_INTROSPECT_0
=@echo
" DOC Introspecting gobjects";
115 scan-build.stamp
: setup-build.stamp
$(HFILE_GLOB
) $(CFILE_GLOB
)
116 $(GTK_DOC_V_SCAN
)_source_dir
='' ; \
117 for i in
$(DOC_SOURCE_DIR
) ; do \
118 _source_dir
="$${_source_dir} --source-dir=$$i" ; \
120 gtkdoc-scan
--module
=$(DOC_MODULE
) --ignore-headers
="$(IGNORE_HFILES)" $${_source_dir} $(SCAN_OPTIONS
) $(EXTRA_HFILES
)
121 $(GTK_DOC_V_INTROSPECT
)if grep
-l
'^..*$$' $(DOC_MODULE
).types
> /dev
/null
2>&1 ; then \
122 scanobj_options
=""; \
123 gtkdoc-scangobj
2>&1 --help | grep
>/dev
/null
"\-\-verbose"; \
124 if
test "$$?" = "0"; then \
125 if
test "x$(V)" = "x1"; then \
126 scanobj_options
="--verbose"; \
129 CC
="$(GTKDOC_CC)" LD
="$(GTKDOC_LD)" RUN
="$(GTKDOC_RUN)" CFLAGS
="$(GTKDOC_CFLAGS) $(CFLAGS)" LDFLAGS
="$(GTKDOC_LIBS) $(LDFLAGS)" \
130 gtkdoc-scangobj
$(SCANGOBJ_OPTIONS
) $$scanobj_options --module
=$(DOC_MODULE
); \
132 for i in
$(SCANOBJ_FILES
) ; do \
133 test -f
$$i || touch
$$i ; \
136 $(AM_V_at
)touch scan-build.stamp
138 $(DOC_MODULE
)-decl.txt
$(SCANOBJ_FILES
) $(DOC_MODULE
)-sections.txt
$(DOC_MODULE
)-overrides.txt
: scan-build.stamp
143 GTK_DOC_V_TMPL
=$(GTK_DOC_V_TMPL_
$(V
))
144 GTK_DOC_V_TMPL_
=$(GTK_DOC_V_TMPL_
$(AM_DEFAULT_VERBOSITY
))
145 GTK_DOC_V_TMPL_0
=@echo
" DOC Rebuilding template files";
147 tmpl-build.stamp
: setup-build.stamp
$(DOC_MODULE
)-decl.txt
$(SCANOBJ_FILES
) $(DOC_MODULE
)-sections.txt
$(DOC_MODULE
)-overrides.txt
148 $(GTK_DOC_V_TMPL
)gtkdoc-mktmpl
--module
=$(DOC_MODULE
) $(MKTMPL_OPTIONS
)
149 $(AM_V_at
)if
test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
150 if
test -w
$(abs_srcdir
) ; then \
151 cp
-pR
$(abs_builddir
)/tmpl
$(abs_srcdir
)/; \
154 $(AM_V_at
)touch tmpl-build.stamp
156 tmpl.stamp
: tmpl-build.stamp
159 $(srcdir)/tmpl
/*.sgml
:
164 GTK_DOC_V_XML
=$(GTK_DOC_V_XML_
$(V
))
165 GTK_DOC_V_XML_
=$(GTK_DOC_V_XML_
$(AM_DEFAULT_VERBOSITY
))
166 GTK_DOC_V_XML_0
=@echo
" DOC Building XML";
168 sgml-build.stamp
: tmpl.stamp
$(DOC_MODULE
)-sections.txt
$(srcdir)/tmpl
/*.sgml
$(expand_content_files
)
169 -$(GTK_DOC_V_XML
)chmod
-R u
+w
$(srcdir) && _source_dir
='' ; \
170 for i in
$(DOC_SOURCE_DIR
) ; do \
171 _source_dir
="$${_source_dir} --source-dir=$$i" ; \
173 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
)
174 $(AM_V_at
)touch sgml-build.stamp
176 sgml.stamp
: sgml-build.stamp
181 GTK_DOC_V_HTML
=$(GTK_DOC_V_HTML_
$(V
))
182 GTK_DOC_V_HTML_
=$(GTK_DOC_V_HTML_
$(AM_DEFAULT_VERBOSITY
))
183 GTK_DOC_V_HTML_0
=@echo
" DOC Building HTML";
185 GTK_DOC_V_XREF
=$(GTK_DOC_V_XREF_
$(V
))
186 GTK_DOC_V_XREF_
=$(GTK_DOC_V_XREF_
$(AM_DEFAULT_VERBOSITY
))
187 GTK_DOC_V_XREF_0
=@echo
" DOC Fixing cross-references";
189 html-build.stamp
: sgml.stamp
$(DOC_MAIN_SGML_FILE
) $(content_files
) $(expand_content_files
)
190 $(GTK_DOC_V_HTML
)rm -rf html
&& mkdir html
&& \
192 gtkdoc-mkhtml
2>&1 --help | grep
>/dev
/null
"\-\-verbose"; \
193 if
test "$$?" = "0"; then \
194 if
test "x$(V)" = "x1"; then \
195 mkhtml_options
="$$mkhtml_options --verbose"; \
198 gtkdoc-mkhtml
2>&1 --help | grep
>/dev
/null
"\-\-path"; \
199 if
test "$$?" = "0"; then \
200 mkhtml_options
="$$mkhtml_options --path=\"$(abs_srcdir)\""; \
202 cd html
&& gtkdoc-mkhtml
$$mkhtml_options $(MKHTML_OPTIONS
) $(DOC_MODULE
) ..
/$(DOC_MAIN_SGML_FILE
)
203 -@
test "x$(HTML_IMAGES)" = "x" || \
204 for file in
$(HTML_IMAGES
) ; do \
205 if
test -f
$(abs_srcdir
)/$$file ; then \
206 cp
$(abs_srcdir
)/$$file $(abs_builddir
)/html
; \
208 if
test -f
$(abs_builddir
)/$$file ; then \
209 cp
$(abs_builddir
)/$$file $(abs_builddir
)/html
; \
212 $(GTK_DOC_V_XREF
)gtkdoc-fixxref
--module
=$(DOC_MODULE
) --module-dir
=html
--html-dir
=$(HTML_DIR
) $(FIXXREF_OPTIONS
)
213 $(AM_V_at
)touch html-build.stamp
217 GTK_DOC_V_PDF
=$(GTK_DOC_V_PDF_
$(V
))
218 GTK_DOC_V_PDF_
=$(GTK_DOC_V_PDF_
$(AM_DEFAULT_VERBOSITY
))
219 GTK_DOC_V_PDF_0
=@echo
" DOC Building PDF";
221 pdf-build.stamp
: sgml.stamp
$(DOC_MAIN_SGML_FILE
) $(content_files
) $(expand_content_files
)
222 $(GTK_DOC_V_PDF
)rm -f
$(DOC_MODULE
).pdf
&& \
224 gtkdoc-mkpdf
2>&1 --help | grep
>/dev
/null
"\-\-verbose"; \
225 if
test "$$?" = "0"; then \
226 if
test "x$(V)" = "x1"; then \
227 mkpdf_options
="$$mkpdf_options --verbose"; \
230 if
test "x$(HTML_IMAGES)" != "x"; then \
231 for img in
$(HTML_IMAGES
); do \
232 part
=`dirname $$img`; \
233 echo
$$mkpdf_options | grep
>/dev
/null
"\-\-imgdir=$$part "; \
234 if
test $$?
!= 0; then \
235 mkpdf_options
="$$mkpdf_options --imgdir=$$part"; \
239 gtkdoc-mkpdf
--path
="$(abs_srcdir)" $$mkpdf_options $(DOC_MODULE
) $(DOC_MAIN_SGML_FILE
) $(MKPDF_OPTIONS
)
240 $(AM_V_at
)touch pdf-build.stamp
247 @if echo
$(SCAN_OPTIONS
) | grep
-q
"\-\-rebuild-types" ; then \
248 rm -f
$(DOC_MODULE
).types
; \
250 @if echo
$(SCAN_OPTIONS
) | grep
-q
"\-\-rebuild-sections" ; then \
251 rm -f
$(DOC_MODULE
)-sections.txt
; \
255 @
rm -rf xml html
$(REPORT_FILES
) $(DOC_MODULE
).pdf \
256 $(DOC_MODULE
)-decl-list.txt
$(DOC_MODULE
)-decl.txt
257 @if
test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
258 rm -f
$(SETUP_FILES
) $(DOC_MODULE
).types
; \
262 maintainer-clean-local
:
266 @installfiles
=`echo $(builddir)/html/*`; \
267 if
test "$$installfiles" = '$(builddir)/html/*'; \
268 then echo
1>&2 'Nothing to install' ; \
270 if
test -n
"$(DOC_MODULE_VERSION)"; then \
271 installdir
="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
273 installdir
="$(DESTDIR)$(TARGET_DIR)"; \
275 $(mkinstalldirs
) $${installdir} ; \
276 for i in
$$installfiles; do \
277 echo
' $(INSTALL_DATA) '$$i ; \
278 $(INSTALL_DATA
) $$i $${installdir}; \
280 if
test -n
"$(DOC_MODULE_VERSION)"; then \
281 mv
-f
$${installdir}/$(DOC_MODULE
).devhelp2 \
282 $${installdir}/$(DOC_MODULE
)-$(DOC_MODULE_VERSION
).devhelp2
; \
284 $(GTKDOC_REBASE
) --relative
--dest-dir
=$(DESTDIR
) --html-dir
=$${installdir}; \
288 @if
test -n
"$(DOC_MODULE_VERSION)"; then \
289 installdir
="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
291 installdir
="$(DESTDIR)$(TARGET_DIR)"; \
293 rm -rf
$${installdir}
296 # Require gtk-doc when making dist
299 dist-check-gtkdoc
: docs
302 @echo
"*** gtk-doc is needed to run 'make dist'. ***"
303 @echo
"*** gtk-doc was not found when 'configure' ran. ***"
304 @echo
"*** please install gtk-doc and rerun 'configure'. ***"
308 dist-hook
: dist-check-gtkdoc all-gtk-doc dist-hook-local
309 @mkdir
$(distdir
)/tmpl
310 @mkdir
$(distdir
)/html
311 @
-cp .
/tmpl
/*.sgml
$(distdir
)/tmpl
312 @cp .
/html
/* $(distdir
)/html
313 @
-cp .
/$(DOC_MODULE
).pdf
$(distdir
)/
314 @
-cp .
/$(DOC_MODULE
).types
$(distdir
)/
315 @
-cp .
/$(DOC_MODULE
)-sections.txt
$(distdir
)/
316 @cd
$(distdir
) && rm -f
$(DISTCLEANFILES
)
317 @
$(GTKDOC_REBASE
) --online
--relative
--html-dir
=$(distdir
)/html
319 .PHONY
: dist-hook-local docs