Blame build/gtk-doc.make

Packit Service 3749ba
# -*- mode: makefile -*-
Packit Service 3749ba
Packit Service 3749ba
####################################
Packit Service 3749ba
# Everything below here is generic #
Packit Service 3749ba
####################################
Packit Service 3749ba
Packit Service 3749ba
if GTK_DOC_USE_LIBTOOL
Packit Service 3749ba
GTKDOC_CC = $(LIBTOOL) --tag=CC --mode=compile $(CC) $(INCLUDES) $(GTKDOC_DEPS_CFLAGS) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
Packit Service 3749ba
GTKDOC_LD = $(LIBTOOL) --tag=CC --mode=link $(CC) $(GTKDOC_DEPS_LIBS) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS)
Packit Service 3749ba
GTKDOC_RUN = $(LIBTOOL) --mode=execute
Packit Service 3749ba
else
Packit Service 3749ba
GTKDOC_CC = $(CC) $(INCLUDES) $(GTKDOC_DEPS_CFLAGS) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
Packit Service 3749ba
GTKDOC_LD = $(CC) $(GTKDOC_DEPS_LIBS) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS)
Packit Service 3749ba
GTKDOC_RUN =
Packit Service 3749ba
endif
Packit Service 3749ba
Packit Service 3749ba
# We set GPATH here; this gives us semantics for GNU make
Packit Service 3749ba
# which are more like other make's VPATH, when it comes to
Packit Service 3749ba
# whether a source that is a target of one rule is then
Packit Service 3749ba
# searched for in VPATH/GPATH.
Packit Service 3749ba
#
Packit Service 3749ba
GPATH = $(srcdir)
Packit Service 3749ba
Packit Service 3749ba
TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
Packit Service 3749ba
Packit Service 3749ba
SETUP_FILES = \
Packit Service 3749ba
	$(content_files)		\
Packit Service 3749ba
	$(DOC_MAIN_SGML_FILE)		\
Packit Service 3749ba
	$(DOC_MODULE)-sections.txt	\
Packit Service 3749ba
	$(DOC_MODULE)-overrides.txt	\
Packit Service 3749ba
	style.css
Packit Service 3749ba
Packit Service 3749ba
EXTRA_DIST = 				\
Packit Service 3749ba
	$(HTML_IMAGES)			\
Packit Service 3749ba
	$(SETUP_FILES)
Packit Service 3749ba
Packit Service 3749ba
DOC_STAMPS=setup-build.stamp scan-build.stamp sgml-build.stamp \
Packit Service 3749ba
	html-build.stamp pdf-build.stamp \
Packit Service 3749ba
	sgml.stamp html.stamp pdf.stamp
Packit Service 3749ba
Packit Service 3749ba
SCANOBJ_FILES = 		 \
Packit Service 3749ba
	$(DOC_MODULE).args 	 \
Packit Service 3749ba
	$(DOC_MODULE).hierarchy  \
Packit Service 3749ba
	$(DOC_MODULE).interfaces \
Packit Service 3749ba
	$(DOC_MODULE).prerequisites \
Packit Service 3749ba
	$(DOC_MODULE).signals
Packit Service 3749ba
Packit Service 3749ba
REPORT_FILES = \
Packit Service 3749ba
	$(DOC_MODULE)-undocumented.txt \
Packit Service 3749ba
	$(DOC_MODULE)-undeclared.txt \
Packit Service 3749ba
	$(DOC_MODULE)-unused.txt
Packit Service 3749ba
Packit Service 3749ba
CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS)
Packit Service 3749ba
Packit Service 3749ba
if ENABLE_GTK_DOC
Packit Service 3749ba
if GTK_DOC_BUILD_HTML
Packit Service 3749ba
HTML_BUILD_STAMP=html-build.stamp
Packit Service 3749ba
else
Packit Service 3749ba
HTML_BUILD_STAMP=
Packit Service 3749ba
endif
Packit Service 3749ba
if GTK_DOC_BUILD_PDF
Packit Service 3749ba
PDF_BUILD_STAMP=pdf-build.stamp
Packit Service 3749ba
else
Packit Service 3749ba
PDF_BUILD_STAMP=
Packit Service 3749ba
endif
Packit Service 3749ba
Packit Service 3749ba
all-local: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP)
Packit Service 3749ba
else
Packit Service 3749ba
all-local:
Packit Service 3749ba
endif
Packit Service 3749ba
Packit Service 3749ba
docs: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP)
Packit Service 3749ba
Packit Service 3749ba
$(REPORT_FILES): sgml-build.stamp
Packit Service 3749ba
Packit Service 3749ba
#### setup ####
Packit Service 3749ba
Packit Service 3749ba
setup-build.stamp:
Packit Service 3749ba
	-@if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
