gtk-doc.notmpl.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 sgml-build.stamp \
  36         html-build.stamp pdf-build.stamp \
  37         setup.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         fi
  87         @touch setup-build.stamp
  88
  89
  90 setup.stamp: setup-build.stamp
  91         @true
  92
  93
  94 #### scan ####
  95
  96 scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB)
  97         @echo 'gtk-doc: Scanning header files'
  98         @_source_dir='' ; \
  99         for i in $(DOC_SOURCE_DIR) ; do \
 100             _source_dir="$${_source_dir} --source-dir=$$i" ; \
 101         done ; \
 102         gtkdoc-scan --module=$(DOC_MODULE) --ignore-headers="$(IGNORE_HFILES)" $${_source_dir} $(SCAN_OPTIONS) $(EXTRA_HFILES)
 103         @if grep -l '^..*$$' $(DOC_MODULE).types > /dev/null 2>&1 ; then \
 104             CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" RUN="$(GTKDOC_RUN)" CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS)" LDFLAGS="$(GTKDOC_LIBS) $(LDFLAGS)" gtkdoc-scangobj $(SCANGOBJ_OPTIONS) --module=$(DOC_MODULE) ; \
 105         else \
 106             for i in $(SCANOBJ_FILES) ; do \
 107                  test -f $$i || touch $$i ; \
 108             done \
 109         fi
 110         @touch scan-build.stamp
 111
 112 $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt: scan-build.stamp
 113         @true
 114
 115 #### xml ####
 116
 117 sgml-build.stamp: setup.stamp $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt $(expand_content_files)
 118         @echo 'gtk-doc: Building XML'
 119         @_source_dir='' ; \
 120         for i in $(DOC_SOURCE_DIR) ; do \
 121             _source_dir="$${_source_dir} --source-dir=$$i" ; \
 122         done ; \
 123         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)
 124         @touch sgml-build.stamp
 125
 126 sgml.stamp: sgml-build.stamp
 127         @true
 128
 129 #### html ####
 130
 131 html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
 132         @echo 'gtk-doc: Building HTML'
 133         @rm -rf html
 134         @mkdir html
 135         @mkhtml_options=""; \
 136         gtkdoc-mkhtml 2>&1 --help | grep  >/dev/null "\-\-path"; \
 137         if test "$(?)" = "0"; then \
 138           mkhtml_options=--path="$(abs_srcdir)"; \
 139         fi; \
 140         cd html && gtkdoc-mkhtml $$mkhtml_options $(MKHTML_OPTIONS) $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
 141         -@test "x$(HTML_IMAGES)" = "x" || \
 142         for file in $(HTML_IMAGES) ; do \
 143           if test -f $(abs_srcdir)/$$file ; then \
 144             cp $(abs_srcdir)/$$file $(abs_builddir)/html; \
 145           fi; \
 146           if test -f $(abs_builddir)/$$file ; then \
 147             cp $(abs_builddir)/$$file $(abs_builddir)/html; \
 148           fi; \
 149         done;
 150         @echo 'gtk-doc: Fixing cross-references'
 151         @gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
 152         @touch html-build.stamp
 153
 154 #### pdf ####
 155
 156 pdf-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
 157         @echo 'gtk-doc: Building PDF'
 158         @rm -rf $(DOC_MODULE).pdf
 159         @mkpdf_imgdirs=""; \
 160         if test "x$(HTML_IMAGES)" != "x"; then \
 161           for img in $(HTML_IMAGES); do \
 162             part=`dirname $$img`; \
 163             echo $$mkpdf_imgdirs | grep >/dev/null "\-\-imgdir=$$part "; \
 164             if test $$? != 0; then \
 165               mkpdf_imgdirs="$$mkpdf_imgdirs --imgdir=$$part"; \
 166             fi; \
 167           done; \
 168         fi; \
 169         gtkdoc-mkpdf --path="$(abs_srcdir)" $$mkpdf_imgdirs $(DOC_MODULE) $(DOC_MAIN_SGML_FILE) $(MKPDF_OPTIONS)
 170         @touch pdf-build.stamp
 171
 172 ##############
 173
 174 clean-local:
 175         rm -f *~ *.bak
 176         rm -rf .libs
 177
 178 distclean-local:
 179         rm -rf xml html $(REPORT_FILES) $(DOC_MODULE).pdf \
 180             $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
 181         if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
 182             rm -f $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types; \
 183         fi
 184
 185 maintainer-clean-local: clean
 186         rm -rf xml html
 187
 188 install-data-local:
 189         @installfiles=`echo $(builddir)/html/*`; \
 190         if test "$$installfiles" = '$(srcdir)/html/*'; \
 191         then echo '-- Nothing to install' ; \
 192         else \
 193           if test -n "$(DOC_MODULE_VERSION)"; then \
 194             installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
 195           else \
 196             installdir="$(DESTDIR)$(TARGET_DIR)"; \
 197           fi; \
 198           $(mkinstalldirs) $${installdir} ; \
 199           for i in $$installfiles; do \
 200             echo '-- Installing '$$i ; \
 201             $(INSTALL_DATA) $$i $${installdir}; \
 202           done; \
 203           if test -n "$(DOC_MODULE_VERSION)"; then \
 204             mv -f $${installdir}/$(DOC_MODULE).devhelp2 \
 205               $${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp2; \
 206             mv -f $${installdir}/$(DOC_MODULE).devhelp \
 207               $${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp; \
 208           fi; \
 209           $(GTKDOC_REBASE) --relative --dest-dir=$(DESTDIR) --html-dir=$${installdir}; \
 210         fi
 211
 212 uninstall-local:
 213         @if test -n "$(DOC_MODULE_VERSION)"; then \
 214           installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
 215         else \
 216           installdir="$(DESTDIR)$(TARGET_DIR)"; \
 217         fi; \
 218         rm -rf $${installdir}
 219
 220 #
 221 # Require gtk-doc when making dist
 222 #
 223 if ENABLE_GTK_DOC
 224 dist-check-gtkdoc:
 225 else
 226 dist-check-gtkdoc:
 227         @echo "*** gtk-doc must be installed and enabled in order to make dist"
 228         @false
 229 endif
 230
 231 dist-hook: dist-check-gtkdoc dist-hook-local
 232         mkdir $(distdir)/html
 233         cp $(builddir)/html/* $(distdir)/html
 234         -cp $(builddir)/$(DOC_MODULE).pdf $(distdir)/
 235         -cp $(builddir)/$(DOC_MODULE).types $(distdir)/
 236         -cp $(builddir)/$(DOC_MODULE)-sections.txt $(distdir)/
 237         cd $(distdir) && rm -f $(DISTCLEANFILES)
 238         $(GTKDOC_REBASE) --online --relative --html-dir=$(distdir)/html
 239
 240 .PHONY : dist-hook-local docs