tests/gtk-doc.make

   1 # -*- mode: makefile -*-
   2
   3 ####################################
   4 # Everything below here is generic #
   5 ####################################
   6
   7 if GTK_DOC_USE_LIBTOOL
   8 GTKDOC_CC = $(LIBTOOL) --mode=compile $(CC) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
   9 GTKDOC_LD = $(LIBTOOL) --mode=link $(CC) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS)
  10 else
  11 GTKDOC_CC = $(CC) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
  12 GTKDOC_LD = $(CC) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS)
  13 endif
  14
  15 # We set GPATH here; this gives us semantics for GNU make
  16 # which are more like other make's VPATH, when it comes to
  17 # whether a source that is a target of one rule is then
  18 # searched for in VPATH/GPATH.
  19 #
  20 GPATH = $(srcdir)
  21
  22 TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
  23
  24 EXTRA_DIST =                            \
  25         $(content_files)                \
  26         $(HTML_IMAGES)                  \
  27         $(DOC_MAIN_SGML_FILE)           \
  28         $(DOC_MODULE)-sections.txt      \
  29         $(DOC_MODULE)-overrides.txt
  30
  31 DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \
  32            $(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp
  33
  34 SCANOBJ_FILES =                  \
  35         $(DOC_MODULE).args       \
  36         $(DOC_MODULE).hierarchy  \
  37         $(DOC_MODULE).interfaces \
  38         $(DOC_MODULE).prerequisites \
  39         $(DOC_MODULE).signals
  40
  41 REPORT_FILES = \
  42         $(DOC_MODULE)-undocumented.txt \
  43         $(DOC_MODULE)-undeclared.txt \
  44         $(DOC_MODULE)-unused.txt
  45
  46 CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS)
  47
  48 check-local: html-build.stamp
  49
  50 docs: html-build.stamp
  51
  52 #### scan ####
  53
  54 scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB)
  55         @echo 'gtk-doc: Scanning header files'
  56         @-chmod -R u+w $(srcdir)
  57         @PATH=$(top_builddir):$(PATH) PERL5LIB=$(top_builddir):$(PERL5LIB) && cd $(srcdir) && \
  58           gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES)
  59         if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null 2>&1 ; then \
  60             CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" $(top_builddir)/gtkdoc-scangobj --module=$(DOC_MODULE) --output-dir=$(srcdir) $(SCANGOBJ_OPTIONS); \
  61         else \
  62             cd $(srcdir) ; \
  63             for i in $(SCANOBJ_FILES) ; do \
  64                test -f $$i || touch $$i ; \
  65             done \
  66         fi
  67         touch scan-build.stamp
  68
  69 $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt: scan-build.stamp
  70         @true
  71
  72 #### templates ####
  73
  74 tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt
  75         @echo 'gtk-doc: Rebuilding template files'
  76         @-chmod -R u+w $(srcdir)
  77         @PATH=$(top_builddir):$(PATH) PERL5LIB=$(top_builddir):$(PERL5LIB) && cd $(srcdir) && \
  78         gtkdoc-mktmpl --module=$(DOC_MODULE) $(MKTMPL_OPTIONS)
  79         touch tmpl-build.stamp
  80
  81 tmpl.stamp: tmpl-build.stamp
  82         @true
  83
  84 tmpl/*.sgml:
  85         @true
  86
  87
  88 #### xml ####
  89
  90 sgml-build.stamp: tmpl.stamp $(HFILE_GLOB) $(CFILE_GLOB) $(DOC_MODULE)-sections.txt $(srcdir)/tmpl/*.sgml $(expand_content_files)
  91         @echo 'gtk-doc: Building XML'
  92         @-chmod -R u+w $(srcdir)
  93         @PATH=$(top_builddir):$(PATH) PERL5LIB=$(top_builddir):$(PERL5LIB) && cd $(srcdir) && \
  94         gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --output-format=xml --expand-content-files="$(expand_content_files)" --main-sgml-file=$(DOC_MAIN_SGML_FILE) $(MKDB_OPTIONS)
  95         touch sgml-build.stamp
  96
  97 sgml.stamp: sgml-build.stamp
  98         @true
  99
 100 #### html ####
 101
 102 html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
 103         @echo 'gtk-doc: Building HTML'
 104         @-chmod -R u+w $(srcdir)
 105         rm -rf $(srcdir)/html
 106         mkdir $(srcdir)/html
 107         @PATH=$(top_builddir):$(PATH) PERL5LIB=$(top_builddir):$(PERL5LIB) && cd $(srcdir)/html && \
 108         gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)  $(MKHTML_OPTIONS)
 109         test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html )
 110         @echo 'gtk-doc: Fixing cross-references'
 111         @PATH=$(top_builddir):$(PATH) PERL5LIB=$(top_builddir):$(PERL5LIB) && cd $(srcdir) && \
 112         gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
 113         touch html-build.stamp
 114
 115 ##############
 116
 117 # we need to enforce a rebuild for the tests
 118 clean-local:
 119         rm -f *~ *.bak
 120         rm -rf .libs
 121         cd $(srcdir) && \
 122           rm -rf xml $(REPORT_FILES) \
 123                  $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
 124
 125 distclean-local:
 126         cd $(srcdir) && \
 127           rm -rf xml $(REPORT_FILES) \
 128                  $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
 129
 130 maintainer-clean-local: clean
 131         cd $(srcdir) && rm -rf xml html
 132
 133 install-data-local:
 134         -installfiles=`echo $(srcdir)/html/*`; \
 135         if test "$$installfiles" = '$(srcdir)/html/*'; \
 136         then echo '-- Nothing to install' ; \
 137         else \
 138           $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR); \
 139           for i in $$installfiles; do \
 140             echo '-- Installing '$$i ; \
 141             $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
 142           done; \
 143           echo '-- Installing $(srcdir)/html/index.sgml' ; \
 144           $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR) || :; \
 145           which gtkdoc-rebase >/dev/null && \
 146             gtkdoc-rebase --relative --dest-dir=$(DESTDIR) --html-dir=$(DESTDIR)$(TARGET_DIR) ; \
 147         fi
 148
 149 uninstall-local:
 150         rm -f $(DESTDIR)$(TARGET_DIR)/*
 151
 152 #
 153 # Require gtk-doc when making dist
 154 #
 155 dist-check-gtkdoc:
 156
 157 dist-hook: dist-check-gtkdoc dist-hook-local
 158         mkdir $(distdir)/tmpl
 159         mkdir $(distdir)/xml
 160         mkdir $(distdir)/html
 161         -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
 162         -cp $(srcdir)/xml/*.xml $(distdir)/xml
 163         cp $(srcdir)/html/* $(distdir)/html
 164         -cp $(srcdir)/$(DOC_MODULE).types $(distdir)/
 165         -cp $(srcdir)/$(DOC_MODULE)-sections.txt $(distdir)/
 166         cd $(distdir) && rm -f $(DISTCLEANFILES)
 167         -gtkdoc-rebase --online --relative --html-dir=$(distdir)/html
 168
 169 .PHONY : dist-hook-local docs