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
  32 EXTRA_DIST =                            \
  33         $(HTML_IMAGES)                  \
  34         $(SETUP_FILES)
  35
  36 DOC_STAMPS=setup-build.stamp scan-build.stamp tmpl-build.stamp sgml-build.stamp \
  37         html-build.stamp pdf-build.stamp \
  38         tmpl.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 gtkdoc-check.test: Makefile
  53         $(AM_V_GEN)echo "#!/bin/sh -e" > $@; \
  54                 echo "$(GTKDOC_CHECK_PATH) || exit 1" >> $@; \
  55                 chmod +x $@
  56
  57 CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS) gtkdoc-check.test
  58
  59 if ENABLE_GTK_DOC
  60 if GTK_DOC_BUILD_HTML
  61 HTML_BUILD_STAMP=html-build.stamp
  62 else
  63 HTML_BUILD_STAMP=
  64 endif
  65 if GTK_DOC_BUILD_PDF
  66 PDF_BUILD_STAMP=pdf-build.stamp
  67 else
  68 PDF_BUILD_STAMP=
  69 endif
  70
  71 all-local: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP)
  72 else
  73 all-local:
  74 endif
  75
  76 docs: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP)
  77
  78 $(REPORT_FILES): sgml-build.stamp
  79
  80 #### setup ####
  81
  82 GTK_DOC_V_SETUP=$(GTK_DOC_V_SETUP_$(V))
  83 GTK_DOC_V_SETUP_=$(GTK_DOC_V_SETUP_$(AM_DEFAULT_VERBOSITY))
  84 GTK_DOC_V_SETUP_0=@echo "  DOC   Preparing build";
  85
  86 setup-build.stamp:
  87         -$(GTK_DOC_V_SETUP)if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
  88             files=`echo $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types`; \
  89             if test "x$$files" != "x" ; then \
  90                 for file in $$files ; do \
  91                     destdir=`dirname $(abs_builddir)/$$file` ;\
  92                     test -d "$$destdir" || mkdir -p "$$destdir"; \
  93                     test -f $(abs_srcdir)/$$file && \
  94                         cp -pu $(abs_srcdir)/$$file $(abs_builddir)/$$file || true; \
  95                 done; \
  96             fi; \
  97             test -d $(abs_srcdir)/tmpl && \
  98                 { cp -rp $(abs_srcdir)/tmpl $(abs_builddir)/; \
  99                 chmod -R u+w $(abs_builddir)/tmpl; } \
 100         fi
 101         $(AM_V_at)touch setup-build.stamp
 102
 103 #### scan ####
 104
 105 GTK_DOC_V_SCAN=$(GTK_DOC_V_SCAN_$(V))
 106 GTK_DOC_V_SCAN_=$(GTK_DOC_V_SCAN_$(AM_DEFAULT_VERBOSITY))
 107 GTK_DOC_V_SCAN_0=@echo "  DOC   Scanning header files";
 108
 109 GTK_DOC_V_INTROSPECT=$(GTK_DOC_V_INTROSPECT_$(V))
 110 GTK_DOC_V_INTROSPECT_=$(GTK_DOC_V_INTROSPECT_$(AM_DEFAULT_VERBOSITY))
 111 GTK_DOC_V_INTROSPECT_0=@echo "  DOC   Introspecting gobjects";
 112
 113 scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB)
 114         $(GTK_DOC_V_SCAN)_source_dir='' ; \
 115         for i in $(DOC_SOURCE_DIR) ; do \
 116             _source_dir="$${_source_dir} --source-dir=$$i" ; \
 117         done ; \
 118         gtkdoc-scan --module=$(DOC_MODULE) --ignore-headers="$(IGNORE_HFILES)" $${_source_dir} $(SCAN_OPTIONS) $(EXTRA_HFILES)
 119         $(GTK_DOC_V_INTROSPECT)if grep -l '^..*$$' $(DOC_MODULE).types > /dev/null 2>&1 ; then \
 120             scanobj_options=""; \
 121             gtkdoc-scangobj 2>&1 --help | grep  >/dev/null "\-\-verbose"; \
 122             if test "$(?)" = "0"; then \
 123                 if test "x$(V)" = "x1"; then \
 124                     scanobj_options="--verbose"; \
 125                 fi; \
 126             fi; \
 127             CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" RUN="$(GTKDOC_RUN)" CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS)" LDFLAGS="$(GTKDOC_LIBS) $(LDFLAGS)" \
 128             gtkdoc-scangobj $(SCANGOBJ_OPTIONS) $$scanobj_options --module=$(DOC_MODULE); \
 129         else \
 130             for i in $(SCANOBJ_FILES) ; do \
 131                 test -f $$i || touch $$i ; \
 132             done \
 133         fi
 134         $(AM_V_at)touch scan-build.stamp
 135
 136 $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt: scan-build.stamp
 137         @true
 138
 139 #### templates ####
 140
 141 GTK_DOC_V_TMPL=$(GTK_DOC_V_TMPL_$(V))
 142 GTK_DOC_V_TMPL_=$(GTK_DOC_V_TMPL_$(AM_DEFAULT_VERBOSITY))
 143 GTK_DOC_V_TMPL_0=@echo "  DOC   Rebuilding template files";
 144
 145 tmpl-build.stamp: setup-build.stamp $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt
 146         $(GTK_DOC_V_TMPL)gtkdoc-mktmpl --module=$(DOC_MODULE) $(MKTMPL_OPTIONS)
 147         $(AM_V_at)if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
 148           if test -w $(abs_srcdir) ; then \
 149             cp -rp $(abs_builddir)/tmpl $(abs_srcdir)/; \
 150           fi \
 151         fi
 152         $(AM_V_at)touch tmpl-build.stamp
 153
 154 tmpl.stamp: tmpl-build.stamp
 155         @true
 156
 157 $(srcdir)/tmpl/*.sgml:
 158         @true
 159
 160 #### xml ####
 161
 162 GTK_DOC_V_XML=$(GTK_DOC_V_XML_$(V))
 163 GTK_DOC_V_XML_=$(GTK_DOC_V_XML_$(AM_DEFAULT_VERBOSITY))
 164 GTK_DOC_V_XML_0=@echo "  DOC   Building XML";
 165
 166 sgml-build.stamp: tmpl.stamp $(DOC_MODULE)-sections.txt $(srcdir)/tmpl/*.sgml $(expand_content_files)
 167         -$(GTK_DOC_V_XML)chmod -R u+w $(srcdir) && _source_dir='' ; \
 168         for i in $(DOC_SOURCE_DIR) ; do \
 169             _source_dir="$${_source_dir} --source-dir=$$i" ; \
 170         done ; \
 171         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)
 172         $(AM_V_at)touch sgml-build.stamp
 173
 174 sgml.stamp: sgml-build.stamp
 175         @true
 176
 177 #### html ####
 178
 179 GTK_DOC_V_HTML=$(GTK_DOC_V_HTML_$(V))
 180 GTK_DOC_V_HTML_=$(GTK_DOC_V_HTML_$(AM_DEFAULT_VERBOSITY))
 181 GTK_DOC_V_HTML_0=@echo "  DOC   Building HTML";
 182
 183 GTK_DOC_V_XREF=$(GTK_DOC_V_XREF_$(V))
 184 GTK_DOC_V_XREF_=$(GTK_DOC_V_XREF_$(AM_DEFAULT_VERBOSITY))
 185 GTK_DOC_V_XREF_0=@echo "  DOC   Fixing cross-references";
 186
 187 html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
 188         $(GTK_DOC_V_HTML)rm -rf html && mkdir html && \
 189         mkhtml_options=""; \
 190         gtkdoc-mkhtml 2>&1 --help | grep  >/dev/null "\-\-verbose"; \
 191         if test "$(?)" = "0"; then \
 192           if test "x$(V)" = "x1"; then \
 193             mkhtml_options="$$mkhtml_options --verbose"; \
 194           fi; \
 195         fi; \
 196         gtkdoc-mkhtml 2>&1 --help | grep  >/dev/null "\-\-path"; \
 197         if test "$(?)" = "0"; then \
 198           mkhtml_options="$$mkhtml_options --path=\"$(abs_srcdir)\""; \
 199         fi; \
 200         cd html && gtkdoc-mkhtml $$mkhtml_options $(MKHTML_OPTIONS) $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
 201         -@test "x$(HTML_IMAGES)" = "x" || \
 202         for file in $(HTML_IMAGES) ; do \
 203           if test -f $(abs_srcdir)/$$file ; then \
 204             cp $(abs_srcdir)/$$file $(abs_builddir)/html; \
 205           fi; \
 206           if test -f $(abs_builddir)/$$file ; then \
 207             cp $(abs_builddir)/$$file $(abs_builddir)/html; \
 208           fi; \
 209         done;
 210         $(GTK_DOC_V_XREF)gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
 211         $(AM_V_at)touch html-build.stamp
 212
 213 #### pdf ####
 214
 215 GTK_DOC_V_PDF=$(GTK_DOC_V_PDF_$(V))
 216 GTK_DOC_V_PDF_=$(GTK_DOC_V_PDF_$(AM_DEFAULT_VERBOSITY))
 217 GTK_DOC_V_PDF_0=@echo "  DOC   Building PDF";
 218
 219 pdf-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
 220         $(GTK_DOC_V_PDF)rm -f $(DOC_MODULE).pdf && \
 221         mkpdf_options=""; \
 222         gtkdoc-mkpdf 2>&1 --help | grep  >/dev/null "\-\-verbose"; \
 223         if test "$(?)" = "0"; then \
 224           if test "x$(V)" = "x1"; then \
 225             mkpdf_options="$$mkpdf_options --verbose"; \
 226           fi; \
 227         fi; \
 228         if test "x$(HTML_IMAGES)" != "x"; then \
 229           for img in $(HTML_IMAGES); do \
 230             part=`dirname $$img`; \
 231             echo $$mkpdf_options | grep >/dev/null "\-\-imgdir=$$part "; \
 232             if test $$? != 0; then \
 233               mkpdf_options="$$mkpdf_options --imgdir=$$part"; \
 234             fi; \
 235           done; \
 236         fi; \
 237         gtkdoc-mkpdf --path="$(abs_srcdir)" $$mkpdf_options $(DOC_MODULE) $(DOC_MAIN_SGML_FILE) $(MKPDF_OPTIONS)
 238         $(AM_V_at)touch pdf-build.stamp
 239
 240 ##############
 241
 242 clean-local:
 243         @rm -f *~ *.bak
 244         @rm -rf .libs
 245
 246 distclean-local:
 247         @rm -rf xml html $(REPORT_FILES) $(DOC_MODULE).pdf \
 248             $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
 249         @if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
 250             rm -f $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types; \
 251             rm -rf tmpl; \
 252         fi
 253
 254 maintainer-clean-local:
 255         @rm -rf xml html
 256
 257 install-data-local:
 258         @installfiles=`echo $(builddir)/html/*`; \
 259         if test "$$installfiles" = '$(builddir)/html/*'; \
 260         then echo 1>&2 'Nothing to install' ; \
 261         else \
 262           if test -n "$(DOC_MODULE_VERSION)"; then \
 263             installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
 264           else \
 265             installdir="$(DESTDIR)$(TARGET_DIR)"; \
 266           fi; \
 267           $(mkinstalldirs) $${installdir} ; \
 268           for i in $$installfiles; do \
 269             echo ' $(INSTALL_DATA) '$$i ; \
 270             $(INSTALL_DATA) $$i $${installdir}; \
 271           done; \
 272           if test -n "$(DOC_MODULE_VERSION)"; then \
 273             mv -f $${installdir}/$(DOC_MODULE).devhelp2 \
 274               $${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp2; \
 275           fi; \
 276           $(GTKDOC_REBASE) --relative --dest-dir=$(DESTDIR) --html-dir=$${installdir}; \
 277         fi
 278
 279 uninstall-local:
 280         @if test -n "$(DOC_MODULE_VERSION)"; then \
 281           installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
 282         else \
 283           installdir="$(DESTDIR)$(TARGET_DIR)"; \
 284         fi; \
 285         rm -rf $${installdir}
 286
 287 #
 288 # Require gtk-doc when making dist
 289 #
 290 if ENABLE_GTK_DOC
 291 dist-check-gtkdoc: docs
 292 else
 293 dist-check-gtkdoc:
 294         @echo "*** gtk-doc must be installed and enabled in order to make dist"
 295         @false
 296 endif
 297
 298 dist-hook: dist-check-gtkdoc dist-hook-local
 299         @mkdir $(distdir)/tmpl
 300         @mkdir $(distdir)/html
 301         @-cp ./tmpl/*.sgml $(distdir)/tmpl
 302         @cp ./html/* $(distdir)/html
 303         @-cp ./$(DOC_MODULE).pdf $(distdir)/
 304         @-cp ./$(DOC_MODULE).types $(distdir)/
 305         @-cp ./$(DOC_MODULE)-sections.txt $(distdir)/
 306         @cd $(distdir) && rm -f $(DISTCLEANFILES)
 307         @$(GTKDOC_REBASE) --online --relative --html-dir=$(distdir)/html
 308
 309 .PHONY : dist-hook-local docs