[thirdparty/gcc.git] / libstdc++-v3 / doc / Makefile.am

## Makefile for the doc subdirectory of the GNU C++ Standard library.
##
## Copyright (C) 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
##
## This file is part of the libstdc++ version 3 distribution.
## Process this file with automake to produce Makefile.in.

## This file is part of the GNU ISO C++ Library.  This library is free
## software; you can redistribute it and/or modify it under the
## terms of the GNU General Public License as published by the
## Free Software Foundation; either version 3, or (at your option)
## any later version.

## This library is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU General Public License for more details.

## You should have received a copy of the GNU General Public License along
## with this library; see the file COPYING3.  If not see
## <http://www.gnu.org/licenses/>.

include $(top_srcdir)/fragment.am

# Documentation Overview
#
# There are two main input materials for libstdc++ documentation.
# The first is the doxygen markup in libstdc++ sources, which is a
# reference to the API. And the second is the manual, via docbook markup in
# doc/xml/.
#
# A third and more obscure option deals with charting performance
# tests, and should be considered experimental.

# Documentation conditionals for output.
if BUILD_XML
STAMP_XML = doc-xml
STAMP_INSTALL_XML = doc-install-xml
else
STAMP_XML =
STAMP_INSTALL_XML =
endif

if BUILD_HTML
STAMP_HTML = doc-html
STAMP_INSTALL_HTML = doc-install-html
else
STAMP_HTML =
STAMP_INSTALL_HTML =
endif

if BUILD_MAN
STAMP_MAN = doc-man
STAMP_INSTALL_MAN = doc-install-man
else
STAMP_MAN =
STAMP_INSTALL_MAN =
endif

if BUILD_PDF
STAMP_PDF = doc-pdf
STAMP_INSTALL_PDF = doc-install-pdf
else
STAMP_PDF =
STAMP_INSTALL_PDF =
endif

if BUILD_EPUB
STAMP_EPUB = doc-epub
STAMP_INSTALL_EPUB = doc-install-epub
else
STAMP_EPUB = doc-epub
STAMP_INSTALL_EPUB = doc-install-epub
endif

# Documentation primary rules.
#
# xml:
# html:
# pdf:
# man:
# info:
# ps:
# dvi:
# epub:
# install-xml:
# install-html:
# install-pdf:
# install-man:
# install-info:
# install-ps:
# install-dvi:
# install-epub:

xml: $(STAMP_XML)
install-xml: $(STAMP_INSTALL_XML)

html: $(STAMP_HTML)
install-html: $(STAMP_INSTALL_HTML)

man: $(STAMP_MAN)
install-man: $(STAMP_INSTALL_MAN)

pdf: $(STAMP_PDF)
install-pdf: $(STAMP_INSTALL_PDF)

epub: $(STAMP_EPUB)
install-epub: $(STAMP_INSTALL_EPUB)

info:
install-info:

ps:
install-ps:

dvi:
install-dvi:


# Default creation and installation rules.
# Point to best sub-rule for the requested documentation target and
# create, and then install toplevel directory with standardized names
# and layouts.

# XML
xmldir="$(DESTDIR)@docdir@"
stamp-xml: stamp-xml-single-docbook stamp-xml-single-doxygen
	$(STAMP) stamp-xml

doc-xml: stamp-xml

doc-install-xml: doc-xml
	test -z ${xmldir} || $(mkinstalldirs) ${xmldir}
	$(INSTALL_DATA) ${manual_xml} ${xmldir}
	$(INSTALL_DATA)	${api_xml} ${xmldir}

# HTML
htmldir="$(DESTDIR)@docdir@"
stamp-html: stamp-html-copy stamp-html-doxygen
	$(STAMP) stamp-html

copydir=${docbook_outdir}/html/manual/ext/
stamp-html-copy: stamp-html-docbook
	cp -r ${top_srcdir}/doc/html/ext ${docbook_outdir}/html/manual/ext
	cd ${docbook_outdir}/html/manual/ext
	rm -rf ${docbook_outdir}/html/manual/ext/.svn 
	rm -rf ${docbook_outdir}/html/manual/ext/pb_ds/.svn
	$(STAMP) stamp-html-copy

doc-html: stamp-html

doc-install-html: doc-html
	test -z ${htmldir} || $(mkinstalldirs) ${htmldir}
	cp -r ${docbook_outdir}/html ${htmldir}/libstdc++-manual.html;
	cp -r ${doxygen_outdir}/html ${htmldir}/libstdc++-api.html;

# PDF
pdfdir="$(DESTDIR)@docdir@"
stamp-pdf: stamp-pdf-docbook stamp-pdf-doxygen
	$(STAMP) stamp-pdf

doc-pdf: stamp-pdf

doc-install-pdf: doc-pdf
	test -z ${pdfdir} || $(mkinstalldirs) ${pdfdir}
	$(INSTALL_DATA) ${docbook_outdir}/pdf/libstdc++-manual.pdf ${pdfdir}
	$(INSTALL_DATA) ${doxygen_outdir}/pdf/libstdc++-api.pdf ${pdfdir}

# MAN
mandir="$(DESTDIR)@mandir@"
stamp-man: stamp-man-doxygen
	$(STAMP) stamp-man

doc-man: stamp-man

doc-install-man: doc-man
	test -z ${mandir} || $(mkinstalldirs) ${mandir}
	cp -r ${doxygen_outdir}/man/man3 ${mandir}

# TEXINFO,INFO
infodir="$(DESTDIR)@infodir@"
stamp-texinfo: stamp-texinfo-docbook
	$(STAMP) stamp-texinfo

