tests/gtk-doc.notmpl.make

   1 # -*- mode: makefile -*-
   2
   3 ####################################
   4 # Everything below here is generic #
   5 ####################################
   6
   7 if GTK_DOC_USE_LIBTOOL
   8 GTKDOC_CC = $(LIBTOOL) --tag=CC --mode=compile $(CC) $(INCLUDES) $(GTKDOC_DEPS_CFLAGS) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
   9 GTKDOC_LD = $(LIBTOOL) --tag=CC --mode=link $(CC) $(GTKDOC_DEPS_LIBS) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS)
  10 GTKDOC_RUN = $(LIBTOOL) --mode=execute
  11 else
  12 GTKDOC_CC = $(CC) $(INCLUDES) $(GTKDOC_DEPS_CFLAGS) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
  13 GTKDOC_LD = $(CC) $(GTKDOC_DEPS_LIBS) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS)
  14 GTKDOC_RUN =
  15 endif
  16
  17 # We set GPATH here; this gives us semantics for GNU make
  18 # which are more like other make's VPATH, when it comes to
  19 # whether a source that is a target of one rule is then
  20 # searched for in VPATH/GPATH.
  21 #
  22 GPATH = $(srcdir)
  23
  24 # we don't install anything in tests
  25 #TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
  26
  27 SETUP_FILES = \
  28         $(content_files)                \
  29         $(DOC_MAIN_SGML_FILE)           \
  30         $(DOC_MODULE)-sections.txt      \
  31         $(DOC_MODULE)-overrides.txt
  32
  33 EXTRA_DIST =                            \
  34         $(HTML_IMAGES)                  \
  35         $(SETUP_FILES)
  36
  37 DOC_STAMPS=setup-build.stamp scan-build.stamp sgml-build.stamp \
  38         html-build.stamp pdf-build.stamp \
  39         sgml.stamp html.stamp pdf.stamp
  40
  41 SCANOBJ_FILES =                  \
  42         $(DOC_MODULE).args       \
  43         $(DOC_MODULE).hierarchy  \
  44         $(DOC_MODULE).interfaces \
  45         $(DOC_MODULE).prerequisites \
  46         $(DOC_MODULE).signals
  47
  48 REPORT_FILES = \
  49         $(DOC_MODULE)-undocumented.txt \
  50         $(DOC_MODULE)-undeclared.txt \
  51         $(DOC_MODULE)-unused.txt
  52
  53 CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS)
  54
  55 check-local: html-build.stamp pdf-build.stamp
  56         @ts1=`cat ts`;ts2=`date +%s.%N`;tsd=`echo $$ts2-$$ts1 | bc`; \
  57         echo "  DOC   `date --utc --date @0$$tsd +%H:%M:%S.%N`: All done"
  58
  59 docs: html-build.stamp pdf-build.stamp
  60         @ts1=`cat ts`;ts2=`date +%s.%N`;tsd=`echo $$ts2-$$ts1 | bc`; \
  61         echo "  DOC   `date --utc --date @0$$tsd +%H:%M:%S.%N`: All done"
  62
  63 $(REPORT_FILES): sgml-build.stamp
  64
  65 #### setup ####
  66
  67 setup-build.stamp:
  68         @echo >ts `date +%s.%N`;
  69         -@if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
  70             echo '  DOC   Preparing build'; \
  71             files=`echo $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types`; \
  72             if test "x$$files" != "x" ; then \
  73                 for file in $$files ; do \
  74                     test -f $(abs_srcdir)/$$file && \
  75                         cp -pu $(abs_srcdir)/$$file $(abs_builddir)/ || true; \
  76                 done; \
  77             fi; \
  78         fi
  79         @touch setup-build.stamp
  80
  81 #### scan ####
  82
  83 scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB)
  84         @ts1=`cat ts`;ts2=`date +%s.%N`;tsd=`echo $$ts2-$$ts1 | bc`; \
  85         echo "  DOC   `date --utc --date @0$$tsd +%H:%M:%S.%N`: Scanning header files"
  86         @_source_dir='' ; \
  87         for i in $(DOC_SOURCE_DIR) ; do \
  88             _source_dir="$${_source_dir} --source-dir=$$i" ; \
  89         done ; \
  90         echo "gtkdoc-scan --module=$(DOC_MODULE) --ignore-headers="$(IGNORE_HFILES)" $${_source_dir} $(SCAN_OPTIONS) $(EXTRA_HFILES)"  >gtkdoc-scan.log; \
  91         PATH=$(abs_top_builddir):$(PATH) PERL5LIB=$(abs_top_builddir):$(PERL5LIB) \
  92         gtkdoc-scan --module=$(DOC_MODULE) --ignore-headers="$(IGNORE_HFILES)" $${_source_dir} $(SCAN_OPTIONS) $(EXTRA_HFILES) 2>&1 | tee -a gtkdoc-scan.log
  93         @if grep -l '^..*$$' $(DOC_MODULE).types > /dev/null 2>&1 ; then \
  94                 ts1=`cat ts`;ts2=`date +%s.%N`;tsd=`echo $$ts2-$$ts1 | bc`; \
  95             echo "  DOC   `date --utc --date @0$$tsd +%H:%M:%S.%N`: Introspecting gobjects"; \
  96             scanobj_options=""; \
  97             if test "x$(V)" = "x1"; then \
  98                 scanobj_options="--verbose"; \
  99             fi; \
 100             echo "gtkdoc-scangobj $(SCANGOBJ_OPTIONS) --module=$(DOC_MODULE) $$scanobj_options" >gtkdoc-scangobj.log; \
 101             PATH=$(abs_top_builddir):$(PATH) PERL5LIB=$(abs_top_builddir):$(PERL5LIB) \
 102             CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" RUN="$(GTKDOC_RUN)" CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS)" LDFLAGS="$(GTKDOC_LIBS) $(LDFLAGS)" \
 103             gtkdoc-scangobj $(SCANGOBJ_OPTIONS) --module=$(DOC_MODULE) $$scanobj_options 2>&1 | tee -a gtkdoc-scangobj.log; \
 104         else \
 105             for i in $(SCANOBJ_FILES) ; do \
 106                 test -f $$i || touch $$i ; \
 107             done \
 108         fi
 109         @touch scan-build.stamp
 110
 111 $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt: scan-build.stamp
 112         @true
 113
 114 #### xml ####
 115
 116 sgml-build.stamp: setup-build.stamp $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt $(expand_content_files)
 117         @ts1=`cat ts`;ts2=`date +%s.%N`;tsd=`echo $$ts2-$$ts1 | bc`; \
 118         echo "  DOC   `date --utc --date @0$$tsd +%H:%M:%S.%N`: Building XML"
 119         @_source_dir='' ; \
 120         for i in $(DOC_SOURCE_DIR) ; do \
 121             _source_dir="$${_source_dir} --source-dir=$$i" ; \
 122         done ; \
 123         echo "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)" >gtkdoc-mkdb.log; \
 124         PATH=$(abs_top_builddir):$(PATH) PERL5LIB=$(abs_top_builddir):$(PERL5LIB) \
 125         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) 2>&1 | tee -a gtkdoc-mkdb.log
 126         @touch sgml-build.stamp
 127
 128 sgml.stamp: sgml-build.stamp
 129         @true
 130
 131 #### html ####
 132
 133 html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
 134         @ts1=`cat ts`;ts2=`date +%s.%N`;tsd=`echo $$ts2-$$ts1 | bc`; \
 135         echo "  DOC   `date --utc --date @00$$tsd +%H:%M:%S.%N`: Building HTML"
 136         @rm -rf html
 137         @mkdir html
 138         @mkhtml_options=""; \
 139         if test "x$(V)" = "x1"; then \
 140           mkhtml_options="$$mkhtml_options --verbose"; \
 141         fi; \
 142         echo "gtkdoc-mkhtml --uninstalled --path="$(abs_srcdir)" $$mkhtml_options $(MKHTML_OPTIONS) $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)" >gtkdoc-mkhtml.log; \
 143         cd html && PATH=$(abs_top_builddir):$(PATH) PERL5LIB=$(abs_top_builddir):$(PERL5LIB) ABS_TOP_SRCDIR=$(abs_top_srcdir) \
 144         gtkdoc-mkhtml --uninstalled --path="$(abs_srcdir)" $$mkhtml_options $(MKHTML_OPTIONS) $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) 2>&1 | tee -a ../gtkdoc-mkhtml.log
 145         -@test "x$(HTML_IMAGES)" = "x" || \
 146         for file in $(HTML_IMAGES) ; do \
 147           if test -f $(abs_srcdir)/$$file ; then \
 148             cp $(abs_srcdir)/$$file $(abs_builddir)/html; \
 149           fi; \
 150           if test -f $(abs_builddir)/$$file ; then \
 151             cp $(abs_builddir)/$$file $(abs_builddir)/html; \
 152           fi; \
 153         done;
 154         @ts1=`cat ts`;ts2=`date +%s.%N`;tsd=`echo $$ts2-$$ts1 | bc`; \
 155         echo "  DOC   `date --utc --date @0$$tsd +%H:%M:%S.%N`: Fixing cross-references"
 156         @echo "gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)" >gtkdoc-fixxref.log; \
 157         PATH=$(abs_top_builddir):$(PATH) PERL5LIB=$(abs_top_builddir):$(PERL5LIB) \
 158         gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) 2>&1 | tee -a gtkdoc-fixxref.log
 159         @touch html-build.stamp
 160
 161 #### pdf ####
 162
 163 pdf-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
 164         @ts1=`cat ts`;ts2=`date +%s.%N`;tsd=`echo $$ts2-$$ts1 | bc`; \
 165         echo "  DOC   `date --utc --date @0$$tsd +%H:%M:%S.%N`: Building PDF"
 166         @rm -f $(DOC_MODULE).pdf
 167         @mkpdf_options=""; \
 168         if test "x$(V)" = "x1"; then \
 169           mkpdf_options="$$mkpdf_options --verbose"; \
 170         fi; \
 171         if test "x$(HTML_IMAGES)" != "x"; then \
 172           for img in $(HTML_IMAGES); do \
 173             part=`dirname $$img`; \
 174             echo $$mkpdf_options | grep >/dev/null "\-\-imgdir=$$part "; \
 175             if test $$? != 0; then \
 176               mkpdf_options="$$mkpdf_options --imgdir=$$part"; \
 177             fi; \
 178           done; \
 179         fi; \
 180         echo "gtkdoc-mkpdf --uninstalled --path="$(abs_srcdir)" $$mkpdf_options $(DOC_MODULE) $(DOC_MAIN_SGML_FILE) $(MKPDF_OPTIONS)" >gtkdoc-mkpdf.log; \
 181         PATH=$(abs_top_builddir):$(PATH) PERL5LIB=$(abs_top_builddir):$(PERL5LIB) ABS_TOP_SRCDIR=$(abs_top_srcdir) \
 182         gtkdoc-mkpdf --uninstalled --path="$(abs_srcdir)" $$mkpdf_options $(DOC_MODULE) $(DOC_MAIN_SGML_FILE) $(MKPDF_OPTIONS) 2>&1 | tee -a gtkdoc-mkpdf.log
 183         @touch pdf-build.stamp
 184
 185 ##############
 186
 187 # we need to enforce a rebuild for the tests
 188 clean-local:
 189         @rm -f *~ *.bak ts
 190         @rm -rf .libs
 191         $(MAKE) distclean-local
 192
 193 distclean-local:
 194         @rm -rf xml html $(REPORT_FILES) $(DOC_MODULE).pdf \
 195             $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
 196         @if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
 197             rm -f $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types; \
 198         fi
 199
 200 maintainer-clean-local: clean
 201         @rm -rf xml html
 202
 203 .PHONY : dist-hook-local docs