# 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.
+# The first is the doxygen markup in libstdc++ sources, which is a
+# reference to the API. And the second is the docbook markup in
+# doc/xml/.
+#
+# A third and more obscure option deals with charting
+# performance tests, and should be considered experimental.
+
+# Default rules.
+#
+# Point to best sub-rule for the requested documentation target,
+# create, and then copy into toplevel directory with standardized names
+# and layouts.
+
+# HTML
+doc-html: doc-html-docbook doc-html-doxygen
+ cp -R ${docbook_outdir}/html ./libstdc++-manual.html
+ cp -R ${doxygen_outdir}/html ./libstdc++-api.html
-# Default, points to current best sub-rule that is the best conversion.
# MAN
doc-man: doc-man-doxygen
+ cp -R ${doxygen_outdir}/man ./libstdc++-api.man
# PDF
-doc-pdf: doc-pdf-dblatex-docbook
+doc-pdf: doc-pdf-docbook doc-pdf-doxygen
+ cp ${docbook_outdir}/pdf/libstdc++-manual.pdf .
+ cp ${doxygen_outdir}/pdf/libstdc++-api.pdf .
-# HTML
-doc-html: doc-html-docbook
+# TEXINFO
+doc-texinfo: doc-texinfo-docbook
+
+# XML
+doc-xml: doc-xml-single-docbook doc-xml-single-doxygen
+ cp ${manual_xml} .
+ cp ${api_xml} .
# Doxygen configuration
-# Assumes doxygen, graphviz (with dot) installed
+# Assumes doxygen, graphviz (with dot), pdflatex installed
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} ${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} ${doxygen_script} \
--host_alias=${host_alias} --mode=xml $${srcdir} $${builddir} NO)
-doc-xml-single-doxygen:
+api_xml = ${doxygen_outdir}/xml/libstdc++-api-single.xml
+doc-xml-single-doxygen: doc-xml-doxygen
@echo "Generating doxygen xml single file..."
$(XSLTPROC) ${doxygen_outdir}/xml/combine.xslt \
- ${doxygen_outdir}/xml/spine.xml > ${doxygen_outdir}/xml/all.xml;
+ ${doxygen_outdir}/xml/index.xml > ${api_xml};
+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. Iff this fails,
+# look at refman.log and see if TeX's memory is exhausted. Symptoms
+# include asking a wizard to enlarge capacity. If this is the case,
+# find texmf.cnf and add a zero for pool_size, string_vacancies,
+# max_strings, and pool_free values.
+doxygen_pdf = ${doxygen_outdir}/latex/refman.pdf
+api_pdf = ${doxygen_outdir}/pdf/libstdc++-api.pdf
+
+${doxygen_outdir}/pdf:
+ mkdir -p ${doxygen_outdir}/pdf
+
+doc-pdf-doxygen: stamp-latex-doxygen ${doxygen_outdir}/pdf
+ -(cd ${doxygen_outdir}/latex && $(MAKE) -i pdf;)
+ echo "Generating doxygen pdf file...";
+ if [ -f ${doxygen_pdf} ]; then \
+ mv ${doxygen_pdf} ${api_pdf} ; \
+ echo ":: PDF file is ${api_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 configuration.
# Assumes
# libxslt
+# dblatex
+# pdflatex
# docbook-style-xsl
-# emacs-nxml-mode
+# 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}/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_extensions.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/using_exceptions.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
+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/fdl-1.3.xml \
+ ${xml_dir}/gnu/gpl-2.0.xml \
+ ${xml_dir}/gnu/gpl-3.0.xml
-xml_noinst = \
- ${xml_srcdir}/book.txml \
- ${xml_srcdir}/chapter.txml \
- ${xml_srcdir}/class.txml
+xml_sources = \
+ ${xml_sources_basic} \
+ ${xml_sources_manual} \
+ ${xml_sources_extra}
+xml_noinst = \
+ ${xml_dir}/book.txml \
+ ${xml_dir}/chapter.txml \
+ ${xml_dir}/class.txml
XSLTPROC = xsltproc
XSLTPROC_FLAGS = --nonet --xinclude
#XSL_HTML_SINGLE_STYLE = $(XSL_STYLE_DIR)/xhtml/onechunk.xsl
XSL_HTML_SINGLE_STYLE = $(XSL_STYLE_DIR)/xhtml/docbook.xsl
+${docbook_outdir}/fo:
+ mkdir -p ${docbook_outdir}/fo
+
${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}/texinfo:
+ mkdir -p ${docbook_outdir}/texinfo
${docbook_outdir}/xml:
mkdir -p ${docbook_outdir}/xml
# 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)
doc-xml-validate-docbook: $(xml_sources)
@echo "Generating XML validation log..."
$(XMLLINT) $(XMLLINT_FLAGS) ${top_srcdir}/doc/xml/spine.xml
+# XML, all one page
+# Some info on canonicalization
+# http://www.mail-archive.com/help-texinfo@gnu.org/msg00864.html
+manual_xml = ${docbook_outdir}/xml/libstdc++-manual-single.xml
doc-xml-single-docbook: $(xml_sources) ${docbook_outdir}/xml
@echo "Generating XML single..."
- $(XMLLINT) --xinclude --noent --noblanks \
- -o ${docbook_outdir}/xml/spine-single.xml \
- ${top_srcdir}/doc/xml/spine.xml
+ $(XMLLINT) --xinclude --noent --noblanks --nocdata --nsclean --c14n \
+ ${top_srcdir}/doc/xml/manual/spine.xml > ${manual_xml}
# HTML, index plus chapters
doc-html-docbook: $(xml_sources) ${docbook_outdir}/html
$(XSL_HTML_STYLE) ${top_srcdir}/doc/xml/spine.xml
# HTML, all one page
+manual_html = ${docbook_outdir}/html/libstdc++-manual-single.html
doc-html-single-docbook: $(xml_sources) ${docbook_outdir}/html
@echo "Generating html single file..."
- $(XSLTPROC) $(XSLTPROC_FLAGS) -o ${docbook_outdir}/html/ \
+ $(XSLTPROC) $(XSLTPROC_FLAGS) -o ${manual_html} \
$(XSL_HTML_SINGLE_STYLE) ${top_srcdir}/doc/xml/spine.xml
# FO
$(XSLTPROC) $(XSLTPROC_FLAGS) -o ${docbook_outdir}/fo/spine.fo \
$(XSL_FO_STYLE) ${top_srcdir}/doc/xml/spine.xml
-# PDF 1
-# fop
-FOP = fop
-FOP_FLAGS = -d -r
-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 ${docbook_outdir}/pdf/spine.pdf
-
-doc-pdf-fop-fo-docbook: $(xml_sources) ${glibcxx_builddir}/doc/pdf doc-fo
- @echo "Generating pdf fop files from fo..."
- $(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-docbook: $(xml_sources) ${docbook_outdir}/pdf
- @echo "Generating pdf xmlto files..."
- $(XML2PDF) $(XML2PDF_FLAGS) ${top_srcdir}/doc/xml/spine.xml
-
-# PDF 3
-# xmlroff
-XMLROFF = xmlroff
-XMLROFF_FLAGS = --format=pdf --backend=cairo --warn=1 --debug=1 --continue
-doc-pdf-xmlroff-docbook: $(xml_sources) doc-fo
- @echo "Generating pdf xmlroff files..."
- $(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-docbook: $(xml_sources) ${docbook_outdir}/pdf
- @echo "Generating pdf prince files..."
- $(PRINCE) $(PRINCE_FLAGS) ${top_srcdir}/xml/spine.xml
-
-# PDF 5
-# dblatex
-DBLATEX_FLAGS = --dump --verbose --pdf -o ${docbook_outdir}/pdf/manual.pdf
+# PDF, via dblatex
+manual_pdf = ${docbook_outdir}/pdf/libstdc++-manual.pdf
+DBLATEX_FLAGS = --dump --verbose --pdf -o ${manual_pdf}
+doc-pdf-docbook: doc-pdf-dblatex-docbook
+
doc-pdf-dblatex-docbook: $(xml_sources) ${docbook_outdir}/pdf
@echo "Generating pdf dblatex files..."
dblatex $(DBLATEX_FLAGS) ${top_srcdir}/doc/xml/spine.xml
+# Texinfo, via docbook2X
+DB2TEXI_FLAGS = \
+ --encoding=utf-8//TRANSLIT \
+ --string-param output-file="libstdc++-manual" \
+ --string-param directory-category="GNU C++ Library" \
+ --string-param explicit-node-names=true
+doc-texinfo-docbook: doc-xml-single-docbook ${docbook_outdir}/texinfo
+ @echo "Generating texinfo files..."
+ db2x_docbook2texi $(DB2TEXI_FLAGS) ${manual_xml}
+
# Performance doc and graph configuration.
# Assumes pychart, beautiful soup installed.
${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 xml doxygen docbook
+ rm -rf man html pdf fo xml doxygen docbook stamp* ./libstdc++-* db2t*
projects / thirdparty / gcc.git / blobdiff