stamp-info: stamp-info-docbook
	$(STAMP) stamp-info

doc-texinfo: stamp-texinfo

doc-info: stamp-info

doc-install-texinfo: doc-texinfo
	test -z ${infodir} || $(mkinstalldirs) ${infodir}
	$(INSTALL_DATA) ${manual_texi} ${infodir}

doc-install-info: doc-info
	test -z ${infodir} || $(mkinstalldirs) ${infodir}
	$(INSTALL_DATA) ${manual_info} ${infodir}

# EPUB
# Assumes ruby installed
epubdir="$(DESTDIR)@docdir@"
stamp-epub: stamp-epub-docbook
	$(STAMP) stamp-epub

doc-epub: stamp-epub

doc-install-epub: doc-epub
	test -z ${epubdir} || $(mkinstalldirs) ${epubdir}
	$(INSTALL_DATA) ${manual_epub} ${epubdir}


# Doxygen configuration
# Assumes doxygen, graphviz (with dot), pdflatex installed
doxygen_script=${top_srcdir}/scripts/run_doxygen
doxygen_outdir = ${glibcxx_builddir}/doc/doxygen
api_xml = ${doxygen_outdir}/xml/libstdc++-api-single.xml
doxygen_pdf = ${doxygen_outdir}/latex/refman.pdf
api_pdf = ${doxygen_outdir}/pdf/libstdc++-api.pdf

${doxygen_outdir}/xml:
	mkdir -p ${doxygen_outdir}/xml

${doxygen_outdir}/html:
	mkdir -p ${doxygen_outdir}/html

${doxygen_outdir}/latex:
	mkdir -p ${doxygen_outdir}/latex

${doxygen_outdir}/pdf:
	mkdir -p ${doxygen_outdir}/pdf

${doxygen_outdir}/man:
	mkdir -p ${doxygen_outdir}/man

stamp-xml-doxygen: ${doxygen_outdir}/xml
	-(srcdir=`cd ${top_srcdir}; ${PWD_COMMAND}`; \
	  builddir=`cd ..; ${PWD_COMMAND}`; \
	  ${SHELL} ${doxygen_script} \
	  --host_alias=${host_alias} --mode=xml $${srcdir} $${builddir} NO)
	$(STAMP) stamp-xml-doxygen

stamp-xml-single-doxygen: stamp-xml-doxygen
	@echo "Generating doxygen xml single file..."
	$(XSLTPROC) ${doxygen_outdir}/xml/combine.xslt \
	${doxygen_outdir}/xml/index.xml > ${api_xml};
	$(STAMP) stamp-xml-single-doxygen

stamp-html-doxygen: ${doxygen_outdir}/html
	-(srcdir=`cd ${top_srcdir}; ${PWD_COMMAND}`; \
	  builddir=`cd ..; ${PWD_COMMAND}`; \
	  ${SHELL} ${doxygen_script} \
	  --host_alias=${host_alias} --mode=html $${srcdir} $${builddir} YES)
	$(STAMP) stamp-html-doxygen

stamp-latex-doxygen: ${doxygen_outdir}/latex
	-(srcdir=`cd ${top_srcdir}; ${PWD_COMMAND}`; \
	  builddir=`cd ..; ${PWD_COMMAND}`; \
	  ${SHELL} ${doxygen_script} \
	  --host_alias=${host_alias} --mode=latex $${srcdir} $${builddir} NO)
	$(STAMP) stamp-latex-doxygen

# 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.
stamp-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) stamp-pdf-doxygen

stamp-man-doxygen: ${doxygen_outdir}/man
	-(srcdir=`cd ${top_srcdir}; ${PWD_COMMAND}`; \
	  builddir=`cd ..; ${PWD_COMMAND}`; \
	  ${SHELL} ${doxygen_script} \
	  --host_alias=${host_alias} --mode=man $${srcdir} $${builddir} YES)
	$(STAMP) stamp-man-doxygen

doc-xml-doxygen: stamp-xml-doxygen
doc-xml-single-doxygen: stamp-xml-single-doxygen
doc-html-doxygen: stamp-html-doxygen
doc-latex-doxygen: stamp-latex-doxygen
doc-pdf-doxygen: stamp-pdf-doxygen
doc-man-doxygen: stamp-man-doxygen


# Docbook configuration.
# Assumes
# libxslt
# dblatex
# pdflatex
# docbook-style-xsl
# emacs-nxml-mode
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/documentation_hacking.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_dir}/gnu/fdl-1.3.xml \
	${xml_dir}/gnu/gpl-3.0.xml

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 \
	${xml_dir}/images/confdeps.dot \
	${xml_dir}/images/confdeps.png \
	${xml_dir}/images/confdeps.pdf

XSLTPROC       = xsltproc
XSLTPROC_FLAGS = --nonet --xinclude
#XSL_STYLE_DIR = /usr/share/xml/docbook/stylesheet/docbook-xsl-ns
#XSL_STYLE_DIR = /usr/share/sgml/docbook/xsl-ns-stylesheets
XSL_FO_STYLE = $(XSL_STYLE_DIR)/fo/docbook.xsl
XSL_HTML_STYLE = $(XSL_STYLE_DIR)/xhtml-1_1/chunk.xsl
XSL_HTML_SINGLE_STYLE = $(XSL_STYLE_DIR)/xhtml-1_1/docbook.xsl
XSL_EPUB_STYLE = $(XSL_STYLE_DIR)/epub/docbook.xsl

${docbook_outdir}/epub:
	mkdir -p ${docbook_outdir}/epub

