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=
  17
  18 # Extra options to supply to gtkdoc-fixref
  19 FIXXREF_OPTIONS=
  20
  21 # Used for dependencies
  22 HFILE_GLOB=$(top_srcdir)/*.h $(top_srcdir)/gmodule/*.h
  23 CFILE_GLOB=$(top_srcdir)/*.c $(top_srcdir)/gmodule/*.c
  24
  25 # Headers to ignore
  26 IGNORE_HFILES=                  \
  27         gobject                 \
  28         config.h                \
  29         glibintl.h              \
  30         gmoduleconf.h           \
  31         gunibreak.h             \
  32         gunidecomp.h            \
  33         gunichartables.h        \
  34         glibconfig-sysdefs.h
  35
  36 # Extra files to add when scanning
  37 EXTRA_HFILES=
  38
  39 # Images to copy into HTML directory
  40 HTML_IMAGES =                           \
  41         mainloop-states.gif
  42
  43 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE)
  44 content_files =
  45
  46 # Other files to distribute
  47 extra_files =                           \
  48         mainloop-states.fig             \
  49         mainloop-states.png             \
  50         mainloop-states.eps
  51
  52 # CFLAGS and LDFLAGS for compiling scan program. Only needed
  53 # if $(DOC_MODULE).types is non-empty.
  54 GTKDOC_CFLAGS =
  55 GTKDOC_LIBS =
  56
  57 # Commands for compiling and linking
  58 GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
  59 GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)
  60
  61
  62 ####################################
  63 # Everything below here is generic #
  64 ####################################
  65
  66 TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
  67
  68 EXTRA_DIST =                            \
  69         $(content_files)                \
  70         $(extra_files)                  \
  71         $(HTML_IMAGES)                  \
  72         $(DOC_MAIN_SGML_FILE)           \
  73         $(DOC_MODULE).types             \
  74         $(DOC_MODULE)-sections.txt      \
  75         $(DOC_MODULE)-overrides.txt
  76
  77 DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \
  78            $(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp
  79
  80 SCANOBJ_FILES =                 \
  81         $(DOC_MODULE).args      \
  82         $(DOC_MODULE).hierarchy \
  83         $(DOC_MODULE).signals
  84
  85 if ENABLE_GTK_DOC
  86 all-local: html-build.stamp
  87
  88 #### scan ####
  89
  90 scan-build.stamp: $(HFILE_GLOB)
  91         @echo '*** Scanning header files ***'
  92         if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null ; then \
  93             CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scangobj --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \
  94         else \
  95             cd $(srcdir) ; \
  96             for i in $(SCANOBJ_FILES) ; do \
  97                test -f $$i || touch $$i ; \
  98             done \
  99         fi
 100         cd $(srcdir) && \
 101           gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES)
 102         touch scan-build.stamp
 103
 104 $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp
 105         @true
 106
 107 #### templates ####
 108
 109 tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt
 110         @echo '*** Rebuilding template files ***'
 111         cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE)
 112         touch tmpl-build.stamp
 113
 114 tmpl.stamp: tmpl-build.stamp
 115         @true
 116
 117 #### sgml ####
 118
 119 sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(srcdir)/tmpl/*.sgml
 120         @echo '*** Building SGML ***'
 121         cd $(srcdir) && \
 122         gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) $(MKDB_OPTIONS)
 123         touch sgml-build.stamp
 124
 125 sgml.stamp: sgml-build.stamp
 126         @true
 127
 128 #### html ####
 129
 130 html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
 131         @echo '*** Building HTML ***'
 132         test -d $(srcdir)/html || mkdir $(srcdir)/html
 133         cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
 134         test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html )
 135         @echo '-- Fixing Crossreferences'
 136         cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
 137         touch html-build.stamp
 138 endif
 139
 140 ##############
 141
 142 clean-local:
 143         rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS)
 144
 145 maintainer-clean-local: clean
 146         cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
 147
 148 install-data-local:
 149         $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
 150         (installfiles=`echo $(srcdir)/html/*.html`; \
 151         if test "$$installfiles" = '$(srcdir)/html/*.html'; \
 152         then echo '-- Nothing to install' ; \
 153         else \
 154           for i in $$installfiles; do \
 155             echo '-- Installing '$$i ; \
 156             $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
 157           done; \
 158           echo '-- Installing $(srcdir)/html/index.sgml' ; \
 159           $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
 160         fi)
 161
 162 #
 163 # Require gtk-doc when making dist
 164 #
 165 if ENABLE_GTK_DOC
 166 dist-check-gtkdoc:
 167 else
 168 dist-check-gtkdoc:
 169         @echo "*** gtk-doc must be installed and enabled in order to make dist"
 170         @false
 171 endif
 172
 173 dist-hook: dist-check-gtkdoc dist-hook-local
 174         mkdir $(distdir)/tmpl
 175         mkdir $(distdir)/sgml
 176         mkdir $(distdir)/html
 177         -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
 178         -cp $(srcdir)/sgml/*.sgml $(distdir)/sgml
 179         -cp $(srcdir)/html/index.sgml $(distdir)/html
 180         -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html
 181
 182         images=$(HTML_IMAGES) ;               \
 183         for i in $$images ; do                \
 184           cp $(srcdir)/$$i $(distdir)/html ;  \
 185         done
 186
 187 .PHONY : dist-hook-local