docs/reference/glib/Makefile.am

   1 ## Process this file with automake to produce Makefile.in
   2
   3 # The name of the module.
   4 DOC_MODULE=glib
   5
   6 # The top-level SGML file.
   7 DOC_MAIN_SGML_FILE=glib-docs.sgml
   8
   9 # The directory containing the source code. Relative to $(srcdir)
  10 DOC_SOURCE_DIR=../../..
  11
  12 # Extra options to supply to gtkdoc-scan
  13 SCAN_OPTIONS=--deprecated-guards="G_DISABLE_DEPRECATED"
  14
  15 # Extra options to supply to gtkdoc-mkdb
  16 MKDB_OPTIONS=--sgml-mode --output-format=xml
  17
  18 # Extra options to supply to gtkdoc-fixref
  19 FIXXREF_OPTIONS=
  20
  21 # Used for dependencies
  22 HFILE_GLOB=$(top_srcdir)/glib/*.h $(top_srcdir)/gmodule/*.h
  23 CFILE_GLOB=$(top_srcdir)/glib/*.c $(top_srcdir)/gmodule/*.c
  24
  25 # Headers to ignore
  26 IGNORE_HFILES=                  \
  27         build                   \
  28         gobject                 \
  29         config.h                \
  30         glibintl.h              \
  31         gbsearcharray.h         \
  32         gmoduleconf.h           \
  33         gunibreak.h             \
  34         gunicomp.h              \
  35         gunidecomp.h            \
  36         gunichartables.h        \
  37         glibconfig-sysdefs.h    \
  38         gdebug.h
  39
  40 # Extra files to add when scanning
  41 EXTRA_HFILES=
  42
  43 # Images to copy into HTML directory
  44 HTML_IMAGES =                           \
  45         mainloop-states.gif
  46
  47 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE)
  48 content_files =                         \
  49         running.sgml                    \
  50         building.sgml                   \
  51         changes-2.0.sgml                \
  52         compiling.sgml                  \
  53         resources.sgml                  \
  54         version.xml
  55
  56
  57 # Other files to distribute
  58 extra_files =                           \
  59         mainloop-states.fig             \
  60         mainloop-states.png             \
  61         mainloop-states.eps             \
  62         version.xml.in
  63
  64 # CFLAGS and LDFLAGS for compiling scan program. Only needed
  65 # if $(DOC_MODULE).types is non-empty.
  66 GTKDOC_CFLAGS =
  67 GTKDOC_LIBS =
  68
  69 # Commands for compiling and linking
  70 GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
  71 GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)
  72
  73
  74 ####################################
  75 # Everything below here is generic #
  76 ####################################
  77
  78 # We set GPATH here; this gives us semantics for GNU make
  79 # which are more like other make's VPATH, when it comes to
  80 # whether a source that is a target of one rule is then
  81 # searched for in VPATH/GPATH.
  82 #
  83 GPATH = $(srcdir)
  84
  85 TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
  86
  87 EXTRA_DIST =                            \
  88         $(content_files)                \
  89         $(extra_files)                  \
  90         $(HTML_IMAGES)                  \
  91         $(DOC_MAIN_SGML_FILE)           \
  92         $(DOC_MODULE).types             \
  93         $(DOC_MODULE)-sections.txt      \
  94         $(DOC_MODULE)-overrides.txt
  95
  96 DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \
  97            $(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp
  98
  99 SCANOBJ_FILES =                  \
 100         $(DOC_MODULE).args       \
 101         $(DOC_MODULE).hierarchy  \
 102         $(DOC_MODULE).interfaces \
 103         $(DOC_MODULE).prerequisites \
 104         $(DOC_MODULE).signals
 105
 106 if ENABLE_GTK_DOC
 107 all-local: html-build.stamp
 108
 109 #### scan ####
 110
 111 scan-build.stamp: $(HFILE_GLOB)
 112         @echo '*** Scanning header files ***'
 113         if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null ; then \
 114             CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scangobj --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \
 115         else \
 116             cd $(srcdir) ; \
 117             for i in $(SCANOBJ_FILES) ; do \
 118                test -f $$i || touch $$i ; \
 119             done \
 120         fi
 121         cd $(srcdir) && \
 122           gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES)
 123         touch scan-build.stamp
 124
 125 $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp
 126         @true
 127
 128 #### templates ####
 129
 130 tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt
 131         @echo '*** Rebuilding template files ***'
 132         cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE)
 133         touch tmpl-build.stamp
 134
 135 tmpl.stamp: tmpl-build.stamp
 136         @true
 137
 138 #### sgml ####
 139
 140 sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(srcdir)/tmpl/*.sgml
 141         @echo '*** Building SGML ***'
 142         cd $(srcdir) && \
 143         gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) $(MKDB_OPTIONS)
 144         touch sgml-build.stamp
 145
 146 sgml.stamp: sgml-build.stamp
 147         @true
 148
 149 #### html ####
 150
 151 html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
 152         @echo '*** Building HTML ***'
 153         rm -rf $(srcdir)/html
 154         mkdir $(srcdir)/html
 155         cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
 156         test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html )
 157         @echo '-- Fixing Crossreferences'
 158         cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
 159         touch html-build.stamp
 160 endif
 161
 162 ##############
 163
 164 clean-local:
 165         rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS)
 166
 167 maintainer-clean-local: clean
 168         cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
 169
 170 install-data-local:
 171         $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
 172         (installfiles=`echo $(srcdir)/html/*`; \
 173         if test "$$installfiles" = '$(srcdir)/html/*'; \
 174         then echo '-- Nothing to install' ; \
 175         else \
 176           for i in $$installfiles; do \
 177             echo '-- Installing '$$i ; \
 178             $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
 179           done; \
 180           echo '-- Installing $(srcdir)/html/index.sgml' ; \
 181           $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
 182         fi)
 183
 184 #
 185 # Require gtk-doc when making dist
 186 #
 187 if ENABLE_GTK_DOC
 188 dist-check-gtkdoc:
 189 else
 190 dist-check-gtkdoc:
 191         @echo "*** gtk-doc must be installed and enabled in order to make dist"
 192         @false
 193 endif
 194
 195 dist-hook: dist-check-gtkdoc dist-hook-local
 196         mkdir $(distdir)/tmpl
 197         mkdir $(distdir)/xml
 198         mkdir $(distdir)/html
 199         -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
 200         -cp $(srcdir)/sgml/*.xml $(distdir)/xml
 201         -cp $(srcdir)/html/* $(distdir)/html
 202
 203 .PHONY : dist-hook-local
 204
 205