build/Makefile.am.gtk-doc

   1 # -*- mode: makefile -*-
   2
   3
   4 adg_docdir=     $(abs_top_srcdir)/docs/common
   5 GTKDOC_MKHTML=  $(XSLTPROC) \
   6                         --nonet --xinclude \
   7                         --path $(abs_top_srcdir)/docs/gnu \
   8                         --stringparam gtkdoc.bookname $(DOC_MODULE) \
   9                         --stringparam gtkdoc.version "1.18" \
  10                         --stringparam chunk.quietly 1 \
  11                         --stringparam chunker.output.quiet 1 \
  12                         $(MKHTML_OPTIONS) \
  13                         $(adg_docdir)/gtk-doc.xsl \
  14                         ../$(DOC_MAIN_SGML_FILE)
  15
  16
  17 ####################################
  18 # Everything below here is generic #
  19 ####################################
  20
  21 if GTK_DOC_USE_LIBTOOL
  22 GTKDOC_CC = $(LIBTOOL) --tag=CC --mode=compile $(CC) $(INCLUDES) $(GTKDOC_DEPS_CFLAGS) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
  23 GTKDOC_LD = $(LIBTOOL) --tag=CC --mode=link $(CC) $(GTKDOC_DEPS_LIBS) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS)
  24 GTKDOC_RUN = $(LIBTOOL) --mode=execute
  25 else
  26 GTKDOC_CC = $(CC) $(INCLUDES) $(GTKDOC_DEPS_CFLAGS) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
  27 GTKDOC_LD = $(CC) $(GTKDOC_DEPS_LIBS) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS)
  28 GTKDOC_RUN =
  29 endif
  30
  31 # We set GPATH here; this gives us semantics for GNU make
  32 # which are more like other make's VPATH, when it comes to
  33 # whether a source that is a target of one rule is then
  34 # searched for in VPATH/GPATH.
  35 #
  36 GPATH = $(srcdir)
  37
  38 TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
  39
  40 SETUP_FILES = \
  41         $(content_files)                \
  42         $(DOC_MAIN_SGML_FILE)           \
  43         $(DOC_MODULE)-sections.txt      \
  44         $(DOC_MODULE)-overrides.txt
  45
  46 EXTRA_DIST =                            \
  47         $(HTML_IMAGES)                  \
  48         $(SETUP_FILES)
  49
  50 DOC_STAMPS=setup-build.stamp scan-build.stamp sgml-build.stamp \
  51         html-build.stamp pdf-build.stamp \
  52         sgml.stamp html.stamp pdf.stamp
  53
  54 SCANOBJ_FILES =                  \
  55         $(DOC_MODULE).args       \
  56         $(DOC_MODULE).hierarchy  \
  57         $(DOC_MODULE).interfaces \
  58         $(DOC_MODULE).prerequisites \
  59         $(DOC_MODULE).signals
  60
  61 REPORT_FILES = \
  62         $(DOC_MODULE)-undocumented.txt \
  63         $(DOC_MODULE)-undeclared.txt \
  64         $(DOC_MODULE)-unused.txt
  65
  66 CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS)
  67
  68 if ENABLE_GTK_DOC
  69 if GTK_DOC_BUILD_HTML
  70 HTML_BUILD_STAMP=html-build.stamp
  71 else
  72 HTML_BUILD_STAMP=
  73 endif
  74 if GTK_DOC_BUILD_PDF
  75 PDF_BUILD_STAMP=pdf-build.stamp
  76 else
  77 PDF_BUILD_STAMP=
  78 endif
  79
  80 all-local: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP)
  81 else
  82 all-local:
  83 endif
  84
  85 docs: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP)
  86
  87 $(REPORT_FILES): sgml-build.stamp
  88
  89 #### setup ####
  90
  91 setup-build.stamp:
  92         -@if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
  93             echo '  DOC   Preparing build'; \
  94             files=`echo $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types`; \
  95             if test "x$$files" != "x" ; then \
  96                 for file in $$files ; do \
  97                     test -f $(abs_srcdir)/$$file && \
  98                         cp -pu $(abs_srcdir)/$$file $(abs_builddir)/ || true; \
  99                 done; \
 100             fi; \
 101         fi
 102         @touch setup-build.stamp
 103
 104
 105 #### scan ####
 106
 107 scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB) scan-hook
 108         @echo '  DOC   Scanning header files'
 109         @_source_dir='' ; \
 110         for i in $(DOC_SOURCE_DIR) ; do \
 111             _source_dir="$${_source_dir} --source-dir=$$i" ; \
 112         done ; \
 113         gtkdoc-scan --module=$(DOC_MODULE) --ignore-headers="$(IGNORE_HFILES)" $${_source_dir} $(SCAN_OPTIONS) $(EXTRA_HFILES)
 114         @if grep -l '^..*$$' $(DOC_MODULE).types > /dev/null 2>&1 ; then \
 115             echo "  DOC   Introspecting gobjects"; \
 116             scanobj_options=""; \
 117             gtkdoc-scangobj 2>&1 --help | grep  >/dev/null "\-\-verbose"; \
 118             if test "$(?)" = "0"; then \
 119                 if test "x$(V)" = "x1"; then \
 120                     scanobj_options="--verbose"; \
 121                 fi; \
 122             fi; \
 123             CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" RUN="$(GTKDOC_RUN)" CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS)" LDFLAGS="$(GTKDOC_LIBS) $(LDFLAGS)" \
 124             gtkdoc-scangobj $(SCANGOBJ_OPTIONS) $$scanobj_options --module=$(DOC_MODULE); \
 125         else \
 126             for i in $(SCANOBJ_FILES) ; do \
 127                 test -f $$i || touch $$i ; \
 128             done \
 129         fi
 130         @touch scan-build.stamp
 131
 132 $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt: scan-build.stamp
 133         @true
 134
 135 #### xml ####
 136
 137 sgml-build.stamp: setup-build.stamp $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt $(expand_content_files)
 138         @echo '  DOC   Building XML'
 139         @_source_dir='' ; \
 140         for i in $(DOC_SOURCE_DIR) ; do \
 141             _source_dir="$${_source_dir} --source-dir=$$i" ; \
 142         done ; \
 143         gtkdoc-mkdb --module=$(DOC_MODULE) --output-format=xml --expand-content-files="$(expand_content_files)" --main-sgml-file=$(DOC_MAIN_SGML_FILE) $${_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 '  DOC   Building HTML'
 153         @rm -rf html
 154         @mkdir html
 155         @cd html && $(GTKDOC_MKHTML) && \
 156           cp -f $(adg_docdir)/*.png ./ && cp -f $(adg_docdir)/*.css ./ && \
 157           echo "timestamp" > ../html.stamp || exit $?
 158         -@test "x$(HTML_IMAGES)" = "x" || \
 159         for file in $(HTML_IMAGES) ; do \
 160           if test -f $(abs_srcdir)/$$file ; then \
 161             cp $(abs_srcdir)/$$file $(abs_builddir)/html; \
 162           fi; \
 163           if test -f $(abs_builddir)/$$file ; then \
 164             cp $(abs_builddir)/$$file $(abs_builddir)/html; \
 165           fi; \
 166         done;
 167         @echo '  DOC   Fixing cross-references'
 168         @gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
 169         @touch html-build.stamp
 170
 171 #### pdf ####
 172
 173 pdf-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
 174         @echo '  DOC   Building PDF'
 175         @rm -f $(DOC_MODULE).pdf
 176         @mkpdf_options=""; \
 177         gtkdoc-mkpdf 2>&1 --help | grep  >/dev/null "\-\-verbose"; \
 178         if test "$(?)" = "0"; then \
 179           if test "x$(V)" = "x1"; then \
 180             mkpdf_options="$$mkpdf_options --verbose"; \
 181           fi; \
 182         fi; \
 183         if test "x$(HTML_IMAGES)" != "x"; then \
 184           for img in $(HTML_IMAGES); do \
 185             part=`dirname $$img`; \
 186             echo $$mkpdf_options | grep >/dev/null "\-\-imgdir=$$part "; \
 187             if test $$? != 0; then \
 188               mkpdf_options="$$mkpdf_options --imgdir=$$part"; \
 189             fi; \
 190           done; \
 191         fi; \
 192         gtkdoc-mkpdf --path="$(abs_srcdir)" $$mkpdf_options $(DOC_MODULE) $(DOC_MAIN_SGML_FILE) $(MKPDF_OPTIONS)
 193         @touch pdf-build.stamp
 194
 195 ##############
 196
 197 clean-local:
 198         @rm -f *~ *.bak
 199         @rm -rf .libs
 200
 201 distclean-local:
 202         @rm -rf xml html $(REPORT_FILES) $(DOC_MODULE).pdf \
 203             $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
 204         @if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
 205             rm -f $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types; \
 206         fi
 207
 208 maintainer-clean-local: clean
 209         @rm -rf xml html
 210
 211 install-data-local:
 212         @installfiles=`echo $(builddir)/html/*`; \
 213         if test "$$installfiles" = '$(builddir)/html/*'; \
 214         then echo 1>&2 'Nothing to install' ; \
 215         else \
 216           if test -n "$(DOC_MODULE_VERSION)"; then \
 217             installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
 218           else \
 219             installdir="$(DESTDIR)$(TARGET_DIR)"; \
 220           fi; \
 221           $(mkinstalldirs) $${installdir} ; \
 222           for i in $$installfiles; do \
 223             echo ' $(INSTALL_DATA) '$$i ; \
 224             $(INSTALL_DATA) $$i $${installdir}; \
 225           done; \
 226           if test -n "$(DOC_MODULE_VERSION)"; then \
 227             mv -f $${installdir}/$(DOC_MODULE).devhelp2 \
 228               $${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp2; \
 229           fi; \
 230           $(GTKDOC_REBASE) --relative --dest-dir=$(DESTDIR) --html-dir=$${installdir}; \
 231         fi
 232
 233 uninstall-local:
 234         @if test -n "$(DOC_MODULE_VERSION)"; then \
 235           installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
 236         else \
 237           installdir="$(DESTDIR)$(TARGET_DIR)"; \
 238         fi; \
 239         rm -rf $${installdir}
 240
 241 #
 242 # Require gtk-doc when making dist
 243 #
 244 if ENABLE_GTK_DOC
 245 dist-check-gtkdoc:
 246 else
 247 dist-check-gtkdoc:
 248         @echo "*** gtk-doc must be installed and enabled in order to make dist"
 249         @false
 250 endif
 251
 252 dist-hook: dist-check-gtkdoc dist-hook-local
 253         @mkdir $(distdir)/html
 254         @cp ./html/* $(distdir)/html
 255         @-cp ./$(DOC_MODULE).pdf $(distdir)/
 256         @-cp ./$(DOC_MODULE).types $(distdir)/
 257         @-cp ./$(DOC_MODULE)-sections.txt $(distdir)/
 258         @cd $(distdir) && rm -f $(DISTCLEANFILES)
 259         @$(GTKDOC_REBASE) --online --relative --html-dir=$(distdir)/html
 260
 261 .PHONY : dist-hook-local docs scan-hook