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_CFLAGS) $(CFLAGS)
   9 GTKDOC_LD = $(LIBTOOL) --mode=link $(CC) $(AM_CFLAGS) $(CFLAGS) $(LDFLAGS)
  10 else
  11 GTKDOC_CC = $(CC) $(INCLUDES) $(AM_CFLAGS) $(CFLAGS)
  12 GTKDOC_LD = $(CC) $(AM_CFLAGS) $(CFLAGS) $(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 CLEANFILES = $(SCANOBJ_FILES) $(DOC_MODULE)-unused.txt $(DOC_STAMPS)
  42
  43 if ENABLE_GTK_DOC
  44 all-local: html-build.stamp
  45 else
  46 all-local:
  47 endif
  48
  49 docs: html-build.stamp
  50
  51 #### scan ####
  52
  53 scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB)
  54         @echo 'gtk-doc: Scanning header files'
  55         @-chmod -R u+w $(srcdir)
  56         if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null 2>&1 ; then \
  57             CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scangobj $(SCANGOBJ_OPTIONS) --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \
  58         else \
  59             cd $(srcdir) ; \
  60             for i in $(SCANOBJ_FILES) ; do \
  61                test -f $$i || touch $$i ; \
  62             done \
  63         fi
  64         cd $(srcdir) && \
  65           gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES)
  66         touch scan-build.stamp
  67
  68 $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp
  69         @true
  70
  71 #### templates ####
  72
  73 tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt
  74         @echo 'gtk-doc: Rebuilding template files'
  75         @-chmod -R u+w $(srcdir)
  76         cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) $(MKTMPL_OPTIONS)
  77         touch tmpl-build.stamp
  78
  79 tmpl.stamp: tmpl-build.stamp
  80         @true
  81
  82 #### xml ####
  83
  84 sgml-build.stamp: tmpl.stamp $(HFILE_GLOB) $(CFILE_GLOB) $(DOC_MODULE)-sections.txt $(srcdir)/tmpl/*.sgml $(expand_content_files)
  85         @echo 'gtk-doc: Building XML'
  86         @-chmod -R u+w $(srcdir)
  87         cd $(srcdir) && \
  88         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)
  89         touch sgml-build.stamp
  90
  91 sgml.stamp: sgml-build.stamp
  92         @true
  93
  94 #### html ####
  95
  96 html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
  97         @echo 'gtk-doc: Building HTML'
  98         @-chmod -R u+w $(srcdir)
  99         rm -rf $(srcdir)/html
 100         mkdir $(srcdir)/html
 101         cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
 102         test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html )
 103         @echo 'gtk-doc: Fixing cross-references'
 104         cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
 105         touch html-build.stamp
 106
 107 ##############
 108
 109 clean-local:
 110         rm -f *~ *.bak
 111         rm -rf .libs
 112
 113 maintainer-clean-local: clean
 114         cd $(srcdir) && rm -rf xml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
 115
 116 install-data-local:
 117         installfiles=`echo $(srcdir)/html/*`; \
 118         if test "$$installfiles" = '$(srcdir)/html/*'; \
 119         then echo '-- Nothing to install' ; \
 120         else \
 121           $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR); \
 122           for i in $$installfiles; do \
 123             echo '-- Installing '$$i ; \
 124             $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
 125           done; \
 126           echo '-- Installing $(srcdir)/html/index.sgml' ; \
 127           $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR) || :; \
 128         fi
 129
 130 uninstall-local:
 131         rm -f $(DESTDIR)$(TARGET_DIR)/*
 132
 133 #
 134 # Require gtk-doc when making dist
 135 #
 136 if ENABLE_GTK_DOC
 137 dist-check-gtkdoc:
 138 else
 139 dist-check-gtkdoc:
 140         @echo "*** gtk-doc must be installed and enabled in order to make dist"
 141         @false
 142 endif
 143
 144 dist-hook: dist-check-gtkdoc dist-hook-local
 145         mkdir $(distdir)/tmpl
 146         mkdir $(distdir)/xml
 147         mkdir $(distdir)/html
 148         -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
 149         -cp $(srcdir)/xml/*.xml $(distdir)/xml
 150         -cp $(srcdir)/html/* $(distdir)/html
 151         if test -f $(srcdir)/$(DOC_MODULE).types; then \
 152           cp $(srcdir)/$(DOC_MODULE).types $(distdir)/$(DOC_MODULE).types; \
 153         fi
 154
 155 .PHONY : dist-hook-local docs