OSDN Git Service

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