AM_CPPFLAGS = $(GLIBCXX_INCLUDES)
# Doxygen configuration
-# Assumes doxygen, graphviz (with dot) installed
-doc_doxygen_script = ${top_srcdir}/scripts/run_doxygen
-doxygen_xmldir = ${glibcxx_builddir}/doc/doxygen/xml
-
-# Performance doc and graph configuration.
-# Assumes pychart, beautiful soup installed.
-# Generates the plots and graphs for performance testing.
-doc_performance_script = ${top_srcdir}/scripts/make_graphs.py
+# Assumes doxygen, graphviz (with dot), pdflatex installed
+doxygen_script = ${top_srcdir}/scripts/run_doxygen
+doxygen_outdir = ${glibcxx_builddir}/doc/doxygen
+doxygen_pdf = ${doxygen_outdir}/latex/refman.pdf
# Docbook configuration.
# Assumes
# libxslt
+# dblatex
+# pdflatex
# docbook-style-xsl
-# emacs-nxml-mode
+# emacs-nxml-mode
# xmlto passivetex
-xml_srcdir = ${glibcxx_srcdir}/doc/xml
-xml_sources = \
- ${xml_srcdir}/spine.xml \
- ${xml_srcdir}/authors.xml \
- ${xml_srcdir}/manual/abi.xml \
- ${xml_srcdir}/manual/algorithms.xml \
- ${xml_srcdir}/manual/allocator.xml \
- ${xml_srcdir}/manual/auto_ptr.xml \
- ${xml_srcdir}/manual/backwards_compatibility.xml \
- ${xml_srcdir}/manual/bitmap_allocator.xml \
- ${xml_srcdir}/manual/build_hacking.xml \
- ${xml_srcdir}/manual/codecvt.xml \
- ${xml_srcdir}/manual/concurrency.xml \
- ${xml_srcdir}/manual/configure.xml \
- ${xml_srcdir}/manual/containers.xml \
- ${xml_srcdir}/manual/ctype.xml \
- ${xml_srcdir}/manual/debug_mode.xml \
- ${xml_srcdir}/manual/debug.xml \
- ${xml_srcdir}/manual/diagnostics.xml \
- ${xml_srcdir}/manual/evolution.xml \
- ${xml_srcdir}/manual/extensions.xml \
- ${xml_srcdir}/manual/internals.xml \
- ${xml_srcdir}/manual/intro.xml \
- ${xml_srcdir}/manual/io.xml \
- ${xml_srcdir}/manual/iterators.xml \
- ${xml_srcdir}/manual/locale.xml \
- ${xml_srcdir}/manual/localization.xml \
- ${xml_srcdir}/manual/messages.xml \
- ${xml_srcdir}/manual/mt_allocator.xml \
- ${xml_srcdir}/manual/numerics.xml \
- ${xml_srcdir}/manual/parallel_mode.xml \
- ${xml_srcdir}/manual/prerequisites.xml \
- ${xml_srcdir}/manual/profile_mode.xml \
- ${xml_srcdir}/manual/internals.xml \
- ${xml_srcdir}/manual/shared_ptr.xml \
- ${xml_srcdir}/manual/spine.xml \
- ${xml_srcdir}/manual/status_cxx1998.xml \
- ${xml_srcdir}/manual/status_cxx200x.xml \
- ${xml_srcdir}/manual/status_cxxtr1.xml \
- ${xml_srcdir}/manual/status_cxxtr24733.xml \
- ${xml_srcdir}/manual/strings.xml \
- ${xml_srcdir}/manual/support.xml \
- ${xml_srcdir}/manual/test.xml \
- ${xml_srcdir}/manual/using.xml \
- ${xml_srcdir}/manual/utilities.xml \
- ${xml_srcdir}/manual/appendix_free.xml \
- ${xml_srcdir}/manual/appendix_contributing.xml \
- ${xml_srcdir}/manual/appendix_porting.xml \
- ${xml_srcdir}/api.xml \
- ${xml_srcdir}/faq.xml
+docbook_outdir = ${glibcxx_builddir}/doc/docbook
+xml_dir = ${glibcxx_srcdir}/doc/xml
+xml_sources_basic = \
+ ${xml_dir}/spine.xml \
+ ${xml_dir}/authors.xml \
+ ${xml_dir}/api.xml \
+ ${xml_dir}/faq.xml
+
+xml_sources_manual = \
+ ${xml_dir}/manual/abi.xml \
+ ${xml_dir}/manual/algorithms.xml \
+ ${xml_dir}/manual/allocator.xml \
+ ${xml_dir}/manual/auto_ptr.xml \
+ ${xml_dir}/manual/atomics.xml \
+ ${xml_dir}/manual/backwards_compatibility.xml \
+ ${xml_dir}/manual/bitmap_allocator.xml \
+ ${xml_dir}/manual/build_hacking.xml \
+ ${xml_dir}/manual/codecvt.xml \
+ ${xml_dir}/manual/concurrency.xml \
+ ${xml_dir}/manual/concurrency_extensions.xml \
+ ${xml_dir}/manual/configure.xml \
+ ${xml_dir}/manual/containers.xml \
+ ${xml_dir}/manual/ctype.xml \
+ ${xml_dir}/manual/debug_mode.xml \
+ ${xml_dir}/manual/debug.xml \
+ ${xml_dir}/manual/diagnostics.xml \
+ ${xml_dir}/manual/evolution.xml \
+ ${xml_dir}/manual/extensions.xml \
+ ${xml_dir}/manual/internals.xml \
+ ${xml_dir}/manual/intro.xml \
+ ${xml_dir}/manual/io.xml \
+ ${xml_dir}/manual/iterators.xml \
+ ${xml_dir}/manual/locale.xml \
+ ${xml_dir}/manual/localization.xml \
+ ${xml_dir}/manual/messages.xml \
+ ${xml_dir}/manual/mt_allocator.xml \
+ ${xml_dir}/manual/numerics.xml \
+ ${xml_dir}/manual/parallel_mode.xml \
+ ${xml_dir}/manual/prerequisites.xml \
+ ${xml_dir}/manual/profile_mode.xml \
+ ${xml_dir}/manual/shared_ptr.xml \
+ ${xml_dir}/manual/spine.xml \
+ ${xml_dir}/manual/status_cxx1998.xml \
+ ${xml_dir}/manual/status_cxx200x.xml \
+ ${xml_dir}/manual/status_cxxtr1.xml \
+ ${xml_dir}/manual/status_cxxtr24733.xml \
+ ${xml_dir}/manual/strings.xml \
+ ${xml_dir}/manual/support.xml \
+ ${xml_dir}/manual/test.xml \
+ ${xml_dir}/manual/using.xml \
+ ${xml_dir}/manual/using_exceptions.xml \
+ ${xml_dir}/manual/utilities.xml \
+ ${xml_dir}/manual/appendix_free.xml \
+ ${xml_dir}/manual/appendix_contributing.xml \
+ ${xml_dir}/manual/appendix_porting.xml
xml_sources_extra = \
- ${xml_srcdir}/gnu/fdl-1.2.xml \
- ${xml_srcdir}/gnu/gpl-2.0.xml
+ ${xml_dir}/gnu/fdl-1.2.xml \
+ ${xml_dir}/gnu/gpl-2.0.xml \
+ ${xml_dir}/gnu/gpl-3.0.xml
+
+xml_sources = \
+ ${xml_sources_basic} \
+ ${xml_sources_manual} \
+ ${xml_sources_extra}
xml_noinst = \
- ${xml_srcdir}/book.txml \
- ${xml_srcdir}/chapter.txml \
- ${xml_srcdir}/class.txml
+ ${xml_dir}/book.txml \
+ ${xml_dir}/chapter.txml \
+ ${xml_dir}/class.txml
XSLTPROC = xsltproc
XSLTPROC_FLAGS = --nonet --xinclude
# Validate existing XML structure.
XMLLINT = xmllint
-#LINT_FLAGS = --debug --nonet --xinclude --nsclean --postvalid --nowarning
+#LINT_FLAGS = --debug --nonet --xinclude --nsclean --postvalid --nowarning
#LINT_FLAGS = --noblanks --noout --xinclude --postvalid --noent
LINT_FLAGS = --postvalid --debug --xinclude --noent --noblanks --nonet --noout
-VALID_FLAGS = --dtdvalid http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd
-XMLLINT_FLAGS = $(LINT_FLAGS) $(VALID_FLAGS)
+DTD_FLAGS = --dtdvalid http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd
+XMLLINT_FLAGS = $(LINT_FLAGS) $(DTD_FLAGS)
# PDF 1
# fop
PRINCE = prince
PRINCE_FLAGS = --log prince.log -o pdf/spine.pdf
+# PDF 5
+# dblatex
+DBLATEX_FLAGS = --dump --verbose --pdf -o ${docbook_outdir}/pdf/manual.pdf
+
+# Performance doc and graph configuration.
+# Assumes pychart, beautiful soup installed.
+# Generates the plots and graphs for performance testing.
+doc_performance_script = ${top_srcdir}/scripts/make_graphs.py
+
# By adding these files here, automake will remove them for 'make clean'
CLEANFILES = *.log
all: all-am
mostlyclean-generic mostlyclean-libtool pdf pdf-am ps ps-am \
uninstall uninstall-am
+
+# Documentation Overview
+#
+# There are two main source materials for libstdc++ documentation.
+# The first is the doxygen markup in libstdc++ sources. And the second
+# is the docbook markup in doc/xml/. A third and more obscure option
+# deals with charting performance tests.
+
+# Default, points to current best sub-rule that is the best conversion.
+# MAN
+doc-man: doc-man-doxygen
+
+# PDF
+doc-pdf: doc-pdf-docbook
+
+# HTML
+doc-html: doc-html-docbook
+
doc-html-doxygen:
-(srcdir=`cd ${top_srcdir}; ${PWD_COMMAND}`; \
builddir=`cd ..; ${PWD_COMMAND}`; \
- ${SHELL} ${doc_doxygen_script} \
- --host_alias=${host_alias} --mode=html $${srcdir} $${builddir})
+ ${SHELL} ${doxygen_script} \
+ --host_alias=${host_alias} --mode=html $${srcdir} $${builddir} YES)
doc-man-doxygen:
-(srcdir=`cd ${top_srcdir}; ${PWD_COMMAND}`; \
builddir=`cd ..; ${PWD_COMMAND}`; \
- ${SHELL} ${doc_doxygen_script} \
- --host_alias=${host_alias} --mode=man $${srcdir} $${builddir})
+ ${SHELL} ${doxygen_script} \
+ --host_alias=${host_alias} --mode=man $${srcdir} $${builddir} YES)
doc-xml-doxygen:
-(srcdir=`cd ${top_srcdir}; ${PWD_COMMAND}`; \
builddir=`cd ..; ${PWD_COMMAND}`; \
- ${SHELL} ${doc_doxygen_script} \
- --host_alias=${host_alias} --mode=xml $${srcdir} $${builddir})
-doc-xml-doxygen-single: doc-xml-doxygen
- @echo "Generating doxygen xml single file..."
- $(XSLTPROC) ${doxygen_xmldir}/combine.xslt ${doxygen_xmldir}/spine.xml > ${doxygen_xmldir}/all.xml;
-doc-html-performance:
- -@(chmod + ${doc_performance_script}; \
- ${doc_performance_script} ${top_srcdir} \
- ${glibcxx_builddir}/testsuite \
- ${top_srcdir}/testsuite/data/make_graph_htmls.xml \
- ${top_srcdir}/testsuite/data/make_graph_test_infos.xml local g++)
-
-${glibcxx_builddir}/doc/html:
- mkdir ${glibcxx_builddir}/doc/html
-
-${glibcxx_builddir}/doc/pdf:
- mkdir ${glibcxx_builddir}/doc/pdf
+ ${SHELL} ${doxygen_script} \
+ --host_alias=${host_alias} --mode=xml $${srcdir} $${builddir} NO)
-${glibcxx_builddir}/doc/fo:
- mkdir ${glibcxx_builddir}/doc/fo
+doc-xml-single-doxygen:
+ @echo "Generating doxygen xml single file..."
+ $(XSLTPROC) ${doxygen_outdir}/xml/combine.xslt \
+ ${doxygen_outdir}/xml/index.xml > ${doxygen_outdir}/xml/api-spine.xml;
-${glibcxx_builddir}/doc/xml:
- mkdir ${glibcxx_builddir}/doc/xml
-doc-xml-validate: $(xml_sources)
+doc-latex-doxygen:
+ -(srcdir=`cd ${top_srcdir}; ${PWD_COMMAND}`; \
+ builddir=`cd ..; ${PWD_COMMAND}`; \
+ ${SHELL} ${doxygen_script} \
+ --host_alias=${host_alias} --mode=latex $${srcdir} $${builddir} NO)
+
+# Chance of loooooonnggg creation time on this rule.
+doc-pdf-doxygen: stamp-latex-doxygen
+ -(cd ${doxygen_outdir}/latex && $(MAKE) -i pdf;)
+ echo "Generating doxygen pdf file...";
+ if [ -f ${doxygen_pdf} ]; then \
+ echo "... ${doxygen_pdf}"; \
+ else \
+ echo "... error"; \
+ exit 12; \
+ fi
+
+stamp-pdf-doxygen:
+ @if [ ! -f stamp-pdf-doxygen ]; then \
+ $(MAKE) doc-pdf-doxygen; \
+ fi
+ $(STAMP) stamp-pdf-doxygen
+
+stamp-xml-doxygen:
+ @if [ ! -f stamp-xml-doxygen ]; then \
+ $(MAKE) doc-xml-doxygen; \
+ $(MAKE) doc-xml-single-doxygen; \
+ fi
+ $(STAMP) stamp-xml-doxygen
+
+stamp-latex-doxygen:
+ @if [ ! -f stamp-latex-doxygen ]; then \
+ $(MAKE) doc-latex-doxygen; \
+ fi
+ $(STAMP) stamp-latex-doxygen
+
+${docbook_outdir}/html:
+ mkdir -p ${docbook_outdir}/html
+
+${docbook_outdir}/pdf:
+ mkdir -p ${docbook_outdir}/pdf
+
+${docbook_outdir}/fo:
+ mkdir -p ${docbook_outdir}/fo
+
+${docbook_outdir}/xml:
+ mkdir -p ${docbook_outdir}/xml
+doc-xml-validate-docbook: $(xml_sources)
@echo "Generating XML validation log..."
$(XMLLINT) $(XMLLINT_FLAGS) ${top_srcdir}/doc/xml/spine.xml
-doc-xml-single: $(xml_sources) ${glibcxx_builddir}/doc/xml
+doc-xml-single-docbook: $(xml_sources) ${docbook_outdir}/xml
@echo "Generating XML single..."
$(XMLLINT) --xinclude --noent --noblanks \
- -o ${glibcxx_builddir}/doc/xml/spine-single.xml \
+ -o ${docbook_outdir}/xml/spine-single.xml \
${top_srcdir}/doc/xml/spine.xml
# HTML, index plus chapters
-doc-html: $(xml_sources) ${glibcxx_builddir}/doc/html
+doc-html-docbook: $(xml_sources) ${docbook_outdir}/html
@echo "Generating html files..."
- $(XSLTPROC) $(XSLTPROC_FLAGS) -o ${glibcxx_builddir}/doc/html/ \
+ $(XSLTPROC) $(XSLTPROC_FLAGS) -o ${docbook_outdir}/html/ \
$(XSL_HTML_STYLE) ${top_srcdir}/doc/xml/spine.xml
# HTML, all one page
-doc-html-single: $(xml_sources) ${glibcxx_builddir}/doc/html
+doc-html-single-docbook: $(xml_sources) ${docbook_outdir}/html
@echo "Generating html single file..."
- $(XSLTPROC) $(XSLTPROC_FLAGS) -o ${glibcxx_builddir}/doc/html/ \
+ $(XSLTPROC) $(XSLTPROC_FLAGS) -o ${docbook_outdir}/html/ \
$(XSL_HTML_SINGLE_STYLE) ${top_srcdir}/doc/xml/spine.xml
# FO
-doc-fo: $(xml_sources) ${glibcxx_builddir}/doc/fo
+doc-fo-docbook: $(xml_sources) ${docbook_outdir}/fo
@echo "Generating FO files..."
- $(XSLTPROC) $(XSLTPROC_FLAGS) -o ${glibcxx_builddir}/doc/fo/spine.fo \
+ $(XSLTPROC) $(XSLTPROC_FLAGS) -o ${docbook_outdir}/fo/spine.fo \
$(XSL_FO_STYLE) ${top_srcdir}/doc/xml/spine.xml
-
-# PDF
-# Points to current best xml to PDF generation process.
-doc-pdf: doc-pdf-prince
-doc-pdf-fop-xml: $(xml_sources) ${glibcxx_builddir}/doc/pdf
+doc-pdf-fop-xml-docbook: $(xml_sources) ${glibcxx_builddir}/doc/pdf
@echo "Generating pdf fop files from xml..."
$(FOP) $(FOP_FLAGS) -xml ${top_srcdir}/doc/xml/spine.xml \
- -xsl $(XSL_FO_STYLE) -pdf ${glibcxx_builddir}/doc/pdf/spine.pdf
+ -xsl $(XSL_FO_STYLE) -pdf ${docbook_outdir}/pdf/spine.pdf
-doc-pdf-fop-fo: $(xml_sources) ${glibcxx_builddir}/doc/pdf doc-fo
+doc-pdf-fop-fo-docbook: $(xml_sources) ${glibcxx_builddir}/doc/pdf doc-fo
@echo "Generating pdf fop files from fo..."
- $(FOP) $(FOP_FLAGS) -fo ${glibcxx_builddir}/doc/fo/spine.fo \
- -pdf ${glibcxx_builddir}/doc/pdf/spine.pdf
-doc-pdf-xmlto: $(xml_sources) ${glibcxx_builddir}/doc/pdf
+ $(FOP) $(FOP_FLAGS) -fo ${docbook_outdir}/fo/spine.fo \
+ -pdf ${docbook_outdir}/pdf/spine.pdf
+doc-pdf-xmlto-docbook: $(xml_sources) ${docbook_outdir}/pdf
@echo "Generating pdf xmlto files..."
$(XML2PDF) $(XML2PDF_FLAGS) ${top_srcdir}/doc/xml/spine.xml
-doc-pdf-xmlroff: $(xml_sources) doc-fo
+doc-pdf-xmlroff-docbook: $(xml_sources) doc-fo
@echo "Generating pdf xmlroff files..."
- $(XMLROFF) $(XMLROFF_FLAGS) ${glibcxx_builddir}/doc/fo/spine.fo
-doc-pdf-prince: $(xml_sources) ${glibcxx_builddir}/doc/pdf
+ $(XMLROFF) $(XMLROFF_FLAGS) ${docbook_outdir}/fo/spine.fo
+doc-pdf-prince-docbook: $(xml_sources) ${docbook_outdir}/pdf
@echo "Generating pdf prince files..."
- $(PRINCE) $(PRINCE_FLAGS) ${top_srcdir}/doc/xml/spine.xml
+ $(PRINCE) $(PRINCE_FLAGS) ${top_srcdir}/xml/spine.xml
+doc-pdf-dblatex-docbook: $(xml_sources) ${docbook_outdir}/pdf
+ @echo "Generating pdf dblatex files..."
+ dblatex $(DBLATEX_FLAGS) ${top_srcdir}/doc/xml/spine.xml
+
+doc-pdf-docbook: doc-pdf-dblatex-docbook
+doc-html-performance:
+ -@(chmod + ${doc_performance_script}; \
+ ${doc_performance_script} ${top_srcdir} \
+ ${glibcxx_builddir}/testsuite \
+ ${top_srcdir}/testsuite/data/make_graph_htmls.xml \
+ ${top_srcdir}/testsuite/data/make_graph_test_infos.xml local g++)
.PHONY: doc-doxygen-html doc-doxygen-man doc-performance
# To remove directories.
clean-local:
- rm -rf man html pdf fo doxygen xml
+ rm -rf man html pdf fo xml doxygen docbook stamp*
# Tell versions [3.59,3.63) of GNU make to not export all variables.
# Otherwise a system limit (for SysV at least) may be exceeded.