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