]> git.ipfire.org Git - thirdparty/gcc.git/blame - libstdc++-v3/doc/Makefile.am
Daily bump.
[thirdparty/gcc.git] / libstdc++-v3 / doc / Makefile.am
CommitLineData
4312e020
BK
1## Makefile for the doc subdirectory of the GNU C++ Standard library.
2##
40e053e3 3## Copyright (C) 2008, 2009, 2010 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
21## <http://www.gnu.org/licenses/>.
4312e020
BK
22
23include $(top_srcdir)/fragment.am
24
8a165db0
BK
25
26# Doxygen configuration
27# Assumes doxygen, graphviz (with dot) installed
28doc_doxygen_script=${top_srcdir}/scripts/run_doxygen
29doc-html-doxygen:
4312e020
BK
30 -(srcdir=`cd ${top_srcdir}; ${PWD_COMMAND}`; \
31 builddir=`cd ..; ${PWD_COMMAND}`; \
8a165db0 32 ${SHELL} ${doc_doxygen_script} \
40e053e3 33 --host_alias=${host_alias} --mode=html $${srcdir} $${builddir} YES)
4312e020 34
8a165db0 35doc-man-doxygen:
4312e020
BK
36 -(srcdir=`cd ${top_srcdir}; ${PWD_COMMAND}`; \
37 builddir=`cd ..; ${PWD_COMMAND}`; \
8a165db0 38 ${SHELL} ${doc_doxygen_script} \
40e053e3 39 --host_alias=${host_alias} --mode=man $${srcdir} $${builddir} YES)
4312e020 40
8a165db0
BK
41doc-xml-doxygen:
42 -(srcdir=`cd ${top_srcdir}; ${PWD_COMMAND}`; \
43 builddir=`cd ..; ${PWD_COMMAND}`; \
44 ${SHELL} ${doc_doxygen_script} \
40e053e3 45 --host_alias=${host_alias} --mode=xml $${srcdir} $${builddir} NO)
8a165db0
BK
46
47doxygen_xmldir = ${glibcxx_builddir}/doc/doxygen/xml
48doc-xml-doxygen-single: doc-xml-doxygen
49 @echo "Generating doxygen xml single file..."
50 $(XSLTPROC) ${doxygen_xmldir}/combine.xslt ${doxygen_xmldir}/spine.xml > ${doxygen_xmldir}/all.xml;
51
52
53# Performance doc and graph configuration.
54# Assumes pychart, beautiful soup installed.
4312e020
BK
55# Generates the plots and graphs for performance testing.
56doc_performance_script=${top_srcdir}/scripts/make_graphs.py
8a165db0 57doc-html-performance:
4312e020
BK
58 -@(chmod + ${doc_performance_script}; \
59 ${doc_performance_script} ${top_srcdir} \
60 ${glibcxx_builddir}/testsuite \
61 ${top_srcdir}/testsuite/data/make_graph_htmls.xml \
62 ${top_srcdir}/testsuite/data/make_graph_test_infos.xml local g++)
63
8a165db0
BK
64
65# Docbook configuration.
66# Assumes
67# libxslt
68# docbook-style-xsl
69# emacs-nxml-mode
70# xmlto passivetex
71xml_srcdir = ${glibcxx_srcdir}/doc/xml
72xml_sources = \
73 ${xml_srcdir}/spine.xml \
74 ${xml_srcdir}/authors.xml \
8a165db0
BK
75 ${xml_srcdir}/manual/abi.xml \
76 ${xml_srcdir}/manual/algorithms.xml \
77 ${xml_srcdir}/manual/allocator.xml \
78 ${xml_srcdir}/manual/auto_ptr.xml \
79 ${xml_srcdir}/manual/backwards_compatibility.xml \
80 ${xml_srcdir}/manual/bitmap_allocator.xml \
8a165db0
BK
81 ${xml_srcdir}/manual/build_hacking.xml \
82 ${xml_srcdir}/manual/codecvt.xml \
d8a06a82 83 ${xml_srcdir}/manual/concurrency_extensions.xml \
8a165db0
BK
84 ${xml_srcdir}/manual/configure.xml \
85 ${xml_srcdir}/manual/containers.xml \
86 ${xml_srcdir}/manual/ctype.xml \
87 ${xml_srcdir}/manual/debug_mode.xml \
88 ${xml_srcdir}/manual/debug.xml \
89 ${xml_srcdir}/manual/diagnostics.xml \
90 ${xml_srcdir}/manual/evolution.xml \
91 ${xml_srcdir}/manual/extensions.xml \
92 ${xml_srcdir}/manual/internals.xml \
93 ${xml_srcdir}/manual/intro.xml \
94 ${xml_srcdir}/manual/io.xml \
95 ${xml_srcdir}/manual/iterators.xml \
96 ${xml_srcdir}/manual/locale.xml \
97 ${xml_srcdir}/manual/localization.xml \
98 ${xml_srcdir}/manual/messages.xml \
99 ${xml_srcdir}/manual/mt_allocator.xml \
100 ${xml_srcdir}/manual/numerics.xml \
101 ${xml_srcdir}/manual/parallel_mode.xml \
41061822 102 ${xml_srcdir}/manual/prerequisites.xml \
1218d701 103 ${xml_srcdir}/manual/profile_mode.xml \
8a165db0
BK
104 ${xml_srcdir}/manual/internals.xml \
105 ${xml_srcdir}/manual/shared_ptr.xml \
106 ${xml_srcdir}/manual/spine.xml \
107 ${xml_srcdir}/manual/status_cxx1998.xml \
108 ${xml_srcdir}/manual/status_cxx200x.xml \
109 ${xml_srcdir}/manual/status_cxxtr1.xml \
4cdc8761 110 ${xml_srcdir}/manual/status_cxxtr24733.xml \
8a165db0
BK
111 ${xml_srcdir}/manual/strings.xml \
112 ${xml_srcdir}/manual/support.xml \
113 ${xml_srcdir}/manual/test.xml \
114 ${xml_srcdir}/manual/using.xml \
115 ${xml_srcdir}/manual/utilities.xml \
116 ${xml_srcdir}/manual/appendix_free.xml \
117 ${xml_srcdir}/manual/appendix_contributing.xml \
118 ${xml_srcdir}/manual/appendix_porting.xml \
119 ${xml_srcdir}/api.xml \
120 ${xml_srcdir}/faq.xml
121
122xml_sources_extra = \
123 ${xml_srcdir}/gnu/fdl-1.2.xml \
124 ${xml_srcdir}/gnu/gpl-2.0.xml
125
126xml_noinst = \
127 ${xml_srcdir}/book.txml \
128 ${xml_srcdir}/chapter.txml \
129 ${xml_srcdir}/class.txml
130
131
132XSLTPROC = xsltproc
133XSLTPROC_FLAGS = --nonet --xinclude
134XSL_STYLE_DIR = /usr/share/sgml/docbook/xsl-stylesheets
135XSL_FO_STYLE = $(XSL_STYLE_DIR)/fo/docbook.xsl
136XSL_HTML_STYLE = $(XSL_STYLE_DIR)/xhtml/chunk.xsl
137#XSL_HTML_SINGLE_STYLE = $(XSL_STYLE_DIR)/xhtml/onechunk.xsl
138XSL_HTML_SINGLE_STYLE = $(XSL_STYLE_DIR)/xhtml/docbook.xsl
139
140${glibcxx_builddir}/doc/html:
141 mkdir ${glibcxx_builddir}/doc/html
142
143${glibcxx_builddir}/doc/pdf:
144 mkdir ${glibcxx_builddir}/doc/pdf
145
146${glibcxx_builddir}/doc/fo:
147 mkdir ${glibcxx_builddir}/doc/fo
148
149${glibcxx_builddir}/doc/xml:
150 mkdir ${glibcxx_builddir}/doc/xml
151
152# Validate existing XML structure.
153XMLLINT = xmllint
154#LINT_FLAGS = --debug --nonet --xinclude --nsclean --postvalid --nowarning
155#LINT_FLAGS = --noblanks --noout --xinclude --postvalid --noent
156LINT_FLAGS = --postvalid --debug --xinclude --noent --noblanks --nonet --noout
157VALID_FLAGS = --dtdvalid http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd
158XMLLINT_FLAGS = $(LINT_FLAGS) $(VALID_FLAGS)
159doc-xml-validate: $(xml_sources)
160 @echo "Generating XML validation log..."
161 $(XMLLINT) $(XMLLINT_FLAGS) ${top_srcdir}/doc/xml/spine.xml
162
163doc-xml-single: $(xml_sources) ${glibcxx_builddir}/doc/xml
164 @echo "Generating XML single..."
165 $(XMLLINT) --xinclude --noent --noblanks \
166 -o ${glibcxx_builddir}/doc/xml/spine-single.xml \
167 ${top_srcdir}/doc/xml/spine.xml
168
169# HTML, index plus chapters
170doc-html: $(xml_sources) ${glibcxx_builddir}/doc/html
171 @echo "Generating html files..."
172 $(XSLTPROC) $(XSLTPROC_FLAGS) -o ${glibcxx_builddir}/doc/html/ \
173 $(XSL_HTML_STYLE) ${top_srcdir}/doc/xml/spine.xml
174
175# HTML, all one page
176doc-html-single: $(xml_sources) ${glibcxx_builddir}/doc/html
177 @echo "Generating html single file..."
178 $(XSLTPROC) $(XSLTPROC_FLAGS) -o ${glibcxx_builddir}/doc/html/ \
179 $(XSL_HTML_SINGLE_STYLE) ${top_srcdir}/doc/xml/spine.xml
180
181# FO
182doc-fo: $(xml_sources) ${glibcxx_builddir}/doc/fo
183 @echo "Generating FO files..."
184 $(XSLTPROC) $(XSLTPROC_FLAGS) -o ${glibcxx_builddir}/doc/fo/spine.fo \
185 $(XSL_FO_STYLE) ${top_srcdir}/doc/xml/spine.xml
186
187# PDF
188# Points to current best xml to PDF generation process.
40e053e3 189doc-pdf: doc-pdf-dblatex
8a165db0
BK
190
191# PDF 1
192# fop
193FOP = fop
194FOP_FLAGS = -d -r
195doc-pdf-fop-xml: $(xml_sources) ${glibcxx_builddir}/doc/pdf
196 @echo "Generating pdf fop files from xml..."
197 $(FOP) $(FOP_FLAGS) -xml ${top_srcdir}/doc/xml/spine.xml \
198 -xsl $(XSL_FO_STYLE) -pdf ${glibcxx_builddir}/doc/pdf/spine.pdf
199
200doc-pdf-fop-fo: $(xml_sources) ${glibcxx_builddir}/doc/pdf doc-fo
201 @echo "Generating pdf fop files from fo..."
202 $(FOP) $(FOP_FLAGS) -fo ${glibcxx_builddir}/doc/fo/spine.fo \
203 -pdf ${glibcxx_builddir}/doc/pdf/spine.pdf
204
205# PDF 2
206# xmlto
207XML2PDF = xmlto
208XML2PDF_FLAGS = -v pdf --skip-validation -o pdf
209doc-pdf-xmlto: $(xml_sources) ${glibcxx_builddir}/doc/pdf
210 @echo "Generating pdf xmlto files..."
211 $(XML2PDF) $(XML2PDF_FLAGS) ${top_srcdir}/doc/xml/spine.xml
212
213# PDF 3
214# xmlroff
215XMLROFF = xmlroff
216XMLROFF_FLAGS = --format=pdf --backend=cairo --warn=1 --debug=1 --continue
217doc-pdf-xmlroff: $(xml_sources) doc-fo
218 @echo "Generating pdf xmlroff files..."
219 $(XMLROFF) $(XMLROFF_FLAGS) ${glibcxx_builddir}/doc/fo/spine.fo
220
221# PDF 4
222# prince
223PRINCE = prince
224PRINCE_FLAGS = --log prince.log -o pdf/spine.pdf
225doc-pdf-prince: $(xml_sources) ${glibcxx_builddir}/doc/pdf
226 @echo "Generating pdf prince files..."
227 $(PRINCE) $(PRINCE_FLAGS) ${top_srcdir}/doc/xml/spine.xml
228
40e053e3
BK
229# PDF 5
230# dblatex
09d6794b 231DBLATEX_FLAGS = --dump --verbose --pdf -o pdf/manual.pdf
40e053e3
BK
232doc-pdf-dblatex: $(xml_sources) ${glibcxx_builddir}/doc/pdf
233 @echo "Generating pdf dblatex files..."
234 dblatex $(DBLATEX_FLAGS) ${top_srcdir}/doc/xml/spine.xml
235
8a165db0 236
c4e82de9 237.PHONY: doc-doxygen-html doc-doxygen-man doc-performance
4312e020
BK
238
239# By adding these files here, automake will remove them for 'make clean'
8a165db0 240CLEANFILES = *.log
4312e020
BK
241
242# To remove directories.
243clean-local:
8a165db0 244 rm -rf man html pdf fo doxygen xml