${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}/texinfo:
	mkdir -p ${docbook_outdir}/texinfo

${docbook_outdir}/xml:
	mkdir -p ${docbook_outdir}/xml

# Validate existing XML structure.
XMLLINT = xmllint
LINT_FLAGS = --debug --xinclude --noent --noblanks --noout
SCHEMA_FLAGS = http://www.docbook.org/xml/5.0/dtd/docbook.dtd
#SCHEMA_FLAGS = --nonet /usr/share/xml/docbook5/schema/dtd/5.0/docbook.dtd
XMLLINT_VALID_FLAGS = $(LINT_FLAGS) --dtdvalid $(SCHEMA_FLAGS)
XMLLINT_FLAGS = --xinclude --nsclean --c14n --noent --noblanks --nocdata
doc-xml-validate-docbook: $(xml_sources)
	@echo "Generating XML validation log..."
	$(XMLLINT) $(XMLLINT_VALID_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
set_xml = ${docbook_outdir}/xml/libstdc++-set-single.xml
stamp-xml-single-docbook: $(xml_sources) ${docbook_outdir}/xml
	@echo "Generating XML single..."
	$(XMLLINT) $(XMLLINT_FLAGS) \
	${top_srcdir}/doc/xml/manual/spine.xml > ${manual_xml};
	$(XMLLINT) $(XMLLINT_FLAGS) \
	${top_srcdir}/doc/xml/spine.xml > ${set_xml};
	if [ ! -d "${docbook_outdir}/xml/images" ]; then \
	  $(LN_S) ${top_srcdir}/doc/xml/images ${docbook_outdir}/xml/; \
	fi
	$(STAMP) stamp-xml-single-docbook

doc-xml-single-docbook: stamp-xml-single-docbook

# HTML, index plus chapters
stamp-html-docbook: $(xml_sources) ${docbook_outdir}/html
	@echo "Generating html files..."
	$(XSLTPROC) $(XSLTPROC_FLAGS) -o ${docbook_outdir}/html/ \
	$(XSL_HTML_STYLE) ${top_srcdir}/doc/xml/spine.xml
	$(STAMP) stamp-html-docbook

doc-html-docbook: stamp-html-docbook

# HTML, all one page
manual_html = ${docbook_outdir}/html/libstdc++-manual-single.html
stamp-html-single-docbook: $(xml_sources) ${docbook_outdir}/html
	@echo "Generating html single file..."
	$(XSLTPROC) $(XSLTPROC_FLAGS) -o ${manual_html} \
	$(XSL_HTML_SINGLE_STYLE) ${top_srcdir}/doc/xml/spine.xml
	$(STAMP) stamp-html-single-docbook

doc-html-single-docbook: stamp-html-single-docbook

# FO
stamp-fo-docbook: $(xml_sources) ${docbook_outdir}/fo
	@echo "Generating FO files..."
	$(XSLTPROC) $(XSLTPROC_FLAGS) -o ${docbook_outdir}/fo/spine.fo \
	$(XSL_FO_STYLE) ${top_srcdir}/doc/xml/spine.xml
	$(STAMP) stamp-fo-docbook

doc-fo-docbook: stamp-fo-docbook

# PDF, via dblatex
manual_pdf = ${docbook_outdir}/pdf/libstdc++-manual.pdf
DBLATEX_FLAGS = --dump --verbose --pdf -o ${manual_pdf}
stamp-pdf-docbook: $(xml_sources) ${docbook_outdir}/pdf
	@echo "Generating pdf dblatex files..."
	dblatex $(DBLATEX_FLAGS) ${top_srcdir}/doc/xml/spine.xml
	$(STAMP) stamp-pdf-docbook

doc-pdf-docbook: stamp-pdf-docbook

# TEXINFO, via docbook2X
# NB: Both experimental and tempermental
manual_texi = ${docbook_outdir}/texinfo/libstdc++-manual.texi
manual_info = ${docbook_outdir}/texinfo/libstdc++-manual.info
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

stamp-texinfo-docbook: stamp-xml-single-docbook ${docbook_outdir}/texinfo
	@echo "Generating texinfo files..."
	db2x_docbook2texi $(DB2TEXI_FLAGS) ${set_xml}
	mv libstdc++-manual.texi ${manual_texi}
	$(STAMP) stamp-texinfo-docbook

stamp-info-docbook: stamp-texinfo-docbook
	@echo "Generating info files..."
	$(MAKEINFO) $(MAKEINFOFLAGS) ${manual_texi}
	$(STAMP) stamp-info-docbook

doc-texinfo-docbook: stamp-texinfo-docbook

doc-info-docbook: stamp-info-docbook

# EPUB, via dbtoepub + ruby
manual_epub = ${docbook_outdir}/epub/libstdc++-manual.epub
stamp-epub-docbook: stamp-xml-single-docbook ${docbook_outdir}/epub
	@echo "Generating epub files..."
	${XSL_STYLE_DIR}/epub/bin/dbtoepub -v -d -o ${manual_epub} ${set_xml}
	$(STAMP) stamp-epub-docbook

doc-epub-docbook: stamp-epub-docbook


# 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'
CLEANFILES = *.log stamp*

# To remove directories.
clean-local:
	rm -rf man html pdf fo xml doxygen docbook ./libstdc++-* db2t*
Commit	Line	Data
4312e020 BK	1	## Makefile for the doc subdirectory of the GNU C++ Standard library.
4312e020 BK	2	##
d2b0caaa	3	## Copyright (C) 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
4312e020 BK	4	##
	5	## This file is part of the libstdc++ version 3 distribution.
	6	## Process this file with automake to produce Makefile.in.
	7
	8	## This file is part of the GNU ISO C++ Library. This library is free
	9	## software; you can redistribute it and/or modify it under the
	10	## terms of the GNU General Public License as published by the
748086b7	11	## Free Software Foundation; either version 3, or (at your option)
4312e020 BK	12	## any later version.
	13
	14	## This library is distributed in the hope that it will be useful,
	15	## but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	17	## GNU General Public License for more details.
	18
	19	## You should have received a copy of the GNU General Public License along
748086b7 JJ	20	## with this library; see the file COPYING3. If not see
748086b7 JJ	21	## <http://www.gnu.org/licenses/>.
4312e020 BK	22
	23	include $(top_srcdir)/fragment.am
	24
03a32789 BK	25	# Documentation Overview
03a32789 BK	26	#
b25e6b79	27	# There are two main input materials for libstdc++ documentation.
5bca11c4	28	# The first is the doxygen markup in libstdc++ sources, which is a
b25e6b79	29	# reference to the API. And the second is the manual, via docbook markup in
5bca11c4	30	# doc/xml/.
7d8cafcd	31	#
b25e6b79 BK	32	# A third and more obscure option deals with charting performance
	33	# tests, and should be considered experimental.
	34
	35	# Documentation conditionals for output.
	36	if BUILD_XML
	37	STAMP_XML = doc-xml
	38	STAMP_INSTALL_XML = doc-install-xml
	39	else
	40	STAMP_XML =
	41	STAMP_INSTALL_XML =
	42	endif
	43
	44	if BUILD_HTML
	45	STAMP_HTML = doc-html
	46	STAMP_INSTALL_HTML = doc-install-html
	47	else
	48	STAMP_HTML =
	49	STAMP_INSTALL_HTML =
	50	endif
	51
	52	if BUILD_MAN
	53	STAMP_MAN = doc-man
	54	STAMP_INSTALL_MAN = doc-install-man
	55	else
	56	STAMP_MAN =
	57	STAMP_INSTALL_MAN =
	58	endif
	59
	60	if BUILD_PDF
	61	STAMP_PDF = doc-pdf
	62	STAMP_INSTALL_PDF = doc-install-pdf
	63	else
	64	STAMP_PDF =
	65	STAMP_INSTALL_PDF =
	66	endif
	67
	68	if BUILD_EPUB
	69	STAMP_EPUB = doc-epub
	70	STAMP_INSTALL_EPUB = doc-install-epub
	71	else
	72	STAMP_EPUB = doc-epub
	73	STAMP_INSTALL_EPUB = doc-install-epub
	74	endif
	75
	76	# Documentation primary rules.
5bca11c4	77	#
b25e6b79 BK	78	# xml:
	79	# html:
	80	# pdf:
	81	# man:
	82	# info:
	83	# ps:
	84	# dvi:
	85	# epub:
	86	# install-xml:
	87	# install-html:
	88	# install-pdf:
	89	# install-man:
	90	# install-info:
	91	# install-ps:
	92	# install-dvi:
	93	# install-epub:
	94
	95	xml: $(STAMP_XML)
	96	install-xml: $(STAMP_INSTALL_XML)
	97
	98	html: $(STAMP_HTML)
	99	install-html: $(STAMP_INSTALL_HTML)
	100
	101	man: $(STAMP_MAN)
	102	install-man: $(STAMP_INSTALL_MAN)
	103
	104	pdf: $(STAMP_PDF)
	105	install-pdf: $(STAMP_INSTALL_PDF)
	106
	107	epub: $(STAMP_EPUB)
	108	install-epub: $(STAMP_INSTALL_EPUB)
	109
	110	info:
	111	install-info:
	112
	113	ps:
	114	install-ps:
	115
	116	dvi:
	117	install-dvi:
	118
	119
	120	# Default creation and installation rules.
	121	# Point to best sub-rule for the requested documentation target and
	122	# create, and then install toplevel directory with standardized names
5bca11c4	123	# and layouts.
03a32789	124
b25e6b79 BK	125	# XML
	126	xmldir="$(DESTDIR)@docdir@"
	127	stamp-xml: stamp-xml-single-docbook stamp-xml-single-doxygen
	128	$(STAMP) stamp-xml
	129
	130	doc-xml: stamp-xml
	131
	132	doc-install-xml: doc-xml
	133	test -z ${xmldir} \|\| $(mkinstalldirs) ${xmldir}
	134	$(INSTALL_DATA) ${manual_xml} ${xmldir}
	135	$(INSTALL_DATA) ${api_xml} ${xmldir}
	136
7d8cafcd	137	# HTML
b25e6b79	138	htmldir="$(DESTDIR)@docdir@"
a345e45d	139	stamp-html: stamp-html-copy stamp-html-doxygen
b25e6b79	140	$(STAMP) stamp-html
7d8cafcd	141
a345e45d BK	142	copydir=${docbook_outdir}/html/manual/ext/
	143	stamp-html-copy: stamp-html-docbook
	144	cp -r ${top_srcdir}/doc/html/ext ${docbook_outdir}/html/manual/ext
	145	cd ${docbook_outdir}/html/manual/ext
	146	rm -rf ${docbook_outdir}/html/manual/ext/.svn
	147	rm -rf ${docbook_outdir}/html/manual/ext/pb_ds/.svn
	148	$(STAMP) stamp-html-copy
	149
b25e6b79 BK	150	doc-html: stamp-html
	151
	152	doc-install-html: doc-html
	153	test -z ${htmldir} \|\| $(mkinstalldirs) ${htmldir}
	154	cp -r ${docbook_outdir}/html ${htmldir}/libstdc++-manual.html;
	155	cp -r ${doxygen_outdir}/html ${htmldir}/libstdc++-api.html;
03a32789 BK	156
03a32789 BK	157	# PDF
b25e6b79 BK	158	pdfdir="$(DESTDIR)@docdir@"
	159	stamp-pdf: stamp-pdf-docbook stamp-pdf-doxygen
	160	$(STAMP) stamp-pdf
03a32789	161
b25e6b79	162	doc-pdf: stamp-pdf
547f963b	163
b25e6b79 BK	164	doc-install-pdf: doc-pdf
	165	test -z ${pdfdir} \|\| $(mkinstalldirs) ${pdfdir}
	166	$(INSTALL_DATA) ${docbook_outdir}/pdf/libstdc++-manual.pdf ${pdfdir}
	167	$(INSTALL_DATA) ${doxygen_outdir}/pdf/libstdc++-api.pdf ${pdfdir}
	168
	169	# MAN
	170	mandir="$(DESTDIR)@mandir@"
	171	stamp-man: stamp-man-doxygen
	172	$(STAMP) stamp-man
	173
	174	doc-man: stamp-man
	175
	176	doc-install-man: doc-man
	177	test -z ${mandir} \|\| $(mkinstalldirs) ${mandir}
	178	cp -r ${doxygen_outdir}/man/man3 ${mandir}
	179
	180	# TEXINFO,INFO
	181	infodir="$(DESTDIR)@infodir@"
	182	stamp-texinfo: stamp-texinfo-docbook
	183	$(STAMP) stamp-texinfo
	184
	185	stamp-info: stamp-info-docbook
	186	$(STAMP) stamp-info
	187
	188	doc-texinfo: stamp-texinfo
	189
	190	doc-info: stamp-info
	191
	192	doc-install-texinfo: doc-texinfo
	193	test -z ${infodir} \|\| $(mkinstalldirs) ${infodir}
	194	$(INSTALL_DATA) ${manual_texi} ${infodir}
	195
	196	doc-install-info: doc-info
	197	test -z ${infodir} \|\| $(mkinstalldirs) ${infodir}
	198	$(INSTALL_DATA) ${manual_info} ${infodir}
	199
	200	# EPUB
	201	# Assumes ruby installed
	202	epubdir="$(DESTDIR)@docdir@"
	203	stamp-epub: stamp-epub-docbook
	204	$(STAMP) stamp-epub
	205
	206	doc-epub: stamp-epub
	207
	208	doc-install-epub: doc-epub
	209	test -z ${epubdir} \|\| $(mkinstalldirs) ${epubdir}
	210	$(INSTALL_DATA) ${manual_epub} ${epubdir}
7d8cafcd BK	211
7d8cafcd BK	212
8a165db0	213	# Doxygen configuration
0f752f44	214	# Assumes doxygen, graphviz (with dot), pdflatex installed
03a32789 BK	215	doxygen_script=${top_srcdir}/scripts/run_doxygen
03a32789 BK	216	doxygen_outdir = ${glibcxx_builddir}/doc/doxygen
b25e6b79 BK	217	api_xml = ${doxygen_outdir}/xml/libstdc++-api-single.xml
	218	doxygen_pdf = ${doxygen_outdir}/latex/refman.pdf
	219	api_pdf = ${doxygen_outdir}/pdf/libstdc++-api.pdf
60f8b2e2	220
b25e6b79 BK	221	${doxygen_outdir}/xml:
b25e6b79 BK	222	mkdir -p ${doxygen_outdir}/xml
4312e020	223
b25e6b79 BK	224	${doxygen_outdir}/html:
b25e6b79 BK	225	mkdir -p ${doxygen_outdir}/html
4312e020	226
b25e6b79 BK	227	${doxygen_outdir}/latex:
	228	mkdir -p ${doxygen_outdir}/latex
	229
	230	${doxygen_outdir}/pdf:
	231	mkdir -p ${doxygen_outdir}/pdf
	232
	233	${doxygen_outdir}/man:
	234	mkdir -p ${doxygen_outdir}/man
	235
	236	stamp-xml-doxygen: ${doxygen_outdir}/xml
8a165db0 BK	237	-(srcdir=`cd ${top_srcdir}; ${PWD_COMMAND}`; \
8a165db0 BK	238	builddir=`cd ..; ${PWD_COMMAND}`; \
03a32789	239	${SHELL} ${doxygen_script} \
40e053e3	240	--host_alias=${host_alias} --mode=xml $${srcdir} $${builddir} NO)
b25e6b79	241	$(STAMP) stamp-xml-doxygen
8a165db0	242
b25e6b79	243	stamp-xml-single-doxygen: stamp-xml-doxygen
8a165db0	244	@echo "Generating doxygen xml single file..."
03a32789	245	$(XSLTPROC) ${doxygen_outdir}/xml/combine.xslt \
7d8cafcd	246	${doxygen_outdir}/xml/index.xml > ${api_xml};
b25e6b79 BK	247	$(STAMP) stamp-xml-single-doxygen
	248
	249	stamp-html-doxygen: ${doxygen_outdir}/html
	250	-(srcdir=`cd ${top_srcdir}; ${PWD_COMMAND}`; \
	251	builddir=`cd ..; ${PWD_COMMAND}`; \
	252	${SHELL} ${doxygen_script} \
	253	--host_alias=${host_alias} --mode=html $${srcdir} $${builddir} YES)
	254	$(STAMP) stamp-html-doxygen
4312e020	255
b25e6b79	256	stamp-latex-doxygen: ${doxygen_outdir}/latex
0f752f44 BK	257	-(srcdir=`cd ${top_srcdir}; ${PWD_COMMAND}`; \
	258	builddir=`cd ..; ${PWD_COMMAND}`; \
	259	${SHELL} ${doxygen_script} \
	260	--host_alias=${host_alias} --mode=latex $${srcdir} $${builddir} NO)
b25e6b79	261	$(STAMP) stamp-latex-doxygen
0f752f44	262
5ab3a5af BK	263	# Chance of loooooonnggg creation time on this rule. Iff this fails,
	264	# look at refman.log and see if TeX's memory is exhausted. Symptoms
	265	# include asking a wizard to enlarge capacity. If this is the case,
	266	# find texmf.cnf and add a zero for pool_size, string_vacancies,
	267	# max_strings, and pool_free values.
b25e6b79	268	stamp-pdf-doxygen: stamp-latex-doxygen ${doxygen_outdir}/pdf
0f752f44 BK	269	-(cd ${doxygen_outdir}/latex && $(MAKE) -i pdf;)
	270	echo "Generating doxygen pdf file...";
	271	if [ -f ${doxygen_pdf} ]; then \
5ab3a5af BK	272	mv ${doxygen_pdf} ${api_pdf} ; \
5ab3a5af BK	273	echo ":: PDF file is ${api_pdf}"; \
0f752f44 BK	274	else \
	275	echo "... error"; \
	276	exit 12; \
	277	fi
60f8b2e2 BK	278	$(STAMP) stamp-pdf-doxygen
60f8b2e2 BK	279
b25e6b79 BK	280	stamp-man-doxygen: ${doxygen_outdir}/man
	281	-(srcdir=`cd ${top_srcdir}; ${PWD_COMMAND}`; \
	282	builddir=`cd ..; ${PWD_COMMAND}`; \
	283	${SHELL} ${doxygen_script} \
	284	--host_alias=${host_alias} --mode=man $${srcdir} $${builddir} YES)
	285	$(STAMP) stamp-man-doxygen
	286
	287	doc-xml-doxygen: stamp-xml-doxygen
	288	doc-xml-single-doxygen: stamp-xml-single-doxygen
	289	doc-html-doxygen: stamp-html-doxygen
	290	doc-latex-doxygen: stamp-latex-doxygen
	291	doc-pdf-doxygen: stamp-pdf-doxygen
	292	doc-man-doxygen: stamp-man-doxygen
0f752f44	293
8a165db0 BK	294
	295	# Docbook configuration.
	296	# Assumes
	297	# libxslt
0f752f44 BK	298	# dblatex
0f752f44 BK	299	# pdflatex
8a165db0	300	# docbook-style-xsl
0f752f44	301	# emacs-nxml-mode
03a32789	302	docbook_outdir = ${glibcxx_builddir}/doc/docbook
0f752f44 BK	303	xml_dir = ${glibcxx_srcdir}/doc/xml
	304
	305	xml_sources_basic = \
	306	${xml_dir}/spine.xml \
	307	${xml_dir}/authors.xml \
	308	${xml_dir}/api.xml \
	309	${xml_dir}/faq.xml
	310
	311	xml_sources_manual = \
	312	${xml_dir}/manual/abi.xml \
	313	${xml_dir}/manual/algorithms.xml \
	314	${xml_dir}/manual/allocator.xml \
	315	${xml_dir}/manual/auto_ptr.xml \
	316	${xml_dir}/manual/atomics.xml \
	317	${xml_dir}/manual/backwards_compatibility.xml \
	318	${xml_dir}/manual/bitmap_allocator.xml \
	319	${xml_dir}/manual/build_hacking.xml \
	320	${xml_dir}/manual/codecvt.xml \
	321	${xml_dir}/manual/concurrency.xml \
	322	${xml_dir}/manual/concurrency_extensions.xml \
	323	${xml_dir}/manual/configure.xml \
	324	${xml_dir}/manual/containers.xml \
	325	${xml_dir}/manual/ctype.xml \
	326	${xml_dir}/manual/debug_mode.xml \
	327	${xml_dir}/manual/debug.xml \
	328	${xml_dir}/manual/diagnostics.xml \
d2b0caaa	329	${xml_dir}/manual/documentation_hacking.xml \
0f752f44 BK	330	${xml_dir}/manual/evolution.xml \
	331	${xml_dir}/manual/extensions.xml \
	332	${xml_dir}/manual/internals.xml \
	333	${xml_dir}/manual/intro.xml \
	334	${xml_dir}/manual/io.xml \
	335	${xml_dir}/manual/iterators.xml \
	336	${xml_dir}/manual/locale.xml \
	337	${xml_dir}/manual/localization.xml \
	338	${xml_dir}/manual/messages.xml \
	339	${xml_dir}/manual/mt_allocator.xml \
	340	${xml_dir}/manual/numerics.xml \
	341	${xml_dir}/manual/parallel_mode.xml \
	342	${xml_dir}/manual/prerequisites.xml \
	343	${xml_dir}/manual/profile_mode.xml \
	344	${xml_dir}/manual/shared_ptr.xml \
	345	${xml_dir}/manual/spine.xml \
	346	${xml_dir}/manual/status_cxx1998.xml \
	347	${xml_dir}/manual/status_cxx200x.xml \
	348	${xml_dir}/manual/status_cxxtr1.xml \
	349	${xml_dir}/manual/status_cxxtr24733.xml \
	350	${xml_dir}/manual/strings.xml \
	351	${xml_dir}/manual/support.xml \
	352	${xml_dir}/manual/test.xml \
	353	${xml_dir}/manual/using.xml \
	354	${xml_dir}/manual/using_exceptions.xml \
	355	${xml_dir}/manual/utilities.xml \
	356	${xml_dir}/manual/appendix_free.xml \
	357	${xml_dir}/manual/appendix_contributing.xml \
	358	${xml_dir}/manual/appendix_porting.xml
8a165db0 BK	359
8a165db0 BK	360	xml_sources_extra = \
669b5857	361	${xml_dir}/gnu/fdl-1.3.xml \
60f8b2e2	362	${xml_dir}/gnu/gpl-3.0.xml
0f752f44 BK	363
	364	xml_sources = \
	365	${xml_sources_basic} \
	366	${xml_sources_manual} \
	367	${xml_sources_extra}
8a165db0 BK	368
8a165db0 BK	369	xml_noinst = \
0f752f44 BK	370	${xml_dir}/book.txml \
0f752f44 BK	371	${xml_dir}/chapter.txml \
d2b0caaa BK	372	${xml_dir}/class.txml \
	373	${xml_dir}/images/confdeps.dot \
	374	${xml_dir}/images/confdeps.png \
	375	${xml_dir}/images/confdeps.pdf
8a165db0 BK	376
	377	XSLTPROC = xsltproc
	378	XSLTPROC_FLAGS = --nonet --xinclude
b329dd10 BK	379	#XSL_STYLE_DIR = /usr/share/xml/docbook/stylesheet/docbook-xsl-ns
b329dd10 BK	380	#XSL_STYLE_DIR = /usr/share/sgml/docbook/xsl-ns-stylesheets
8a165db0	381	XSL_FO_STYLE = $(XSL_STYLE_DIR)/fo/docbook.xsl
b25e6b79 BK	382	XSL_HTML_STYLE = $(XSL_STYLE_DIR)/xhtml-1_1/chunk.xsl
	383	XSL_HTML_SINGLE_STYLE = $(XSL_STYLE_DIR)/xhtml-1_1/docbook.xsl
	384	XSL_EPUB_STYLE = $(XSL_STYLE_DIR)/epub/docbook.xsl
	385
	386	${docbook_outdir}/epub:
	387	mkdir -p ${docbook_outdir}/epub
8a165db0	388
547f963b BK	389	${docbook_outdir}/fo:
	390	mkdir -p ${docbook_outdir}/fo
	391
03a32789 BK	392	${docbook_outdir}/html:
03a32789 BK	393	mkdir -p ${docbook_outdir}/html
8a165db0	394
03a32789 BK	395	${docbook_outdir}/pdf:
03a32789 BK	396	mkdir -p ${docbook_outdir}/pdf
8a165db0	397
547f963b BK	398	${docbook_outdir}/texinfo:
547f963b BK	399	mkdir -p ${docbook_outdir}/texinfo
8a165db0	400
03a32789 BK	401	${docbook_outdir}/xml:
03a32789 BK	402	mkdir -p ${docbook_outdir}/xml
8a165db0 BK	403
	404	# Validate existing XML structure.
	405	XMLLINT = xmllint
b329dd10 BK	406	LINT_FLAGS = --debug --xinclude --noent --noblanks --noout
	407	SCHEMA_FLAGS = http://www.docbook.org/xml/5.0/dtd/docbook.dtd
	408	#SCHEMA_FLAGS = --nonet /usr/share/xml/docbook5/schema/dtd/5.0/docbook.dtd
	409	XMLLINT_VALID_FLAGS = $(LINT_FLAGS) --dtdvalid $(SCHEMA_FLAGS)
b25e6b79	410	XMLLINT_FLAGS = --xinclude --nsclean --c14n --noent --noblanks --nocdata
03a32789	411	doc-xml-validate-docbook: $(xml_sources)
8a165db0	412	@echo "Generating XML validation log..."
b25e6b79	413	$(XMLLINT) $(XMLLINT_VALID_FLAGS) ${top_srcdir}/doc/xml/spine.xml
8a165db0	414
547f963b BK	415	# XML, all one page
	416	# Some info on canonicalization
	417	# http://www.mail-archive.com/help-texinfo@gnu.org/msg00864.html
	418	manual_xml = ${docbook_outdir}/xml/libstdc++-manual-single.xml
b25e6b79 BK	419	set_xml = ${docbook_outdir}/xml/libstdc++-set-single.xml
b25e6b79 BK	420	stamp-xml-single-docbook: $(xml_sources) ${docbook_outdir}/xml
8a165db0	421	@echo "Generating XML single..."
b25e6b79 BK	422	$(XMLLINT) $(XMLLINT_FLAGS) \
	423	${top_srcdir}/doc/xml/manual/spine.xml > ${manual_xml};
	424	$(XMLLINT) $(XMLLINT_FLAGS) \
	425	${top_srcdir}/doc/xml/spine.xml > ${set_xml};
	426	if [ ! -d "${docbook_outdir}/xml/images" ]; then \
	427	$(LN_S) ${top_srcdir}/doc/xml/images ${docbook_outdir}/xml/; \
	428	fi
	429	$(STAMP) stamp-xml-single-docbook
	430
	431	doc-xml-single-docbook: stamp-xml-single-docbook
8a165db0 BK	432
8a165db0 BK	433	# HTML, index plus chapters
b25e6b79	434	stamp-html-docbook: $(xml_sources) ${docbook_outdir}/html
8a165db0	435	@echo "Generating html files..."
03a32789	436	$(XSLTPROC) $(XSLTPROC_FLAGS) -o ${docbook_outdir}/html/ \
8a165db0	437	$(XSL_HTML_STYLE) ${top_srcdir}/doc/xml/spine.xml
b25e6b79 BK	438	$(STAMP) stamp-html-docbook
	439
	440	doc-html-docbook: stamp-html-docbook
8a165db0 BK	441
8a165db0 BK	442	# HTML, all one page
5bca11c4	443	manual_html = ${docbook_outdir}/html/libstdc++-manual-single.html
b25e6b79	444	stamp-html-single-docbook: $(xml_sources) ${docbook_outdir}/html
8a165db0	445	@echo "Generating html single file..."
5bca11c4	446	$(XSLTPROC) $(XSLTPROC_FLAGS) -o ${manual_html} \
8a165db0	447	$(XSL_HTML_SINGLE_STYLE) ${top_srcdir}/doc/xml/spine.xml
b25e6b79 BK	448	$(STAMP) stamp-html-single-docbook
	449
	450	doc-html-single-docbook: stamp-html-single-docbook
8a165db0 BK	451
8a165db0 BK	452	# FO
b25e6b79	453	stamp-fo-docbook: $(xml_sources) ${docbook_outdir}/fo
8a165db0	454	@echo "Generating FO files..."
03a32789	455	$(XSLTPROC) $(XSLTPROC_FLAGS) -o ${docbook_outdir}/fo/spine.fo \
8a165db0	456	$(XSL_FO_STYLE) ${top_srcdir}/doc/xml/spine.xml
b25e6b79 BK	457	$(STAMP) stamp-fo-docbook
	458
	459	doc-fo-docbook: stamp-fo-docbook
8a165db0	460
5bca11c4 BK	461	# PDF, via dblatex
	462	manual_pdf = ${docbook_outdir}/pdf/libstdc++-manual.pdf
	463	DBLATEX_FLAGS = --dump --verbose --pdf -o ${manual_pdf}
b25e6b79	464	stamp-pdf-docbook: $(xml_sources) ${docbook_outdir}/pdf
40e053e3 BK	465	@echo "Generating pdf dblatex files..."
40e053e3 BK	466	dblatex $(DBLATEX_FLAGS) ${top_srcdir}/doc/xml/spine.xml
b25e6b79 BK	467	$(STAMP) stamp-pdf-docbook
	468
	469	doc-pdf-docbook: stamp-pdf-docbook
40e053e3	470
b25e6b79 BK	471	# TEXINFO, via docbook2X
	472	# NB: Both experimental and tempermental
	473	manual_texi = ${docbook_outdir}/texinfo/libstdc++-manual.texi
	474	manual_info = ${docbook_outdir}/texinfo/libstdc++-manual.info
547f963b BK	475	DB2TEXI_FLAGS = \
	476	--encoding=utf-8//TRANSLIT \
	477	--string-param output-file="libstdc++-manual" \
	478	--string-param directory-category="GNU C++ Library" \
7d8cafcd	479	--string-param explicit-node-names=true
b25e6b79 BK	480
b25e6b79 BK	481	stamp-texinfo-docbook: stamp-xml-single-docbook ${docbook_outdir}/texinfo
547f963b	482	@echo "Generating texinfo files..."
b25e6b79 BK	483	db2x_docbook2texi $(DB2TEXI_FLAGS) ${set_xml}
	484	mv libstdc++-manual.texi ${manual_texi}
	485	$(STAMP) stamp-texinfo-docbook
	486
	487	stamp-info-docbook: stamp-texinfo-docbook
	488	@echo "Generating info files..."
	489	$(MAKEINFO) $(MAKEINFOFLAGS) ${manual_texi}
	490	$(STAMP) stamp-info-docbook
	491
	492	doc-texinfo-docbook: stamp-texinfo-docbook
	493
	494	doc-info-docbook: stamp-info-docbook
	495
	496	# EPUB, via dbtoepub + ruby
	497	manual_epub = ${docbook_outdir}/epub/libstdc++-manual.epub
	498	stamp-epub-docbook: stamp-xml-single-docbook ${docbook_outdir}/epub
	499	@echo "Generating epub files..."
	500	${XSL_STYLE_DIR}/epub/bin/dbtoepub -v -d -o ${manual_epub} ${set_xml}
	501	$(STAMP) stamp-epub-docbook
	502
	503	doc-epub-docbook: stamp-epub-docbook
547f963b	504
8a165db0	505
03a32789 BK	506	# Performance doc and graph configuration.
	507	# Assumes pychart, beautiful soup installed.
	508	# Generates the plots and graphs for performance testing.
	509	doc_performance_script=${top_srcdir}/scripts/make_graphs.py
	510	doc-html-performance:
	511	-@(chmod + ${doc_performance_script}; \
	512	${doc_performance_script} ${top_srcdir} \
	513	${glibcxx_builddir}/testsuite \
	514	${top_srcdir}/testsuite/data/make_graph_htmls.xml \
	515	${top_srcdir}/testsuite/data/make_graph_test_infos.xml local g++)
	516
60f8b2e2	517
c4e82de9	518	.PHONY: doc-doxygen-html doc-doxygen-man doc-performance
4312e020 BK	519
4312e020 BK	520	# By adding these files here, automake will remove them for 'make clean'
b25e6b79	521	CLEANFILES = .log stamp
4312e020 BK	522
	523	# To remove directories.
	524	clean-local:
b25e6b79	525	rm -rf man html pdf fo xml doxygen docbook ./libstdc++-* db2t*