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) --tag=CC --mode=compile $(CC) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
   9 GTKDOC_LD = $(LIBTOOL) --tag=CC --mode=link $(CC) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS)
  10 GTKDOC_RUN = $(LIBTOOL) --mode=execute
  11 else
  12 GTKDOC_CC = $(CC) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
  13 GTKDOC_LD = $(CC) $(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 TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
  25
  26 EXTRA_DIST =                            \
  27         $(content_files)                \
  28         $(HTML_IMAGES)                  \
  29         $(DOC_MAIN_SGML_FILE)           \
  30         $(DOC_MODULE)-sections.txt      \
  31         $(DOC_MODULE)-overrides.txt
  32
  33 DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \
  34         pdf-build.stamp \
  35         $(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp \
  36         $(srcdir)/pdf.stamp
  37
  38 SCANOBJ_FILES =                  \
  39         $(DOC_MODULE).args       \
  40         $(DOC_MODULE).hierarchy  \
  41         $(DOC_MODULE).interfaces \
  42         $(DOC_MODULE).prerequisites \
  43         $(DOC_MODULE).signals
  44
  45 REPORT_FILES = \
  46         $(DOC_MODULE)-undocumented.txt \
  47         $(DOC_MODULE)-undeclared.txt \
  48         $(DOC_MODULE)-unused.txt
  49
  50 CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS)
  51
  52 if ENABLE_GTK_DOC
  53 if GTK_DOC_BUILD_HTML
  54 HTML_BUILD_STAMP=html-build.stamp
  55 else
  56 HTML_BUILD_STAMP=
  57 endif
  58 if GTK_DOC_BUILD_PDF
  59 PDF_BUILD_STAMP=pdf-build.stamp
  60 else
  61 PDF_BUILD_STAMP=
  62 endif
  63
  64 all-local: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP)
  65 else
  66 all-local:
  67 endif
  68
  69 docs: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP)
  70
  71 $(REPORT_FILES): sgml-build.stamp
  72
  73 #### scan ####
  74
  75 scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB)
  76         @echo 'gtk-doc: Scanning header files'
  77         @-chmod -R u+w $(srcdir)
  78         @cd $(srcdir) && \
  79           gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES)
  80         @if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null 2>&1 ; then \
  81             CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" RUN="$(GTKDOC_RUN)" CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS)" LDFLAGS="$(GTKDOC_LIBS) $(LDFLAGS)" gtkdoc-scangobj $(SCANGOBJ_OPTIONS) --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \
  82         else \
  83             cd $(srcdir) ; \
  84             for i in $(SCANOBJ_FILES) ; do \
  85                test -f $$i || touch $$i ; \
  86             done \
  87         fi
  88         @touch scan-build.stamp
  89
  90 $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt: scan-build.stamp
  91         @true
  92
  93 #### templates ####
  94
  95 tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt
  96         @echo 'gtk-doc: Rebuilding template files'
  97         @-chmod -R u+w $(srcdir)
  98         @cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) $(MKTMPL_OPTIONS)
  99         @touch tmpl-build.stamp
 100
 101 tmpl.stamp: tmpl-build.stamp
 102         @true
 103
 104 $(srcdir)/tmpl/*.sgml:
 105         @true
 106
 107 #### xml ####
 108
 109 sgml-build.stamp: tmpl.stamp $(DOC_MODULE)-sections.txt $(srcdir)/tmpl/*.sgml $(expand_content_files)
 110         @echo 'gtk-doc: Building XML'
 111         @-chmod -R u+w $(srcdir)
 112         @cd $(srcdir) && \
 113         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)
 114         @cp version.entities $(srcdir)/xml/
 115         @touch sgml-build.stamp
 116
 117 sgml.stamp: sgml-build.stamp
 118         @true
 119
 120 #### html ####
 121
 122 html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
 123         @echo 'gtk-doc: Building HTML'
 124         @-chmod -R u+w $(srcdir)
 125         @rm -rf $(srcdir)/html
 126         @mkdir $(srcdir)/html
 127         @mkhtml_options=""; \
 128         gtkdoc-mkhtml 2>&1 --help | grep  >/dev/null "\-\-path"; \
 129         if test "$(?)" = "0"; then \
 130           mkhtml_options=--path="$(srcdir)"; \
 131         fi; \
 132         cd $(srcdir)/html && gtkdoc-mkhtml $$mkhtml_options $(MKHTML_OPTIONS) $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
 133         @test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html )
 134         @echo 'gtk-doc: Fixing cross-references'
 135         @cd $(srcdir) && gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
 136         @touch html-build.stamp
 137
 138 #### pdf ####
 139
 140 pdf-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
 141         @echo 'gtk-doc: Building PDF'
 142         @-chmod -R u+w $(srcdir)
 143         @rm -rf $(srcdir)/$(DOC_MODULE).pdf
 144         @mkpdf_imgdirs=""; \
 145         if test "x$(HTML_IMAGES)" != "x"; then \
 146           for img in $(HTML_IMAGES); do \
 147             part=`dirname $$img`; \
 148             echo $$mkpdf_imgdirs | grep >/dev/null "\-\-imgdir=$$part "; \
 149             if test $$? != 0; then \
 150               mkpdf_imgdirs="$$mkpdf_imgdirs --imgdir=$$part"; \
 151             fi; \
 152           done; \
 153         fi; \
 154         cd $(srcdir) && gtkdoc-mkpdf --path="$(abs_srcdir)" $$mkpdf_imgdirs $(DOC_MODULE) $(DOC_MAIN_SGML_FILE) $(MKPDF_OPTIONS)
 155         @touch pdf-build.stamp
 156
 157 ##############
 158
 159 clean-local:
 160         rm -f *~ *.bak
 161         rm -rf .libs
 162
 163 distclean-local:
 164         cd $(srcdir) && \
 165           rm -rf xml $(REPORT_FILES) $(DOC_MODULE).pdf \
 166                  $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
 167
 168 maintainer-clean-local: clean
 169         cd $(srcdir) && rm -rf xml html
 170
 171 install-data-local:
 172         @installfiles=`echo $(srcdir)/html/*`; \
 173         if test "$$installfiles" = '$(srcdir)/html/*'; \
 174         then echo '-- Nothing to install' ; \
 175         else \
 176           if test -n "$(DOC_MODULE_VERSION)"; then \
 177             installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
 178           else \
 179             installdir="$(DESTDIR)$(TARGET_DIR)"; \
 180           fi; \
 181           $(mkinstalldirs) $${installdir} ; \
 182           for i in $$installfiles; do \
 183             echo '-- Installing '$$i ; \
 184             $(INSTALL_DATA) $$i $${installdir}; \
 185           done; \
 186           if test -n "$(DOC_MODULE_VERSION)"; then \
 187             mv -f $${installdir}/$(DOC_MODULE).devhelp2 \
 188               $${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp2; \
 189             mv -f $${installdir}/$(DOC_MODULE).devhelp \
 190               $${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp; \
 191           fi; \
 192           $(GTKDOC_REBASE) --relative --dest-dir=$(DESTDIR) --html-dir=$${installdir}; \
 193         fi
 194
 195 uninstall-local:
 196         @if test -n "$(DOC_MODULE_VERSION)"; then \
 197           installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
 198         else \
 199           installdir="$(DESTDIR)$(TARGET_DIR)"; \
 200         fi; \
 201         rm -rf $${installdir}
 202
 203 #
 204 # Require gtk-doc when making dist
 205 #
 206 if ENABLE_GTK_DOC
 207 dist-check-gtkdoc:
 208 else
 209 dist-check-gtkdoc:
 210         @echo "*** gtk-doc must be installed and enabled in order to make dist"
 211         @false
 212 endif
 213
 214 dist-hook: dist-check-gtkdoc dist-hook-local
 215         mkdir $(distdir)/tmpl
 216         mkdir $(distdir)/html
 217         -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
 218         cp $(srcdir)/html/* $(distdir)/html
 219         -cp $(srcdir)/$(DOC_MODULE).pdf $(distdir)/
 220         -cp $(srcdir)/$(DOC_MODULE).types $(distdir)/
 221         -cp $(srcdir)/$(DOC_MODULE)-sections.txt $(distdir)/
 222         cd $(distdir) && rm -f $(DISTCLEANFILES)
 223         $(GTKDOC_REBASE) --online --relative --html-dir=$(distdir)/html
 224
 225 .PHONY : dist-hook-local docs