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