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
 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: setup-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 #### xml ####
 140
 141 GTK_DOC_V_XML=$(GTK_DOC_V_XML_$(V))
 142 GTK_DOC_V_XML_=$(GTK_DOC_V_XML_$(AM_DEFAULT_VERBOSITY))
 143 GTK_DOC_V_XML_0=@echo "  DOC   Building XML";
 144
 145 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
 146         $(GTK_DOC_V_XML)_source_dir='' ; \
 147         for i in $(DOC_SOURCE_DIR) ; do \
 148             _source_dir="$${_source_dir} --source-dir=$$i" ; \
 149         done ; \
 150         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)
 151         $(AM_V_at)touch sgml-build.stamp
 152
 153 sgml.stamp: sgml-build.stamp
 154         @true
 155
 156 xml/gtkdocentities.ent: Makefile
 157         $(GTK_DOC_V_XML)$(MKDIR_P) $(@D) && ( \
 158                 echo "<!ENTITY package \"$(PACKAGE)\">"; \
 159                 echo "<!ENTITY package_bugreport \"$(PACKAGE_BUGREPORT)\">"; \
 160                 echo "<!ENTITY package_name \"$(PACKAGE_NAME)\">"; \
 161                 echo "<!ENTITY package_string \"$(PACKAGE_STRING)\">"; \
 162                 echo "<!ENTITY package_tarname \"$(PACKAGE_TARNAME)\">"; \
 163                 echo "<!ENTITY package_url \"$(PACKAGE_URL)\">"; \
 164                 echo "<!ENTITY package_version \"$(PACKAGE_VERSION)\">"; \
 165         ) > $@
 166
 167 #### html ####
 168
 169 GTK_DOC_V_HTML=$(GTK_DOC_V_HTML_$(V))
 170 GTK_DOC_V_HTML_=$(GTK_DOC_V_HTML_$(AM_DEFAULT_VERBOSITY))
 171 GTK_DOC_V_HTML_0=@echo "  DOC   Building HTML";
 172
 173 GTK_DOC_V_XREF=$(GTK_DOC_V_XREF_$(V))
 174 GTK_DOC_V_XREF_=$(GTK_DOC_V_XREF_$(AM_DEFAULT_VERBOSITY))
 175 GTK_DOC_V_XREF_0=@echo "  DOC   Fixing cross-references";
 176
 177 html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) $(expand_content_files)
 178         $(GTK_DOC_V_HTML)rm -rf html && mkdir html && \
 179         mkhtml_options=""; \
 180         gtkdoc-mkhtml 2>&1 --help | grep  >/dev/null "\-\-verbose"; \
 181         if test "$$?" = "0"; then \
 182           if test "x$(V)" = "x1"; then \
 183             mkhtml_options="$$mkhtml_options --verbose"; \
 184           fi; \
 185         fi; \
 186         gtkdoc-mkhtml 2>&1 --help | grep  >/dev/null "\-\-path"; \
 187         if test "$$?" = "0"; then \
 188           mkhtml_options="$$mkhtml_options --path=\"$(abs_srcdir)\""; \
 189         fi; \
 190         cd html && gtkdoc-mkhtml $$mkhtml_options $(MKHTML_OPTIONS) $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
 191         -@test "x$(HTML_IMAGES)" = "x" || \
 192         for file in $(HTML_IMAGES) ; do \
 193           if test -f $(abs_srcdir)/$$file ; then \
 194             cp $(abs_srcdir)/$$file $(abs_builddir)/html; \
 195           fi; \
 196           if test -f $(abs_builddir)/$$file ; then \
 197             cp $(abs_builddir)/$$file $(abs_builddir)/html; \
 198           fi; \
 199         done;
 200         $(GTK_DOC_V_XREF)gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
 201         $(AM_V_at)touch html-build.stamp
 202
 203 #### pdf ####
 204
 205 GTK_DOC_V_PDF=$(GTK_DOC_V_PDF_$(V))
 206 GTK_DOC_V_PDF_=$(GTK_DOC_V_PDF_$(AM_DEFAULT_VERBOSITY))
 207 GTK_DOC_V_PDF_0=@echo "  DOC   Building PDF";
 208
 209 pdf-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) $(expand_content_files)
 210         $(GTK_DOC_V_PDF)rm -f $(DOC_MODULE).pdf && \
 211         mkpdf_options=""; \
 212         gtkdoc-mkpdf 2>&1 --help | grep  >/dev/null "\-\-verbose"; \
 213         if test "$$?" = "0"; then \
 214           if test "x$(V)" = "x1"; then \
 215             mkpdf_options="$$mkpdf_options --verbose"; \
 216           fi; \
 217         fi; \
 218         if test "x$(HTML_IMAGES)" != "x"; then \
 219           for img in $(HTML_IMAGES); do \
 220             part=`dirname $$img`; \
 221             echo $$mkpdf_options | grep >/dev/null "\-\-imgdir=$$part "; \
 222             if test $$? != 0; then \
 223               mkpdf_options="$$mkpdf_options --imgdir=$$part"; \
 224             fi; \
 225           done; \
 226         fi; \
 227         gtkdoc-mkpdf --path="$(abs_srcdir)" $$mkpdf_options $(DOC_MODULE) $(DOC_MAIN_SGML_FILE) $(MKPDF_OPTIONS)
 228         $(AM_V_at)touch pdf-build.stamp
 229
 230 ##############
 231
 232 clean-local:
 233         @rm -f *~ *.bak
 234         @rm -rf .libs
 235         @if echo $(SCAN_OPTIONS) | grep -q "\-\-rebuild-types" ; then \
 236           rm -f $(DOC_MODULE).types; \
 237         fi
 238         @if echo $(SCAN_OPTIONS) | grep -q "\-\-rebuild-sections" ; then \
 239           rm -f $(DOC_MODULE)-sections.txt; \
 240         fi
 241
 242 distclean-local:
 243         @rm -rf xml html $(REPORT_FILES) $(DOC_MODULE).pdf \
 244             $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
 245         @if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
 246             rm -f $(SETUP_FILES) $(DOC_MODULE).types; \
 247         fi
 248
 249 maintainer-clean-local:
 250         @rm -rf xml html
 251
 252 install-data-local:
 253         @installfiles=`echo $(builddir)/html/*`; \
 254         if test "$$installfiles" = '$(builddir)/html/*'; \
 255         then echo 1>&2 'Nothing to install' ; \
 256         else \
 257           if test -n "$(DOC_MODULE_VERSION)"; then \
 258             installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
 259           else \
 260             installdir="$(DESTDIR)$(TARGET_DIR)"; \
 261           fi; \
 262           $(mkinstalldirs) $${installdir} ; \
 263           for i in $$installfiles; do \
 264             echo ' $(INSTALL_DATA) '$$i ; \
 265             $(INSTALL_DATA) $$i $${installdir}; \
 266           done; \
 267           if test -n "$(DOC_MODULE_VERSION)"; then \
 268             mv -f $${installdir}/$(DOC_MODULE).devhelp2 \
 269               $${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp2; \
 270           fi; \
 271           $(GTKDOC_REBASE) --relative --dest-dir=$(DESTDIR) --html-dir=$${installdir}; \
 272         fi
 273
 274 uninstall-local:
 275         @if test -n "$(DOC_MODULE_VERSION)"; then \
 276           installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
 277         else \
 278           installdir="$(DESTDIR)$(TARGET_DIR)"; \
 279         fi; \
 280         rm -rf $${installdir}
 281
 282 #
 283 # Require gtk-doc when making dist
 284 #
 285 if HAVE_GTK_DOC
 286 dist-check-gtkdoc: docs
 287 else
 288 dist-check-gtkdoc:
 289         @echo "*** gtk-doc is needed to run 'make dist'.         ***"
 290         @echo "*** gtk-doc was not found when 'configure' ran.   ***"
 291         @echo "*** please install gtk-doc and rerun 'configure'. ***"
 292         @false
 293 endif
 294
 295 dist-hook: dist-check-gtkdoc all-gtk-doc dist-hook-local
 296         @mkdir $(distdir)/html
 297         @cp ./html/* $(distdir)/html
 298         @-cp ./$(DOC_MODULE).pdf $(distdir)/
 299         @-cp ./$(DOC_MODULE).types $(distdir)/
 300         @-cp ./$(DOC_MODULE)-sections.txt $(distdir)/
 301         @cd $(distdir) && rm -f $(DISTCLEANFILES)
 302         @$(GTKDOC_REBASE) --online --relative --html-dir=$(distdir)/html
 303
 304 .PHONY : dist-hook-local docs