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