Packit Service 3749ba
	    echo '  DOC   Preparing build'; \
Packit Service 3749ba
	    files=`echo $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types`; \
Packit Service 3749ba
	    if test "x$$files" != "x" ; then \
Packit Service 3749ba
	        for file in $$files ; do \
Packit Service 3749ba
	            test -f $(abs_srcdir)/$$file && \
Packit Service 3749ba
	                cp -pu $(abs_srcdir)/$$file $(abs_builddir)/ || true; \
Packit Service 3749ba
	        done; \
Packit Service 3749ba
	    fi; \
Packit Service 3749ba
	fi
Packit Service 3749ba
	@touch setup-build.stamp
Packit Service 3749ba
Packit Service 3749ba
Packit Service 3749ba
#### scan ####
Packit Service 3749ba
Packit Service 3749ba
scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB)
Packit Service 3749ba
	@echo '  DOC   Scanning header files'
Packit Service 3749ba
	@_source_dir='' ; \
Packit Service 3749ba
	for i in $(DOC_SOURCE_DIR) ; do \
Packit Service 3749ba
	    _source_dir="$${_source_dir} --source-dir=$$i" ; \
Packit Service 3749ba
	done ; \
Packit Service 3749ba
	gtkdoc-scan --module=$(DOC_MODULE) --ignore-headers="$(IGNORE_HFILES)" $${_source_dir} $(SCAN_OPTIONS) $(EXTRA_HFILES)
Packit Service 3749ba
	@if grep -l '^..*$$' $(DOC_MODULE).types > /dev/null 2>&1 ; then \
Packit Service 3749ba
	    echo "  DOC   Introspecting gobjects"; \
Packit Service 3749ba
	    scanobj_options=""; \
Packit Service 3749ba
	    gtkdoc-scangobj 2>&1 --help | grep  >/dev/null "\-\-verbose"; \
Packit Service 3749ba
	    if test "$(?)" = "0"; then \
Packit Service 3749ba
	        if test "x$(V)" = "x1"; then \
Packit Service 3749ba
	            scanobj_options="--verbose"; \
Packit Service 3749ba
	        fi; \
Packit Service 3749ba
	    fi; \
Packit Service 3749ba
	    CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" RUN="$(GTKDOC_RUN)" CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS)" LDFLAGS="$(GTKDOC_LIBS) $(LDFLAGS)" \
Packit Service 3749ba
	    gtkdoc-scangobj $(SCANGOBJ_OPTIONS) $$scanobj_options --module=$(DOC_MODULE); \
Packit Service 3749ba
	else \
Packit Service 3749ba
	    for i in $(SCANOBJ_FILES) ; do \
Packit Service 3749ba
	        test -f $$i || touch $$i ; \
Packit Service 3749ba
	    done \
Packit Service 3749ba
	fi
Packit Service 3749ba
	@touch scan-build.stamp
Packit Service 3749ba
Packit Service 3749ba
$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp
Packit Service 3749ba
	@true
Packit Service 3749ba
Packit Service 3749ba
#### xml ####
Packit Service 3749ba
Packit Service 3749ba
sgml-build.stamp: setup-build.stamp $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt $(expand_content_files)
Packit Service 3749ba
	@echo '  DOC   Building XML'
Packit Service 3749ba
	@_source_dir='' ; \
Packit Service 3749ba
	for i in $(DOC_SOURCE_DIR) ; do \
Packit Service 3749ba
	    _source_dir="$${_source_dir} --source-dir=$$i" ; \
Packit Service 3749ba
	done ; \
Packit Service 3749ba
	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)
Packit Service 3749ba
	@touch sgml-build.stamp
Packit Service 3749ba
Packit Service 3749ba
sgml.stamp: sgml-build.stamp
Packit Service 3749ba
	@true
