1 ## Process this file with automake to produce Makefile.in
3 # The name of the module.
6 # The top-level SGML file.
7 DOC_MAIN_SGML_FILE=glib-docs.sgml
9 # The directory containing the source code. Relative to $(srcdir)
10 DOC_SOURCE_DIR=../../..
12 # Extra options to supply to gtkdoc-scan
15 # Extra options to supply to gtkdoc-mkdb
18 # Extra options to supply to gtkdoc-fixref
21 # Used for dependencies
22 HFILE_GLOB=$(top_srcdir)/*.h $(top_srcdir)/gmodule/*.h
23 CFILE_GLOB=$(top_srcdir)/*.c $(top_srcdir)/gmodule/*.c
35 # Extra files to add when scanning
38 # Images to copy into HTML directory
42 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE)
45 # Other files to distribute
51 # CFLAGS and LDFLAGS for compiling scan program. Only needed
52 # if $(DOC_MODULE).types is non-empty.
56 # Commands for compiling and linking
57 GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
58 GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)
61 ####################################
62 # Everything below here is generic #
63 ####################################
65 TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
71 $(DOC_MAIN_SGML_FILE) \
73 $(DOC_MODULE)-sections.txt \
74 $(DOC_MODULE)-overrides.txt
76 DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp
79 all-local: html-build.stamp
83 $(DOC_MODULE).hierarchy \
86 scan-build.stamp: $(HFILE_GLOB)
87 @echo '*** Scanning header files ***'
89 if grep -l '^.+$$' $(DOC_MODULE).types > /dev/null ; then \
90 CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scangobj --module=$(DOC_MODULE) ; \
92 for i in $(SCANOBJ_FILES) ; do \
93 test -f $$i || touch $$i ; \
97 gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES)
98 touch scan-build.stamp
101 $(MAKE) scan-build.stamp
103 $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): check_scan
105 tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt
106 @echo '*** Rebuilding template files ***'
107 cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE)
108 touch tmpl-build.stamp
111 $(MAKE) tmpl-build.stamp
113 tmpl.stamp: check_templates
115 sgml-build.stamp: tmpl.stamp $(CFILE_GLOB)
116 @echo '*** Building SGML ***'
118 gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) $(MKDB_OPTIONS)
119 touch sgml-build.stamp
122 $(MAKE) sgml-build.stamp
124 sgml.stamp: check_sgml
126 html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE)
127 @echo '*** Building HTML ***'
128 test -d $(srcdir)/html || mkdir $(srcdir)/html
129 cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
130 test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html )
131 @echo '-- Fixing Crossreferences'
132 cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
133 touch html-build.stamp
137 rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS) $(srcdir)/sgml.stamp
139 maintainer-clean-local: clean
140 cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
143 $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
144 (installfiles=`echo $(srcdir)/html/*.html`; \
145 if test "$$installfiles" = '$(srcdir)/html/*.html'; \
146 then echo '-- Nothing to install' ; \
148 for i in $$installfiles; do \
149 echo '-- Installing '$$i ; \
150 $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
152 echo '-- Installing $(srcdir)/html/index.sgml' ; \
153 $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
157 # Require gtk-doc when making dist
163 @echo "*** gtk-doc must be installed and enabled in order to make dist"
167 dist-hook: dist-check-gtkdoc dist-hook-local
168 mkdir $(distdir)/tmpl
169 mkdir $(distdir)/sgml
170 mkdir $(distdir)/html
171 -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
172 -cp $(srcdir)/sgml/*.sgml $(distdir)/sgml
173 -cp $(srcdir)/sgml/*.bottom $(srcdir)/sgml/*.top $(distdir)/sgml
174 -cp $(srcdir)/html/index.sgml $(distdir)/html
175 -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html
176 for i in $(HTML_IMAGES) ; do \
177 cp $(srcdir)/$$i $(distdir)/html ; \
180 .PHONY : check_sgml check_templates check_scan dist-hook-local