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
)
29 $(DOC_MAIN_SGML_FILE
) \
30 $(DOC_MODULE
)-sections.txt \
31 $(DOC_MODULE
)-overrides.txt
36 DOC_STAMPS
=setup-build.stamp scan-build.stamp sgml-build.stamp \
37 html-build.stamp pdf-build.stamp \
38 setup.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
'gtk-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
-p
$(abs_srcdir
)/$$file $(abs_builddir
)/; \
88 @touch setup-build.stamp
91 setup.stamp
: setup-build.stamp
97 scan-build.stamp
: $(HFILE_GLOB
) $(CFILE_GLOB
)
98 @echo
'gtk-doc: Scanning header files'
100 for i in
$(DOC_SOURCE_DIR
) ; do \
101 _source_dir
="$${_source_dir} --source-dir=$$i" ; \
103 gtkdoc-scan
--module
=$(DOC_MODULE
) --ignore-headers
="$(IGNORE_HFILES)" $${_source_dir} $(SCAN_OPTIONS
) $(EXTRA_HFILES
)
104 @if grep
-l
'^..*$$' $(DOC_MODULE
).types
> /dev
/null
2>&1 ; then \
105 CC
="$(GTKDOC_CC)" LD
="$(GTKDOC_LD)" RUN
="$(GTKDOC_RUN)" CFLAGS
="$(GTKDOC_CFLAGS) $(CFLAGS)" LDFLAGS
="$(GTKDOC_LIBS) $(LDFLAGS)" gtkdoc-scangobj
$(SCANGOBJ_OPTIONS
) --module
=$(DOC_MODULE
) ; \
107 for i in
$(SCANOBJ_FILES
) ; do \
108 test -f
$$i || touch
$$i ; \
111 @touch scan-build.stamp
113 $(DOC_MODULE
)-decl.txt
$(SCANOBJ_FILES
) $(DOC_MODULE
)-sections.txt
$(DOC_MODULE
)-overrides.txt
: scan-build.stamp
118 sgml-build.stamp
: setup.stamp
$(DOC_MODULE
)-decl.txt
$(SCANOBJ_FILES
) $(DOC_MODULE
)-sections.txt
$(DOC_MODULE
)-overrides.txt
$(expand_content_files
)
119 @echo
'gtk-doc: Building XML'
121 for i in
$(DOC_SOURCE_DIR
) ; do \
122 _source_dir
="$${_source_dir} --source-dir=$$i" ; \
124 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
)
125 @touch sgml-build.stamp
127 sgml.stamp
: sgml-build.stamp
132 html-build.stamp
: sgml.stamp
$(DOC_MAIN_SGML_FILE
) $(content_files
)
133 @echo
'gtk-doc: Building HTML'
136 @mkhtml_options
=""; \
137 gtkdoc-mkhtml
2>&1 --help | grep
>/dev
/null
"\-\-path"; \
138 if
test "$(?)" = "0"; then \
139 mkhtml_options
=--path
="$(abs_srcdir)"; \
141 cd html
&& gtkdoc-mkhtml
$$mkhtml_options $(MKHTML_OPTIONS
) $(DOC_MODULE
) ..
/$(DOC_MAIN_SGML_FILE
)
142 @
test "x$(HTML_IMAGES)" = "x" ||
( cd
$(srcdir) && cp
$(HTML_IMAGES
) $(abs_builddir
)/html
)
143 @echo
'gtk-doc: Fixing cross-references'
144 @gtkdoc-fixxref
--module
=$(DOC_MODULE
) --module-dir
=html
--html-dir
=$(HTML_DIR
) $(FIXXREF_OPTIONS
)
145 @touch html-build.stamp
149 pdf-build.stamp
: sgml.stamp
$(DOC_MAIN_SGML_FILE
) $(content_files
)
150 @echo
'gtk-doc: Building PDF'
151 @
rm -rf
$(DOC_MODULE
).pdf
153 if
test "x$(HTML_IMAGES)" != "x"; then \
154 for img in
$(HTML_IMAGES
); do \
155 part
=`dirname $$img`; \
156 echo
$$mkpdf_imgdirs | grep
>/dev
/null
"\-\-imgdir=$$part "; \
157 if
test $$?
!= 0; then \
158 mkpdf_imgdirs
="$$mkpdf_imgdirs --imgdir=$$part"; \
162 gtkdoc-mkpdf
--path
="$(abs_srcdir)" $$mkpdf_imgdirs $(DOC_MODULE
) $(DOC_MAIN_SGML_FILE
) $(MKPDF_OPTIONS
)
163 @touch pdf-build.stamp
172 rm -rf xml html
$(REPORT_FILES
) $(DOC_MODULE
).pdf \
173 $(DOC_MODULE
)-decl-list.txt
$(DOC_MODULE
)-decl.txt
174 if
test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
175 rm -f
$(SETUP_FILES
) $(expand_content_files
) $(DOC_MODULE
).types
; \
178 maintainer-clean-local
: clean
182 @installfiles
=`echo $(builddir)/html/*`; \
183 if
test "$$installfiles" = '$(srcdir)/html/*'; \
184 then echo
'-- Nothing to install' ; \
186 if
test -n
"$(DOC_MODULE_VERSION)"; then \
187 installdir
="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
189 installdir
="$(DESTDIR)$(TARGET_DIR)"; \
191 $(mkinstalldirs
) $${installdir} ; \
192 for i in
$$installfiles; do \
193 echo
'-- Installing '$$i ; \
194 $(INSTALL_DATA
) $$i $${installdir}; \
196 if
test -n
"$(DOC_MODULE_VERSION)"; then \
197 mv
-f
$${installdir}/$(DOC_MODULE
).devhelp2 \
198 $${installdir}/$(DOC_MODULE
)-$(DOC_MODULE_VERSION
).devhelp2
; \
199 mv
-f
$${installdir}/$(DOC_MODULE
).devhelp \
200 $${installdir}/$(DOC_MODULE
)-$(DOC_MODULE_VERSION
).devhelp
; \
202 $(GTKDOC_REBASE
) --relative
--dest-dir
=$(DESTDIR
) --html-dir
=$${installdir}; \
206 @if
test -n
"$(DOC_MODULE_VERSION)"; then \
207 installdir
="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
209 installdir
="$(DESTDIR)$(TARGET_DIR)"; \
211 rm -rf
$${installdir}
214 # Require gtk-doc when making dist
220 @echo
"*** gtk-doc must be installed and enabled in order to make dist"
224 dist-hook
: dist-check-gtkdoc dist-hook-local
225 mkdir
$(distdir
)/html
226 cp
$(builddir
)/html
/* $(distdir
)/html
227 -cp
$(builddir
)/$(DOC_MODULE
).pdf
$(distdir
)/
228 -cp
$(builddir
)/$(DOC_MODULE
).types
$(distdir
)/
229 -cp
$(builddir
)/$(DOC_MODULE
)-sections.txt
$(distdir
)/
230 cd
$(distdir
) && rm -f
$(DISTCLEANFILES
)
231 $(GTKDOC_REBASE
) --online
--relative
--html-dir
=$(distdir
)/html
233 .PHONY
: dist-hook-local docs