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_@AM_V@
)
85 GTK_DOC_V_SETUP_
=$(GTK_DOC_V_SETUP_@AM_DEFAULT_V@
)
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
104 GTK_DOC_V_SCAN
=$(GTK_DOC_V_SCAN_@AM_V@
)
105 GTK_DOC_V_SCAN_
=$(GTK_DOC_V_SCAN_@AM_DEFAULT_V@
)
106 GTK_DOC_V_SCAN_0
=@echo
" DOC Scanning header files";
108 GTK_DOC_V_INTROSPECT
=$(GTK_DOC_V_INTROSPECT_@AM_V@
)
109 GTK_DOC_V_INTROSPECT_
=$(GTK_DOC_V_INTROSPECT_@AM_DEFAULT_V@
)
110 GTK_DOC_V_INTROSPECT_0
=@echo
" DOC Introspecting gobjects";
112 scan-build.stamp
: setup-build.stamp
$(HFILE_GLOB
) $(CFILE_GLOB
)
113 $(GTK_DOC_V_SCAN
)_source_dir
='' ; \
114 for i in
$(DOC_SOURCE_DIR
) ; do \
115 _source_dir
="$${_source_dir} --source-dir=$$i" ; \
117 gtkdoc-scan
--module
=$(DOC_MODULE
) --ignore-headers
="$(IGNORE_HFILES)" $${_source_dir} $(SCAN_OPTIONS
) $(EXTRA_HFILES
)
118 $(GTK_DOC_V_INTROSPECT
)if grep
-l
'^..*$$' $(DOC_MODULE
).types
> /dev
/null
2>&1 ; then \
119 scanobj_options
=""; \
120 gtkdoc-scangobj
2>&1 --help | grep
>/dev
/null
"\-\-verbose"; \
121 if
test "$$?" = "0"; then \
122 if
test "x$(V)" = "x1"; then \
123 scanobj_options
="--verbose"; \
126 CC
="$(GTKDOC_CC)" LD
="$(GTKDOC_LD)" RUN
="$(GTKDOC_RUN)" CFLAGS
="$(GTKDOC_CFLAGS) $(CFLAGS)" LDFLAGS
="$(GTKDOC_LIBS) $(LDFLAGS)" \
127 gtkdoc-scangobj
$(SCANGOBJ_OPTIONS
) $$scanobj_options --module
=$(DOC_MODULE
); \
129 for i in
$(SCANOBJ_FILES
) ; do \
130 test -f
$$i || touch
$$i ; \
133 $(AM_V_at
)touch scan-build.stamp
135 $(DOC_MODULE
)-decl.txt
$(SCANOBJ_FILES
) $(DOC_MODULE
)-sections.txt
$(DOC_MODULE
)-overrides.txt
: scan-build.stamp
140 GTK_DOC_V_XML
=$(GTK_DOC_V_XML_@AM_V@
)
141 GTK_DOC_V_XML_
=$(GTK_DOC_V_XML_@AM_DEFAULT_V@
)
142 GTK_DOC_V_XML_0
=@echo
" DOC Building XML";
144 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
145 $(GTK_DOC_V_XML
)_source_dir
='' ; \
146 for i in
$(DOC_SOURCE_DIR
) ; do \
147 _source_dir
="$${_source_dir} --source-dir=$$i" ; \
149 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
)
150 $(AM_V_at
)touch sgml-build.stamp
152 sgml.stamp
: sgml-build.stamp
155 $(DOC_MAIN_SGML_FILE
): sgml-build.stamp
158 xml
/gtkdocentities.ent
: Makefile
159 $(GTK_DOC_V_XML
)$(MKDIR_P
) $(@D
) && ( \
160 echo
"<!ENTITY package \"$(PACKAGE)\">"; \
161 echo
"<!ENTITY package_bugreport \"$(PACKAGE_BUGREPORT)\">"; \
162 echo
"<!ENTITY package_name \"$(PACKAGE_NAME)\">"; \
163 echo
"<!ENTITY package_string \"$(PACKAGE_STRING)\">"; \
164 echo
"<!ENTITY package_tarname \"$(PACKAGE_TARNAME)\">"; \
165 echo
"<!ENTITY package_url \"$(PACKAGE_URL)\">"; \
166 echo
"<!ENTITY package_version \"$(PACKAGE_VERSION)\">"; \
171 GTK_DOC_V_HTML
=$(GTK_DOC_V_HTML_@AM_V@
)
172 GTK_DOC_V_HTML_
=$(GTK_DOC_V_HTML_@AM_DEFAULT_V@
)
173 GTK_DOC_V_HTML_0
=@echo
" DOC Building HTML";
175 GTK_DOC_V_XREF
=$(GTK_DOC_V_XREF_@AM_V@
)
176 GTK_DOC_V_XREF_
=$(GTK_DOC_V_XREF_@AM_DEFAULT_V@
)
177 GTK_DOC_V_XREF_0
=@echo
" DOC Fixing cross-references";
179 html-build.stamp
: sgml.stamp
$(DOC_MAIN_SGML_FILE
) $(content_files
) $(expand_content_files
)
180 $(GTK_DOC_V_HTML
)rm -rf html
&& mkdir html
&& \
182 gtkdoc-mkhtml
2>&1 --help | grep
>/dev
/null
"\-\-verbose"; \
183 if
test "$$?" = "0"; then \
184 if
test "x$(V)" = "x1"; then \
185 mkhtml_options
="$$mkhtml_options --verbose"; \
188 gtkdoc-mkhtml
2>&1 --help | grep
>/dev
/null
"\-\-path"; \
189 if
test "$$?" = "0"; then \
190 mkhtml_options
="$$mkhtml_options --path=\"$(abs_srcdir)\""; \
192 cd html
&& gtkdoc-mkhtml
$$mkhtml_options $(MKHTML_OPTIONS
) $(DOC_MODULE
) ..
/$(DOC_MAIN_SGML_FILE
)
193 -@
test "x$(HTML_IMAGES)" = "x" || \
194 for file in
$(HTML_IMAGES
) ; do \
195 test -f
$(abs_srcdir
)/$$file && cp
$(abs_srcdir
)/$$file $(abs_builddir
)/html
; \
196 test -f
$(abs_builddir
)/$$file && cp
$(abs_builddir
)/$$file $(abs_builddir
)/html
; \
198 $(GTK_DOC_V_XREF
)gtkdoc-fixxref
--module
=$(DOC_MODULE
) --module-dir
=html
--html-dir
=$(HTML_DIR
) $(FIXXREF_OPTIONS
)
199 $(AM_V_at
)touch html-build.stamp
203 GTK_DOC_V_PDF
=$(GTK_DOC_V_PDF_@AM_V@
)
204 GTK_DOC_V_PDF_
=$(GTK_DOC_V_PDF_@AM_DEFAULT_V@
)
205 GTK_DOC_V_PDF_0
=@echo
" DOC Building PDF";
207 pdf-build.stamp
: sgml.stamp
$(DOC_MAIN_SGML_FILE
) $(content_files
) $(expand_content_files
)
208 $(GTK_DOC_V_PDF
)rm -f
$(DOC_MODULE
).pdf
&& \
210 gtkdoc-mkpdf
2>&1 --help | grep
>/dev
/null
"\-\-verbose"; \
211 if
test "$$?" = "0"; then \
212 if
test "x$(V)" = "x1"; then \
213 mkpdf_options
="$$mkpdf_options --verbose"; \
216 if
test "x$(HTML_IMAGES)" != "x"; then \
217 for img in
$(HTML_IMAGES
); do \
218 part
=`dirname $$img`; \
219 echo
$$mkpdf_options | grep
>/dev
/null
"\-\-imgdir=$$part "; \
220 if
test $$?
!= 0; then \
221 mkpdf_options
="$$mkpdf_options --imgdir=$$part"; \
225 gtkdoc-mkpdf
--path
="$(abs_srcdir)" $$mkpdf_options $(DOC_MODULE
) $(DOC_MAIN_SGML_FILE
) $(MKPDF_OPTIONS
)
226 $(AM_V_at
)touch pdf-build.stamp
233 @if echo
$(SCAN_OPTIONS
) | grep
-q
"\-\-rebuild-types" ; then \
234 rm -f
$(DOC_MODULE
).types
; \
236 @if echo
$(SCAN_OPTIONS
) | grep
-q
"\-\-rebuild-sections" ; then \
237 rm -f
$(DOC_MODULE
)-sections.txt
; \
241 @
rm -rf xml html
$(REPORT_FILES
) $(DOC_MODULE
).pdf \
242 $(DOC_MODULE
)-decl-list.txt
$(DOC_MODULE
)-decl.txt
243 @if
test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
244 rm -f
$(SETUP_FILES
) $(DOC_MODULE
).types
; \
247 maintainer-clean-local
:
251 @installfiles
=`echo $(builddir)/html/*`; \
252 if
test "$$installfiles" = '$(builddir)/html/*'; \
253 then echo
1>&2 'Nothing to install' ; \
255 if
test -n
"$(DOC_MODULE_VERSION)"; then \
256 installdir
="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
258 installdir
="$(DESTDIR)$(TARGET_DIR)"; \
260 $(mkinstalldirs
) $${installdir} ; \
261 for i in
$$installfiles; do \
262 echo
' $(INSTALL_DATA) '$$i ; \
263 $(INSTALL_DATA
) $$i $${installdir}; \
265 if
test -n
"$(DOC_MODULE_VERSION)"; then \
266 mv
-f
$${installdir}/$(DOC_MODULE
).devhelp2 \
267 $${installdir}/$(DOC_MODULE
)-$(DOC_MODULE_VERSION
).devhelp2
; \
269 $(GTKDOC_REBASE
) --relative
--dest-dir
=$(DESTDIR
) --html-dir
=$${installdir}; \
273 @if
test -n
"$(DOC_MODULE_VERSION)"; then \
274 installdir
="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
276 installdir
="$(DESTDIR)$(TARGET_DIR)"; \
278 rm -rf
$${installdir}
281 # Require gtk-doc when making dist
284 dist-check-gtkdoc
: docs
287 @echo
"*** gtk-doc is needed to run 'make dist'. ***"
288 @echo
"*** gtk-doc was not found when 'configure' ran. ***"
289 @echo
"*** please install gtk-doc and rerun 'configure'. ***"
293 dist-hook
: dist-check-gtkdoc all-gtk-doc dist-hook-local
294 @mkdir
$(distdir
)/html
295 @cp .
/html
/* $(distdir
)/html
296 @
-cp .
/$(DOC_MODULE
).pdf
$(distdir
)/
297 @
-cp .
/$(DOC_MODULE
).types
$(distdir
)/
298 @
-cp .
/$(DOC_MODULE
)-sections.txt
$(distdir
)/
299 @cd
$(distdir
) && rm -f
$(DISTCLEANFILES
)
300 @
$(GTKDOC_REBASE
) --online
--relative
--html-dir
=$(distdir
)/html
302 .PHONY
: dist-hook-local docs