Pileus Git - ~andy/gtk/blob - docs/reference/gtk/Makefile.am

   1 ## Process this file with automake to produce Makefile.in
   2
   3 # The name of the module.
   4 DOC_MODULE=gtk
   5
   6 # The top-level SGML file.
   7 DOC_MAIN_SGML_FILE=gtk-docs.sgml
   8
   9 # The directory containing the source code. Relative to $(srcdir)
  10 DOC_SOURCE_DIR=../../../gtk
  11
  12 # Extra options to supply to gtkdoc-scan
  13 SCAN_OPTIONS=--deprecated-guards="GTK_ENABLE_BROKEN|GTK_DISABLE_DEPRECATED"
  14
  15 # Extra options to supply to gtkdoc-mkdb
  16 MKDB_OPTIONS=--sgml-mode
  17
  18 # Extra options to supply to gtkdoc-fixref
  19 FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
  20
  21 # Used for dependencies
  22 HFILE_GLOB=$(top_srcdir)/gtk/*.h
  23 CFILE_GLOB=$(top_srcdir)/gtk/*.c
  24
  25 # Header files to ignore when scanning
  26 IGNORE_HFILES=                  \
  27         fnmatch.h               \
  28         gdk-pixbuf-loader.h     \
  29         gtkdebug.h              \
  30         gtkhsv.h                \
  31         gtkimmodule.h           \
  32         gtkintl.h               \
  33         gtkmarshal.h            \
  34         gtkprivate.h            \
  35         gtktreeprivate.h        \
  36         gtkrbtree.h             \
  37         gtktreedatalist.h       \
  38         gtktextbtree.h          \
  39         gtktextdisplay.h        \
  40         gtktextiterprivate.h    \
  41         gtktextlayout.h         \
  42         gtktextmarkprivate.h    \
  43         gtktextsegment.h        \
  44         gtktexttagprivate.h     \
  45         gtktexttypes.h          \
  46         gtktextutil.h           \
  47         gtktypebuiltins.h       \
  48         xembed.h
  49
  50 # Images to copy into HTML directory
  51 HTML_IMAGES = \
  52         $(top_srcdir)/gtk/stock-icons/stock_add.png                     \
  53         $(top_srcdir)/gtk/stock-icons/stock_button_apply.png            \
  54         $(top_srcdir)/gtk/stock-icons/stock_text_bold.png               \
  55         $(top_srcdir)/gtk/stock-icons/stock_button_cancel.png           \
  56         $(top_srcdir)/gtk/stock-icons/stock_cdrom.png                   \
  57         $(top_srcdir)/gtk/stock-icons/stock_clear.png                   \
  58         $(top_srcdir)/gtk/stock-icons/stock_close.png                   \
  59         $(top_srcdir)/gtk/stock-icons/stock_convert.png                 \
  60         $(top_srcdir)/gtk/stock-icons/stock_menu_copy.png               \
  61         $(top_srcdir)/gtk/stock-icons/stock_menu_cut.png                \
  62         $(top_srcdir)/gtk/stock-icons/stock_menu_trash.png              \
  63         $(top_srcdir)/gtk/stock-icons/dialog_error.png                  \
  64         $(top_srcdir)/gtk/stock-icons/dialog_info.png                   \
  65         $(top_srcdir)/gtk/stock-icons/dialog_question.png               \
  66         $(top_srcdir)/gtk/stock-icons/dialog_warning.png                \
  67         $(top_srcdir)/gtk/stock-icons/stock_dnd.png                     \
  68         $(top_srcdir)/gtk/stock-icons/stock_dnd_multiple.png            \
  69         $(top_srcdir)/gtk/stock-icons/stock_exec.png                    \
  70         $(top_srcdir)/gtk/stock-icons/stock_search.png                  \
  71         $(top_srcdir)/gtk/stock-icons/stock_search_replace.png          \
  72         $(top_srcdir)/gtk/stock-icons/stock_save.png                    \
  73         $(top_srcdir)/gtk/stock-icons/stock_bottom.png                  \
  74         $(top_srcdir)/gtk/stock-icons/stock_first.png                   \
  75         $(top_srcdir)/gtk/stock-icons/stock_last.png                    \
  76         $(top_srcdir)/gtk/stock-icons/stock_top.png                     \
  77         $(top_srcdir)/gtk/stock-icons/stock_left_arrow.png              \
  78         $(top_srcdir)/gtk/stock-icons/stock_down_arrow.png              \
  79         $(top_srcdir)/gtk/stock-icons/stock_right_arrow.png             \
  80         $(top_srcdir)/gtk/stock-icons/stock_up_arrow.png                \
  81         $(top_srcdir)/gtk/stock-icons/stock_help.png                    \
  82         $(top_srcdir)/gtk/stock-icons/stock_home.png                    \
  83         $(top_srcdir)/gtk/stock-icons/stock_index.png                   \
  84         $(top_srcdir)/gtk/stock-icons/stock_text_italic.png             \
  85         $(top_srcdir)/gtk/stock-icons/stock_jump_to.png                 \
  86         $(top_srcdir)/gtk/stock-icons/stock_align_center.png            \
  87         $(top_srcdir)/gtk/stock-icons/stock_align_justify.png           \
  88         $(top_srcdir)/gtk/stock-icons/stock_align_left.png              \
  89         $(top_srcdir)/gtk/stock-icons/stock_align_right.png             \
  90         $(top_srcdir)/gtk/stock-icons/dialog_error.png                  \
  91         $(top_srcdir)/gtk/stock-icons/stock_new.png                     \
  92         $(top_srcdir)/gtk/stock-icons/stock_button_no.png               \
  93         $(top_srcdir)/gtk/stock-icons/stock_button_ok.png               \
  94         $(top_srcdir)/gtk/stock-icons/stock_open.png                    \
  95         $(top_srcdir)/gtk/stock-icons/stock_paste.png                   \
  96         $(top_srcdir)/gtk/stock-icons/stock_preferences.png             \
  97         $(top_srcdir)/gtk/stock-icons/stock_print.png                   \
  98         $(top_srcdir)/gtk/stock-icons/stock_print_preview.png           \
  99         $(top_srcdir)/gtk/stock-icons/stock_properties.png              \
 100         $(top_srcdir)/gtk/stock-icons/stock_exit.png                    \
 101         $(top_srcdir)/gtk/stock-icons/stock_redo.png                    \
 102         $(top_srcdir)/gtk/stock-icons/stock_refresh.png                 \
 103         $(top_srcdir)/gtk/stock-icons/stock_remove.png                  \
 104         $(top_srcdir)/gtk/stock-icons/stock_revert.png                  \
 105         $(top_srcdir)/gtk/stock-icons/stock_save.png                    \
 106         $(top_srcdir)/gtk/stock-icons/stock_save_as.png                 \
 107         $(top_srcdir)/gtk/stock-icons/stock_colorselector.png           \
 108         $(top_srcdir)/gtk/stock-icons/stock_font.png                    \
 109         $(top_srcdir)/gtk/stock-icons/stock_sort_ascending.png          \
 110         $(top_srcdir)/gtk/stock-icons/stock_sort_descending.png         \
 111         $(top_srcdir)/gtk/stock-icons/stock_spellcheck.png              \
 112         $(top_srcdir)/gtk/stock-icons/stock_stop.png                    \
 113         $(top_srcdir)/gtk/stock-icons/stock_text_strikeout.png          \
 114         $(top_srcdir)/gtk/stock-icons/stock_undelete.png                \
 115         $(top_srcdir)/gtk/stock-icons/stock_text_underline.png          \
 116         $(top_srcdir)/gtk/stock-icons/stock_undo.png                    \
 117         $(top_srcdir)/gtk/stock-icons/stock_button_yes.png              \
 118         $(top_srcdir)/gtk/stock-icons/stock_zoom_1.png                  \
 119         $(top_srcdir)/gtk/stock-icons/stock_zoom_fit.png                \
 120         $(top_srcdir)/gtk/stock-icons/stock_zoom_in.png                 \
 121         $(top_srcdir)/gtk/stock-icons/stock_zoom_out.png
 122
 123 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE)
 124 content_files =                 \
 125         building.sgml           \
 126         compiling.sgml          \
 127         framebuffer.sgml        \
 128         objects_grouped.sgml    \
 129         resources.sgml          \
 130         text_widget.sgml        \
 131         tree_widget.sgml        \
 132         windows.sgml
 133
 134 # Other files to distribute
 135 extra_files =
 136
 137 # CFLAGS and LDFLAGS for compiling scan program. Only needed
 138 # if $(DOC_MODULE).types is non-empty.
 139 GTKDOC_CFLAGS = @STRIP_BEGIN@                           \
 140         @CFLAGS@                                        \
 141         -I$(top_srcdir)                                 \
 142         -I$(top_builddir)                               \
 143         -I$(top_builddir)/gdk                           \
 144         -DGTK_ENABLE_BROKEN                             \
 145         @GTK_DEBUG_FLAGS@                               \
 146         @GTK_DEP_CFLAGS@                                \
 147 @STRIP_END@
 148
 149 GTKDOC_LIBS = @STRIP_BEGIN@                             \
 150         $(top_builddir)/gdk-pixbuf/libgdk_pixbuf-1.3.la \
 151         $(top_builddir)/gdk/@gdktargetlib@              \
 152         $(top_builddir)/gtk/@gtktargetlib@              \
 153 @STRIP_END@
 154
 155 GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
 156 GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)
 157
 158
 159 ####################################
 160 # Everything below here is generic #
 161 ####################################
 162
 163 # We set GPATH here; this gives us semantics for GNU make
 164 # which are more like other make's VPATH, when it comes to
 165 # whether a source that is a target of one rule is then
 166 # searched for in VPATH/GPATH.
 167 #
 168 GPATH = $(srcdir)
 169
 170 TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
 171
 172 EXTRA_DIST =                            \
 173         $(content_files)                \
 174         $(extra_files)                  \
 175         $(HTML_IMAGES)                  \
 176         $(DOC_MAIN_SGML_FILE)           \
 177         $(DOC_MODULE).types             \
 178         $(DOC_MODULE)-sections.txt      \
 179         $(DOC_MODULE)-overrides.txt
 180
 181 DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \
 182            $(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp
 183
 184 SCANOBJ_FILES =                 \
 185         $(DOC_MODULE).args      \
 186         $(DOC_MODULE).hierarchy \
 187         $(DOC_MODULE).signals
 188
 189 if ENABLE_GTK_DOC
 190 all-local: html-build.stamp
 191
 192 #### scan ####
 193
 194 scan-build.stamp: $(HFILE_GLOB)
 195         @echo '*** Scanning header files ***'
 196         if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null ; then \
 197             CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scangobj --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \
 198         else \
 199             cd $(srcdir) ; \
 200             for i in $(SCANOBJ_FILES) ; do \
 201                test -f $$i || touch $$i ; \
 202             done \
 203         fi
 204         cd $(srcdir) && \
 205           gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES)
 206         touch scan-build.stamp
 207
 208 $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp
 209         @true
 210
 211 #### templates ####
 212
 213 tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt
 214         @echo '*** Rebuilding template files ***'
 215         cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE)
 216         touch tmpl-build.stamp
 217
 218 tmpl.stamp: tmpl-build.stamp
 219         @true
 220
 221 #### sgml ####
 222
 223 sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(srcdir)/tmpl/*.sgml
 224         @echo '*** Building SGML ***'
 225         cd $(srcdir) && \
 226         gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) $(MKDB_OPTIONS)
 227         touch sgml-build.stamp
 228
 229 sgml.stamp: sgml-build.stamp
 230         @true
 231
 232 #### html ####
 233
 234 html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
 235         @echo '*** Building HTML ***'
 236         rm -rf $(srcdir)/html
 237         mkdir $(srcdir)/html
 238         cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
 239         test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html )
 240         @echo '-- Fixing Crossreferences'
 241         cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
 242         touch html-build.stamp
 243 endif
 244
 245 ##############
 246
 247 clean-local:
 248         rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS)
 249
 250 maintainer-clean-local: clean
 251         cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
 252
 253 install-data-local:
 254         $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
 255         (installfiles=`echo $(srcdir)/html/*`; \
 256         if test "$$installfiles" = '$(srcdir)/html/*'; \
 257         then echo '-- Nothing to install' ; \
 258         else \
 259           for i in $$installfiles; do \
 260             echo '-- Installing '$$i ; \
 261             $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
 262           done; \
 263           echo '-- Installing $(srcdir)/html/index.sgml' ; \
 264           $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
 265         fi)
 266
 267 #
 268 # Require gtk-doc when making dist
 269 #
 270 if ENABLE_GTK_DOC
 271 dist-check-gtkdoc:
 272 else
 273 dist-check-gtkdoc:
 274         @echo "*** gtk-doc must be installed and enabled in order to make dist"
 275         @false
 276 endif
 277
 278 dist-hook: dist-check-gtkdoc dist-hook-local
 279         mkdir $(distdir)/tmpl
 280         mkdir $(distdir)/sgml
 281         mkdir $(distdir)/html
 282         -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
 283         -cp $(srcdir)/sgml/*.sgml $(distdir)/sgml
 284         -cp $(srcdir)/html/* $(distdir)/html
 285
 286 .PHONY : dist-hook-local