include $(top_srcdir)/fragment.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-dblatex-docbook
+
+# HTML
+doc-html: doc-html-docbook
+
# Doxygen configuration
# Assumes doxygen, graphviz (with dot) installed
-doc_doxygen_script=${top_srcdir}/scripts/run_doxygen
+doxygen_script=${top_srcdir}/scripts/run_doxygen
+doxygen_outdir = ${glibcxx_builddir}/doc/doxygen
doc-html-doxygen:
-(srcdir=`cd ${top_srcdir}; ${PWD_COMMAND}`; \
builddir=`cd ..; ${PWD_COMMAND}`; \
- ${SHELL} ${doc_doxygen_script} \
+ ${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} \
+ ${SHELL} ${doxygen_script} \
--host_alias=${host_alias} --mode=man $${srcdir} $${builddir} YES)
-doc-xml-doxygen:
+doc-xml-doxygen:
-(srcdir=`cd ${top_srcdir}; ${PWD_COMMAND}`; \
builddir=`cd ..; ${PWD_COMMAND}`; \
- ${SHELL} ${doc_doxygen_script} \
+ ${SHELL} ${doxygen_script} \
--host_alias=${host_alias} --mode=xml $${srcdir} $${builddir} NO)
-doxygen_xmldir = ${glibcxx_builddir}/doc/doxygen/xml
-doc-xml-doxygen-single: doc-xml-doxygen
+doc-xml-single-doxygen:
@echo "Generating doxygen xml single file..."
- $(XSLTPROC) ${doxygen_xmldir}/combine.xslt ${doxygen_xmldir}/spine.xml > ${doxygen_xmldir}/all.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
-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++)
+ $(XSLTPROC) ${doxygen_outdir}/xml/combine.xslt \
+ ${doxygen_outdir}/xml/spine.xml > ${doxygen_outdir}/xml/all.xml;
# Docbook configuration.
# docbook-style-xsl
# emacs-nxml-mode
# xmlto passivetex
+docbook_outdir = ${glibcxx_builddir}/doc/docbook
xml_srcdir = ${glibcxx_srcdir}/doc/xml
xml_sources = \
${xml_srcdir}/spine.xml \
${xml_srcdir}/manual/support.xml \
${xml_srcdir}/manual/test.xml \
${xml_srcdir}/manual/using.xml \
+ ${xml_srcdir}/manual/using_exceptions.xml \
${xml_srcdir}/manual/utilities.xml \
${xml_srcdir}/manual/appendix_free.xml \
${xml_srcdir}/manual/appendix_contributing.xml \
#XSL_HTML_SINGLE_STYLE = $(XSL_STYLE_DIR)/xhtml/onechunk.xsl
XSL_HTML_SINGLE_STYLE = $(XSL_STYLE_DIR)/xhtml/docbook.xsl
-${glibcxx_builddir}/doc/html:
- mkdir ${glibcxx_builddir}/doc/html
+${docbook_outdir}/html:
+ mkdir -p ${docbook_outdir}/html
-${glibcxx_builddir}/doc/pdf:
- mkdir ${glibcxx_builddir}/doc/pdf
+${docbook_outdir}/pdf:
+ mkdir -p ${docbook_outdir}/pdf
-${glibcxx_builddir}/doc/fo:
- mkdir ${glibcxx_builddir}/doc/fo
+${docbook_outdir}/fo:
+ mkdir -p ${docbook_outdir}/fo
-${glibcxx_builddir}/doc/xml:
- mkdir ${glibcxx_builddir}/doc/xml
+${docbook_outdir}/xml:
+ mkdir -p ${docbook_outdir}/xml
# Validate existing XML structure.
XMLLINT = xmllint
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)
-doc-xml-validate: $(xml_sources)
+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-dblatex
-
# PDF 1
# fop
FOP = fop
FOP_FLAGS = -d -r
-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
+ $(FOP) $(FOP_FLAGS) -fo ${docbook_outdir}/fo/spine.fo \
+ -pdf ${docbook_outdir}/pdf/spine.pdf
# PDF 2
# xmlto
XML2PDF = xmlto
XML2PDF_FLAGS = -v pdf --skip-validation -o pdf
-doc-pdf-xmlto: $(xml_sources) ${glibcxx_builddir}/doc/pdf
+doc-pdf-xmlto-docbook: $(xml_sources) ${docbook_outdir}/pdf
@echo "Generating pdf xmlto files..."
$(XML2PDF) $(XML2PDF_FLAGS) ${top_srcdir}/doc/xml/spine.xml
# xmlroff
XMLROFF = xmlroff
XMLROFF_FLAGS = --format=pdf --backend=cairo --warn=1 --debug=1 --continue
-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
+ $(XMLROFF) $(XMLROFF_FLAGS) ${docbook_outdir}/fo/spine.fo
# PDF 4
# prince
PRINCE = prince
PRINCE_FLAGS = --log prince.log -o pdf/spine.pdf
-doc-pdf-prince: $(xml_sources) ${glibcxx_builddir}/doc/pdf
+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
# PDF 5
# dblatex
-DBLATEX_FLAGS = --dump --verbose --pdf -o pdf/manual.pdf
-doc-pdf-dblatex: $(xml_sources) ${glibcxx_builddir}/doc/pdf
+DBLATEX_FLAGS = --dump --verbose --pdf -o ${docbook_outdir}/pdf/manual.pdf
+doc-pdf-dblatex-docbook: $(xml_sources) ${docbook_outdir}/pdf
@echo "Generating pdf dblatex files..."
dblatex $(DBLATEX_FLAGS) ${top_srcdir}/doc/xml/spine.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
+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
# By adding these files here, automake will remove them for 'make clean'
# To remove directories.
clean-local:
- rm -rf man html pdf fo doxygen xml
+ rm -rf man html pdf fo xml doxygen docbook
OSDN Git Service