Packit Service 3749ba
Packit Service 3749ba
#### html ####
Packit Service 3749ba
Packit Service 3749ba
html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) $(srcdir)/style.css
Packit Service 3749ba
	@echo '  DOC   Building HTML'
Packit Service 3749ba
	@rm -rf html
Packit Service 3749ba
	@mkdir html
Packit Service 3749ba
	@mkhtml_options=""; \
Packit Service 3749ba
	gtkdoc-mkhtml 2>&1 --help | grep  >/dev/null "\-\-verbose"; \
Packit Service 3749ba
	if test "$(?)" = "0"; then \
Packit Service 3749ba
	  if test "x$(V)" = "x1"; then \
Packit Service 3749ba
	    mkhtml_options="$$mkhtml_options --verbose"; \
Packit Service 3749ba
	  fi; \
Packit Service 3749ba
	fi; \
Packit Service 3749ba
	gtkdoc-mkhtml 2>&1 --help | grep  >/dev/null "\-\-path"; \
Packit Service 3749ba
	if test "$(?)" = "0"; then \
Packit Service 3749ba
	  mkhtml_options="$$mkhtml_options --path=\"$(abs_srcdir)\""; \
Packit Service 3749ba
	fi; \
Packit Service 3749ba
	cd html && gtkdoc-mkhtml $$mkhtml_options $(MKHTML_OPTIONS) $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
Packit Service 3749ba
	-@test "x$(HTML_IMAGES)" = "x" || \
Packit Service 3749ba
	for file in $(HTML_IMAGES) ; do \
Packit Service 3749ba
	  if test -f $(abs_srcdir)/$$file ; then \
Packit Service 3749ba
	    cp $(abs_srcdir)/$$file $(abs_builddir)/html; \
Packit Service 3749ba
	  fi; \
Packit Service 3749ba
	  if test -f $(abs_builddir)/$$file ; then \
Packit Service 3749ba
	    cp $(abs_builddir)/$$file $(abs_builddir)/html; \
Packit Service 3749ba
	  fi; \
Packit Service 3749ba
	done;
Packit Service 3749ba
	@echo '  DOC   Fixing cross-references'
Packit Service 3749ba
	@gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
Packit Service 3749ba
	@mv $(builddir)/html/style.css $(builddir)/html/gtk-doc.css
Packit Service 3749ba
	@cp $(srcdir)/style.css $(builddir)/html/style.css
Packit Service 3749ba
	@touch html-build.stamp
Packit Service 3749ba
Packit Service 3749ba
#### pdf ####
Packit Service 3749ba
Packit Service 3749ba
pdf-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
Packit Service 3749ba
	@echo '  DOC   Building PDF'
Packit Service 3749ba
	@rm -f $(DOC_MODULE).pdf
Packit Service 3749ba
	@mkpdf_options=""; \
Packit Service 3749ba
	gtkdoc-mkpdf 2>&1 --help | grep  >/dev/null "\-\-verbose"; \
Packit Service 3749ba
	if test "$(?)" = "0"; then \
Packit Service 3749ba
	  if test "x$(V)" = "x1"; then \
Packit Service 3749ba
	    mkpdf_options="$$mkpdf_options --verbose"; \
Packit Service 3749ba
	  fi; \
Packit Service 3749ba
	fi; \
Packit Service 3749ba
	if test "x$(HTML_IMAGES)" != "x"; then \
Packit Service 3749ba
	  for img in $(HTML_IMAGES); do \
Packit Service 3749ba
	    part=`dirname $$img`; \
Packit Service 3749ba
	    echo $$mkpdf_options | grep >/dev/null "\-\-imgdir=$$part "; \
Packit Service 3749ba
	    if test $$? != 0; then \
Packit Service 3749ba
	      mkpdf_options="$$mkpdf_options --imgdir=$$part"; \
Packit Service 3749ba
	    fi; \
Packit Service 3749ba
	  done; \
Packit Service 3749ba
	fi; \
Packit Service 3749ba
	gtkdoc-mkpdf --path="$(abs_srcdir)" $$mkpdf_options $(DOC_MODULE) $(DOC_MAIN_SGML_FILE) $(MKPDF_OPTIONS)
Packit Service 3749ba
	@touch pdf-build.stamp
