Commit 5bca11c4 by Benjamin Kosnik Committed by Benjamin Kosnik

Makefile.am: Edit pdf rules.

2010-07-13  Benjamin Kosnik  <bkoz@redhat.com>

	* doc/Makefile.am: Edit pdf rules.
	(doc-man, doc-pdf, doc-html): Expand default rules.
	* doc/Makefile.in: Regenerate.
	* doc/doxygen/user.cfg.in: Update to Doxygen 1.7.1.

From-SVN: r162151
parent d1465187
2010-07-13 Benjamin Kosnik <bkoz@redhat.com>
* doc/Makefile.am: Edit pdf rules.
(doc-man, doc-pdf, doc-html): Expand default rules.
* doc/Makefile.in: Regenerate.
* doc/doxygen/user.cfg.in: Update to Doxygen 1.7.1.
2010-07-11 Paolo Carlini <paolo.carlini@oracle.com> 2010-07-11 Paolo Carlini <paolo.carlini@oracle.com>
* include/std/type_traits (is_convertible): Use SFINAE. * include/std/type_traits (is_convertible): Use SFINAE.
......
...@@ -25,20 +25,32 @@ include $(top_srcdir)/fragment.am ...@@ -25,20 +25,32 @@ include $(top_srcdir)/fragment.am
# Documentation Overview # Documentation Overview
# #
# There are two main source materials for libstdc++ documentation. # There are two main source materials for libstdc++ documentation.
# The first is the doxygen markup in libstdc++ sources. And the second # The first is the doxygen markup in libstdc++ sources, which is a
# is the docbook markup in doc/xml/. A third and more obscure option # reference to the API. And the second is the docbook markup in
# deals with charting performance tests. # 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.
# Default, points to current best sub-rule that is the best conversion.
# MAN # MAN
doc-man: doc-man-doxygen doc-man: doc-man-doxygen
cp -R ${doxygen_outdir}/man ./libstdc++-api.man
# PDF # PDF
doc-pdf: doc-pdf-docbook doc-pdf: doc-pdf-docbook doc-pdf-doxygen
cp ${docbook_outdir}/pdf/libstdc++-manual.pdf .
cp ${doxygen_outdir}/pdf/libstdc++-api.pdf .
# HTML # HTML
doc-html: doc-html-docbook doc-html: doc-html-docbook doc-html-doxygen
cp -R ${docbook_outdir}/html ./libstdc++-manual.html
cp -R ${doxygen_outdir}/html ./libstdc++-api.html
# Doxygen configuration # Doxygen configuration
# Assumes doxygen, graphviz (with dot), pdflatex installed # Assumes doxygen, graphviz (with dot), pdflatex installed
...@@ -227,11 +239,11 @@ doc-xml-validate-docbook: $(xml_sources) ...@@ -227,11 +239,11 @@ doc-xml-validate-docbook: $(xml_sources)
@echo "Generating XML validation log..." @echo "Generating XML validation log..."
$(XMLLINT) $(XMLLINT_FLAGS) ${top_srcdir}/doc/xml/spine.xml $(XMLLINT) $(XMLLINT_FLAGS) ${top_srcdir}/doc/xml/spine.xml
manual_xml = ${docbook_outdir}/xml/libstdc++-manual.xml
doc-xml-single-docbook: $(xml_sources) ${docbook_outdir}/xml doc-xml-single-docbook: $(xml_sources) ${docbook_outdir}/xml
@echo "Generating XML single..." @echo "Generating XML single..."
$(XMLLINT) --xinclude --noent --noblanks \ $(XMLLINT) --xinclude --noent --noblanks \
-o ${docbook_outdir}/xml/spine-single.xml \ -o ${manual_xml} ${top_srcdir}/doc/xml/spine.xml
${top_srcdir}/doc/xml/spine.xml
# HTML, index plus chapters # HTML, index plus chapters
doc-html-docbook: $(xml_sources) ${docbook_outdir}/html doc-html-docbook: $(xml_sources) ${docbook_outdir}/html
...@@ -240,9 +252,10 @@ doc-html-docbook: $(xml_sources) ${docbook_outdir}/html ...@@ -240,9 +252,10 @@ doc-html-docbook: $(xml_sources) ${docbook_outdir}/html
$(XSL_HTML_STYLE) ${top_srcdir}/doc/xml/spine.xml $(XSL_HTML_STYLE) ${top_srcdir}/doc/xml/spine.xml
# HTML, all one page # HTML, all one page
manual_html = ${docbook_outdir}/html/libstdc++-manual-single.html
doc-html-single-docbook: $(xml_sources) ${docbook_outdir}/html doc-html-single-docbook: $(xml_sources) ${docbook_outdir}/html
@echo "Generating html single file..." @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 $(XSL_HTML_SINGLE_STYLE) ${top_srcdir}/doc/xml/spine.xml
# FO # FO
...@@ -251,53 +264,16 @@ doc-fo-docbook: $(xml_sources) ${docbook_outdir}/fo ...@@ -251,53 +264,16 @@ doc-fo-docbook: $(xml_sources) ${docbook_outdir}/fo
$(XSLTPROC) $(XSLTPROC_FLAGS) -o ${docbook_outdir}/fo/spine.fo \ $(XSLTPROC) $(XSLTPROC_FLAGS) -o ${docbook_outdir}/fo/spine.fo \
$(XSL_FO_STYLE) ${top_srcdir}/doc/xml/spine.xml $(XSL_FO_STYLE) ${top_srcdir}/doc/xml/spine.xml
# PDF 1 # PDF, via dblatex
# fop manual_pdf = ${docbook_outdir}/pdf/libstdc++-manual.pdf
FOP = fop DBLATEX_FLAGS = --dump --verbose --pdf -o ${manual_pdf}
FOP_FLAGS = -d -r
doc-pdf-fop-xml-docbook: $(xml_sources) ${glibcxx_builddir}/doc/pdf doc-pdf-docbook: doc-pdf-dblatex-docbook
@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
doc-pdf-dblatex-docbook: $(xml_sources) ${docbook_outdir}/pdf doc-pdf-dblatex-docbook: $(xml_sources) ${docbook_outdir}/pdf
@echo "Generating pdf dblatex files..." @echo "Generating pdf dblatex files..."
dblatex $(DBLATEX_FLAGS) ${top_srcdir}/doc/xml/spine.xml dblatex $(DBLATEX_FLAGS) ${top_srcdir}/doc/xml/spine.xml
doc-pdf-docbook: doc-pdf-dblatex-docbook
# Performance doc and graph configuration. # Performance doc and graph configuration.
# Assumes pychart, beautiful soup installed. # Assumes pychart, beautiful soup installed.
...@@ -318,4 +294,4 @@ CLEANFILES = *.log ...@@ -318,4 +294,4 @@ CLEANFILES = *.log
# To remove directories. # To remove directories.
clean-local: clean-local:
rm -rf man html pdf fo xml doxygen docbook stamp* rm -rf man html pdf fo xml doxygen docbook stamp* ./libstdc++-* db2t*
...@@ -371,30 +371,14 @@ XMLLINT = xmllint ...@@ -371,30 +371,14 @@ XMLLINT = xmllint
LINT_FLAGS = --postvalid --debug --xinclude --noent --noblanks --nonet --noout LINT_FLAGS = --postvalid --debug --xinclude --noent --noblanks --nonet --noout
DTD_FLAGS = --dtdvalid http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd DTD_FLAGS = --dtdvalid http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd
XMLLINT_FLAGS = $(LINT_FLAGS) $(DTD_FLAGS) XMLLINT_FLAGS = $(LINT_FLAGS) $(DTD_FLAGS)
manual_xml = ${docbook_outdir}/xml/libstdc++-manual.xml
# PDF 1 # HTML, all one page
# fop manual_html = ${docbook_outdir}/html/libstdc++-manual-single.html
FOP = fop
FOP_FLAGS = -d -r
# PDF 2
# xmlto
XML2PDF = xmlto
XML2PDF_FLAGS = -v pdf --skip-validation -o pdf
# PDF 3
# xmlroff
XMLROFF = xmlroff
XMLROFF_FLAGS = --format=pdf --backend=cairo --warn=1 --debug=1 --continue
# PDF 4
# prince
PRINCE = prince
PRINCE_FLAGS = --log prince.log -o pdf/spine.pdf
# PDF 5 # PDF, via dblatex
# dblatex manual_pdf = ${docbook_outdir}/pdf/libstdc++-manual.pdf
DBLATEX_FLAGS = --dump --verbose --pdf -o ${docbook_outdir}/pdf/manual.pdf DBLATEX_FLAGS = --dump --verbose --pdf -o ${manual_pdf}
# Performance doc and graph configuration. # Performance doc and graph configuration.
# Assumes pychart, beautiful soup installed. # Assumes pychart, beautiful soup installed.
...@@ -561,19 +545,32 @@ uninstall-am: ...@@ -561,19 +545,32 @@ uninstall-am:
# Documentation Overview # Documentation Overview
# #
# There are two main source materials for libstdc++ documentation. # There are two main source materials for libstdc++ documentation.
# The first is the doxygen markup in libstdc++ sources. And the second # The first is the doxygen markup in libstdc++ sources, which is a
# is the docbook markup in doc/xml/. A third and more obscure option # reference to the API. And the second is the docbook markup in
# deals with charting performance tests. # 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.
# Default, points to current best sub-rule that is the best conversion.
# MAN # MAN
doc-man: doc-man-doxygen doc-man: doc-man-doxygen
cp -R ${doxygen_outdir}/man ./libstdc++-api.man
# PDF # PDF
doc-pdf: doc-pdf-docbook doc-pdf: doc-pdf-docbook doc-pdf-doxygen
cp ${docbook_outdir}/pdf/libstdc++-manual.pdf .
cp ${doxygen_outdir}/pdf/libstdc++-api.pdf .
# HTML # HTML
doc-html: doc-html-docbook doc-html: doc-html-docbook doc-html-doxygen
cp -R ${docbook_outdir}/html ./libstdc++-manual.html
cp -R ${doxygen_outdir}/html ./libstdc++-api.html
doc-html-doxygen: doc-html-doxygen:
-(srcdir=`cd ${top_srcdir}; ${PWD_COMMAND}`; \ -(srcdir=`cd ${top_srcdir}; ${PWD_COMMAND}`; \
...@@ -651,23 +648,19 @@ ${docbook_outdir}/xml: ...@@ -651,23 +648,19 @@ ${docbook_outdir}/xml:
doc-xml-validate-docbook: $(xml_sources) doc-xml-validate-docbook: $(xml_sources)
@echo "Generating XML validation log..." @echo "Generating XML validation log..."
$(XMLLINT) $(XMLLINT_FLAGS) ${top_srcdir}/doc/xml/spine.xml $(XMLLINT) $(XMLLINT_FLAGS) ${top_srcdir}/doc/xml/spine.xml
doc-xml-single-docbook: $(xml_sources) ${docbook_outdir}/xml doc-xml-single-docbook: $(xml_sources) ${docbook_outdir}/xml
@echo "Generating XML single..." @echo "Generating XML single..."
$(XMLLINT) --xinclude --noent --noblanks \ $(XMLLINT) --xinclude --noent --noblanks \
-o ${docbook_outdir}/xml/spine-single.xml \ -o ${manual_xml} ${top_srcdir}/doc/xml/spine.xml
${top_srcdir}/doc/xml/spine.xml
# HTML, index plus chapters # HTML, index plus chapters
doc-html-docbook: $(xml_sources) ${docbook_outdir}/html doc-html-docbook: $(xml_sources) ${docbook_outdir}/html
@echo "Generating html files..." @echo "Generating html files..."
$(XSLTPROC) $(XSLTPROC_FLAGS) -o ${docbook_outdir}/html/ \ $(XSLTPROC) $(XSLTPROC_FLAGS) -o ${docbook_outdir}/html/ \
$(XSL_HTML_STYLE) ${top_srcdir}/doc/xml/spine.xml $(XSL_HTML_STYLE) ${top_srcdir}/doc/xml/spine.xml
# HTML, all one page
doc-html-single-docbook: $(xml_sources) ${docbook_outdir}/html doc-html-single-docbook: $(xml_sources) ${docbook_outdir}/html
@echo "Generating html single file..." @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 $(XSL_HTML_SINGLE_STYLE) ${top_srcdir}/doc/xml/spine.xml
# FO # FO
...@@ -675,29 +668,12 @@ doc-fo-docbook: $(xml_sources) ${docbook_outdir}/fo ...@@ -675,29 +668,12 @@ doc-fo-docbook: $(xml_sources) ${docbook_outdir}/fo
@echo "Generating FO files..." @echo "Generating FO files..."
$(XSLTPROC) $(XSLTPROC_FLAGS) -o ${docbook_outdir}/fo/spine.fo \ $(XSLTPROC) $(XSLTPROC_FLAGS) -o ${docbook_outdir}/fo/spine.fo \
$(XSL_FO_STYLE) ${top_srcdir}/doc/xml/spine.xml $(XSL_FO_STYLE) ${top_srcdir}/doc/xml/spine.xml
doc-pdf-fop-xml-docbook: $(xml_sources) ${glibcxx_builddir}/doc/pdf
@echo "Generating pdf fop files from xml..." doc-pdf-docbook: doc-pdf-dblatex-docbook
$(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
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-docbook: $(xml_sources) doc-fo
@echo "Generating pdf xmlroff files..."
$(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}/xml/spine.xml
doc-pdf-dblatex-docbook: $(xml_sources) ${docbook_outdir}/pdf doc-pdf-dblatex-docbook: $(xml_sources) ${docbook_outdir}/pdf
@echo "Generating pdf dblatex files..." @echo "Generating pdf dblatex files..."
dblatex $(DBLATEX_FLAGS) ${top_srcdir}/doc/xml/spine.xml dblatex $(DBLATEX_FLAGS) ${top_srcdir}/doc/xml/spine.xml
doc-pdf-docbook: doc-pdf-dblatex-docbook
doc-html-performance: doc-html-performance:
-@(chmod + ${doc_performance_script}; \ -@(chmod + ${doc_performance_script}; \
${doc_performance_script} ${top_srcdir} \ ${doc_performance_script} ${top_srcdir} \
...@@ -709,7 +685,7 @@ doc-html-performance: ...@@ -709,7 +685,7 @@ doc-html-performance:
# To remove directories. # To remove directories.
clean-local: clean-local:
rm -rf man html pdf fo xml doxygen docbook stamp* rm -rf man html pdf fo xml doxygen docbook stamp* ./libstdc++-* db2t*
# Tell versions [3.59,3.63) of GNU make to not export all variables. # 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. # Otherwise a system limit (for SysV at least) may be exceeded.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment