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