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=gdk-docs.sgml
9 # The directory containing the source code. Relative to $(srcdir)
10 DOC_SOURCE_DIR=../../../gdk
12 # Extra options to supply to gtkdoc-scan
13 SCAN_OPTIONS=--deprecated-guards="GDK_ENABLE_BROKEN|GDK_DISABLE_DEPRECATED"
15 # Extra options to supply to gtkdoc-mkdb
16 MKDB_OPTIONS=--sgml-mode --output-format=xml
18 # Extra options to supply to gtkdoc-fixref
19 FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html
21 # Used for dependencies
22 HFILE_GLOB=$(top_srcdir)/gdk/*.h $(top_srcdir)/gdk/x11/gdkx.h
23 CFILE_GLOB=$(top_srcdir)/gdk/*.c
25 # Header files to ignore when scanning
39 # Extra files to add when scanning (relative to $srcdir)
41 ../../../gdk/x11/gdkx.h
43 # Images to copy into HTML directory
47 images/based_arrow_down.png \
48 images/based_arrow_up.png \
51 images/bottom_left_corner.png \
52 images/bottom_right_corner.png \
53 images/bottom_side.png \
54 images/bottom_tee.png \
55 images/box_spiral.png \
56 images/center_ptr.png \
59 images/coffee_mug.png \
61 images/cross_reverse.png \
62 images/crosshair.png \
63 images/diamond_cross.png \
66 images/double_arrow.png \
67 images/draft_large.png \
68 images/draft_small.png \
69 images/draped_box.png \
78 images/iron_cross.png \
80 images/left_side.png \
82 images/leftbutton.png \
86 images/middlebutton.png \
91 images/question_arrow.png \
92 images/right_ptr.png \
93 images/right_side.png \
94 images/right_tee.png \
95 images/rightbutton.png \
98 images/sb_down_arrow.png \
99 images/sb_h_double_arrow.png \
100 images/sb_left_arrow.png \
101 images/sb_right_arrow.png \
102 images/sb_up_arrow.png \
103 images/sb_v_double_arrow.png \
107 images/spraycan.png \
111 images/top_left_arrow.png \
112 images/top_left_corner.png \
113 images/top_right_corner.png \
114 images/top_side.png \
117 images/ul_angle.png \
118 images/umbrella.png \
119 images/ur_angle.png \
123 # Extra SGML files that are included by DOC_MAIN_SGML_FILE
126 # Other files to distribute
129 # CFLAGS and LDFLAGS for compiling scan program. Only needed
130 # if $(DOC_MODULE).types is non-empty.
131 GTKDOC_CFLAGS = @STRIP_BEGIN@ \
135 -I$(top_builddir)/gdk \
140 GTKDOC_LIBS = @STRIP_BEGIN@ \
141 $(top_builddir)/gdk/@gdktargetlib@ \
144 # Commands for compiling and linking
145 GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
146 GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)
149 ####################################
150 # Everything below here is generic #
151 ####################################
153 # We set GPATH here; this gives us semantics for GNU make
154 # which are more like other make's VPATH, when it comes to
155 # whether a source that is a target of one rule is then
156 # searched for in VPATH/GPATH.
160 TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
166 $(DOC_MAIN_SGML_FILE) \
167 $(DOC_MODULE).types \
168 $(DOC_MODULE)-sections.txt \
169 $(DOC_MODULE)-overrides.txt
171 DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \
172 $(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp
176 $(DOC_MODULE).hierarchy \
177 $(DOC_MODULE).interfaces \
178 $(DOC_MODULE).signals
181 all-local: html-build.stamp
185 scan-build.stamp: $(HFILE_GLOB)
186 @echo '*** Scanning header files ***'
187 if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null ; then \
188 CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scangobj --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \
191 for i in $(SCANOBJ_FILES) ; do \
192 test -f $$i || touch $$i ; \
196 gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES)
197 touch scan-build.stamp
199 $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp
204 tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt
205 @echo '*** Rebuilding template files ***'
206 cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE)
207 touch tmpl-build.stamp
209 tmpl.stamp: tmpl-build.stamp
214 sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(srcdir)/tmpl/*.sgml
215 @echo '*** Building SGML ***'
217 gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) $(MKDB_OPTIONS)
218 touch sgml-build.stamp
220 sgml.stamp: sgml-build.stamp
225 html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
226 @echo '*** Building HTML ***'
227 rm -rf $(srcdir)/html
229 cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
230 test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html )
231 @echo '-- Fixing Crossreferences'
232 cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
233 touch html-build.stamp
239 rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS)
241 maintainer-clean-local: clean
242 cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
245 $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
246 (installfiles=`echo $(srcdir)/html/*`; \
247 if test "$$installfiles" = '$(srcdir)/html/*'; \
248 then echo '-- Nothing to install' ; \
250 for i in $$installfiles; do \
251 echo '-- Installing '$$i ; \
252 $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
254 echo '-- Installing $(srcdir)/html/index.sgml' ; \
255 $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
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
272 mkdir $(distdir)/html
273 -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
274 -cp $(srcdir)/xml/*.xml $(distdir)/xml
275 -cp $(srcdir)/html/* $(distdir)/html
277 .PHONY : dist-hook-local