Packit Service 3749ba
Packit Service 3749ba
##############
Packit Service 3749ba
Packit Service 3749ba
clean-local:
Packit Service 3749ba
	@rm -f *~ *.bak
Packit Service 3749ba
	@rm -rf .libs
Packit Service 3749ba
Packit Service 3749ba
distclean-local:
Packit Service 3749ba
	@rm -rf xml html $(REPORT_FILES) $(DOC_MODULE).pdf \
Packit Service 3749ba
	    $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
Packit Service 3749ba
	@if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
Packit Service 3749ba
	    rm -f $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types; \
Packit Service 3749ba
	fi
Packit Service 3749ba
Packit Service 3749ba
maintainer-clean-local: clean
Packit Service 3749ba
	@rm -rf xml html
Packit Service 3749ba
Packit Service 3749ba
install-data-local:
Packit Service 3749ba
	@installfiles=`echo $(builddir)/html/*`; \
Packit Service 3749ba
	if test "$$installfiles" = '$(builddir)/html/*'; \
Packit Service 3749ba
	then echo 1>&2 'Nothing to install' ; \
Packit Service 3749ba
	else \
Packit Service 3749ba
	  if test -n "$(DOC_MODULE_VERSION)"; then \
Packit Service 3749ba
	    installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
Packit Service 3749ba
	  else \
Packit Service 3749ba
	    installdir="$(DESTDIR)$(TARGET_DIR)"; \
Packit Service 3749ba
	  fi; \
Packit Service 3749ba
	  $(mkinstalldirs) $${installdir} ; \
Packit Service 3749ba
	  for i in $$installfiles; do \
Packit Service 3749ba
	    echo ' $(INSTALL_DATA) '$$i ; \
Packit Service 3749ba
	    $(INSTALL_DATA) $$i $${installdir}; \
Packit Service 3749ba
	  done; \
Packit Service 3749ba
	  if test -n "$(DOC_MODULE_VERSION)"; then \
Packit Service 3749ba
	    mv -f $${installdir}/$(DOC_MODULE).devhelp2 \
Packit Service 3749ba
	      $${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp2; \
Packit Service 3749ba
	  fi; \
Packit Service 3749ba
	  $(GTKDOC_REBASE) --relative --dest-dir=$(DESTDIR) --html-dir=$${installdir}; \
Packit Service 3749ba
	fi
Packit Service 3749ba
Packit Service 3749ba
uninstall-local:
Packit Service 3749ba
	@if test -n "$(DOC_MODULE_VERSION)"; then \
Packit Service 3749ba
	  installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
Packit Service 3749ba
	else \
Packit Service 3749ba
	  installdir="$(DESTDIR)$(TARGET_DIR)"; \
Packit Service 3749ba
	fi; \
Packit Service 3749ba
	rm -rf $${installdir}
Packit Service 3749ba
Packit Service 3749ba
#
Packit Service 3749ba
# Require gtk-doc when making dist
Packit Service 3749ba
#
Packit Service 3749ba
if ENABLE_GTK_DOC
Packit Service 3749ba
dist-check-gtkdoc:
Packit Service 3749ba
else
Packit Service 3749ba
dist-check-gtkdoc:
Packit Service 3749ba
	@echo "*** gtk-doc must be installed and --enable-doc in order to make dist"
Packit Service 3749ba
	@false
Packit Service 3749ba
endif
Packit Service 3749ba
Packit Service 3749ba
dist-hook: dist-check-gtkdoc dist-hook-local
Packit Service 3749ba
	@mkdir $(distdir)/html
Packit Service 3749ba
	@cp ./html/* $(distdir)/html
Packit Service 3749ba
	@-cp ./$(DOC_MODULE).pdf $(distdir)/
Packit Service 3749ba
	@-cp ./$(DOC_MODULE).types $(distdir)/
Packit Service 3749ba
	@-cp ./$(DOC_MODULE)-sections.txt $(distdir)/
Packit Service 3749ba
	@cd $(distdir) && rm -f $(DISTCLEANFILES)
Packit Service 3749ba
	@$(GTKDOC_REBASE) --online --relative --html-dir=$(distdir)/html
Packit Service 3749ba
Packit Service 3749ba
.PHONY : dist-hook-local docs