docs/reference/gobject/Makefile.am

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