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