1 ## Makefile for the doc subdirectory of the GNU C++ Standard library.
3 ## Copyright (C) 2008, 2009, 2010 Free Software Foundation, Inc.
5 ## This file is part of the libstdc++ version 3 distribution.
6 ## Process this file with automake to produce Makefile.in.
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)
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.
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/>.
23 include $(top_srcdir)/fragment.am
25 # Documentation Overview
27 # There are two main input materials for libstdc++ documentation.
28 # The first is the doxygen markup in libstdc++ sources, which is a
29 # reference to the API. And the second is the manual, via docbook markup in
32 # A third and more obscure option deals with charting performance
33 # tests, and should be considered experimental.
35 # Documentation conditionals for output.
38 STAMP_INSTALL_XML = doc-install-xml
46 STAMP_INSTALL_HTML = doc-install-html
54 STAMP_INSTALL_MAN = doc-install-man
62 STAMP_INSTALL_PDF = doc-install-pdf
70 STAMP_INSTALL_EPUB = doc-install-epub
73 STAMP_INSTALL_EPUB = doc-install-epub
76 # Documentation primary rules.
96 install-xml: $(STAMP_INSTALL_XML)
99 install-html: $(STAMP_INSTALL_HTML)
102 install-man: $(STAMP_INSTALL_MAN)
105 install-pdf: $(STAMP_INSTALL_PDF)
108 install-epub: $(STAMP_INSTALL_EPUB)
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
126 xmldir="$(DESTDIR)@docdir@"
127 stamp-xml: stamp-xml-single-docbook stamp-xml-single-doxygen
132 doc-install-xml: doc-xml
133 test -z ${xmldir} || $(mkinstalldirs) ${xmldir}
134 $(INSTALL_DATA) ${manual_xml} ${xmldir}
135 $(INSTALL_DATA) ${api_xml} ${xmldir}
138 htmldir="$(DESTDIR)@docdir@"
139 stamp-html: stamp-html-docbook stamp-html-doxygen
144 doc-install-html: doc-html
145 test -z ${htmldir} || $(mkinstalldirs) ${htmldir}
146 cp -r ${docbook_outdir}/html ${htmldir}/libstdc++-manual.html;
147 cp -r ${doxygen_outdir}/html ${htmldir}/libstdc++-api.html;
150 pdfdir="$(DESTDIR)@docdir@"
151 stamp-pdf: stamp-pdf-docbook stamp-pdf-doxygen
156 doc-install-pdf: doc-pdf
157 test -z ${pdfdir} || $(mkinstalldirs) ${pdfdir}
158 $(INSTALL_DATA) ${docbook_outdir}/pdf/libstdc++-manual.pdf ${pdfdir}
159 $(INSTALL_DATA) ${doxygen_outdir}/pdf/libstdc++-api.pdf ${pdfdir}
162 mandir="$(DESTDIR)@mandir@"
163 stamp-man: stamp-man-doxygen
168 doc-install-man: doc-man
169 test -z ${mandir} || $(mkinstalldirs) ${mandir}
170 cp -r ${doxygen_outdir}/man/man3 ${mandir}
173 infodir="$(DESTDIR)@infodir@"
174 stamp-texinfo: stamp-texinfo-docbook
175 $(STAMP) stamp-texinfo
177 stamp-info: stamp-info-docbook
180 doc-texinfo: stamp-texinfo
184 doc-install-texinfo: doc-texinfo
185 test -z ${infodir} || $(mkinstalldirs) ${infodir}
186 $(INSTALL_DATA) ${manual_texi} ${infodir}
188 doc-install-info: doc-info
189 test -z ${infodir} || $(mkinstalldirs) ${infodir}
190 $(INSTALL_DATA) ${manual_info} ${infodir}
193 # Assumes ruby installed
194 epubdir="$(DESTDIR)@docdir@"
195 stamp-epub: stamp-epub-docbook
200 doc-install-epub: doc-epub
201 test -z ${epubdir} || $(mkinstalldirs) ${epubdir}
202 $(INSTALL_DATA) ${manual_epub} ${epubdir}
205 # Doxygen configuration
206 # Assumes doxygen, graphviz (with dot), pdflatex installed
207 doxygen_script=${top_srcdir}/scripts/run_doxygen
208 doxygen_outdir = ${glibcxx_builddir}/doc/doxygen
209 api_xml = ${doxygen_outdir}/xml/libstdc++-api-single.xml
210 doxygen_pdf = ${doxygen_outdir}/latex/refman.pdf
211 api_pdf = ${doxygen_outdir}/pdf/libstdc++-api.pdf
213 ${doxygen_outdir}/xml:
214 mkdir -p ${doxygen_outdir}/xml
216 ${doxygen_outdir}/html:
217 mkdir -p ${doxygen_outdir}/html
219 ${doxygen_outdir}/latex:
220 mkdir -p ${doxygen_outdir}/latex
222 ${doxygen_outdir}/pdf:
223 mkdir -p ${doxygen_outdir}/pdf
225 ${doxygen_outdir}/man:
226 mkdir -p ${doxygen_outdir}/man
228 stamp-xml-doxygen: ${doxygen_outdir}/xml
229 -(srcdir=`cd ${top_srcdir}; ${PWD_COMMAND}`; \
230 builddir=`cd ..; ${PWD_COMMAND}`; \
231 ${SHELL} ${doxygen_script} \
232 --host_alias=${host_alias} --mode=xml $${srcdir} $${builddir} NO)
233 $(STAMP) stamp-xml-doxygen
235 stamp-xml-single-doxygen: stamp-xml-doxygen
236 @echo "Generating doxygen xml single file..."
237 $(XSLTPROC) ${doxygen_outdir}/xml/combine.xslt \
238 ${doxygen_outdir}/xml/index.xml > ${api_xml};
239 $(STAMP) stamp-xml-single-doxygen
241 stamp-html-doxygen: ${doxygen_outdir}/html
242 -(srcdir=`cd ${top_srcdir}; ${PWD_COMMAND}`; \
243 builddir=`cd ..; ${PWD_COMMAND}`; \
244 ${SHELL} ${doxygen_script} \
245 --host_alias=${host_alias} --mode=html $${srcdir} $${builddir} YES)
246 $(STAMP) stamp-html-doxygen
248 stamp-latex-doxygen: ${doxygen_outdir}/latex
249 -(srcdir=`cd ${top_srcdir}; ${PWD_COMMAND}`; \
250 builddir=`cd ..; ${PWD_COMMAND}`; \
251 ${SHELL} ${doxygen_script} \
252 --host_alias=${host_alias} --mode=latex $${srcdir} $${builddir} NO)
253 $(STAMP) stamp-latex-doxygen
255 # Chance of loooooonnggg creation time on this rule. Iff this fails,
256 # look at refman.log and see if TeX's memory is exhausted. Symptoms
257 # include asking a wizard to enlarge capacity. If this is the case,
258 # find texmf.cnf and add a zero for pool_size, string_vacancies,
259 # max_strings, and pool_free values.
260 stamp-pdf-doxygen: stamp-latex-doxygen ${doxygen_outdir}/pdf
261 -(cd ${doxygen_outdir}/latex && $(MAKE) -i pdf;)
262 echo "Generating doxygen pdf file...";
263 if [ -f ${doxygen_pdf} ]; then \
264 mv ${doxygen_pdf} ${api_pdf} ; \
265 echo ":: PDF file is ${api_pdf}"; \
270 $(STAMP) stamp-pdf-doxygen
272 stamp-man-doxygen: ${doxygen_outdir}/man
273 -(srcdir=`cd ${top_srcdir}; ${PWD_COMMAND}`; \
274 builddir=`cd ..; ${PWD_COMMAND}`; \
275 ${SHELL} ${doxygen_script} \
276 --host_alias=${host_alias} --mode=man $${srcdir} $${builddir} YES)
277 $(STAMP) stamp-man-doxygen
279 doc-xml-doxygen: stamp-xml-doxygen
280 doc-xml-single-doxygen: stamp-xml-single-doxygen
281 doc-html-doxygen: stamp-html-doxygen
282 doc-latex-doxygen: stamp-latex-doxygen
283 doc-pdf-doxygen: stamp-pdf-doxygen
284 doc-man-doxygen: stamp-man-doxygen
287 # Docbook configuration.
294 docbook_outdir = ${glibcxx_builddir}/doc/docbook
295 xml_dir = ${glibcxx_srcdir}/doc/xml
297 xml_sources_basic = \
298 ${xml_dir}/spine.xml \
299 ${xml_dir}/authors.xml \
303 xml_sources_manual = \
304 ${xml_dir}/manual/abi.xml \
305 ${xml_dir}/manual/algorithms.xml \
306 ${xml_dir}/manual/allocator.xml \
307 ${xml_dir}/manual/auto_ptr.xml \
308 ${xml_dir}/manual/atomics.xml \
309 ${xml_dir}/manual/backwards_compatibility.xml \
310 ${xml_dir}/manual/bitmap_allocator.xml \
311 ${xml_dir}/manual/build_hacking.xml \
312 ${xml_dir}/manual/codecvt.xml \
313 ${xml_dir}/manual/concurrency.xml \
314 ${xml_dir}/manual/concurrency_extensions.xml \
315 ${xml_dir}/manual/configure.xml \
316 ${xml_dir}/manual/containers.xml \
317 ${xml_dir}/manual/ctype.xml \
318 ${xml_dir}/manual/debug_mode.xml \
319 ${xml_dir}/manual/debug.xml \
320 ${xml_dir}/manual/diagnostics.xml \
321 ${xml_dir}/manual/evolution.xml \
322 ${xml_dir}/manual/extensions.xml \
323 ${xml_dir}/manual/internals.xml \
324 ${xml_dir}/manual/intro.xml \
325 ${xml_dir}/manual/io.xml \
326 ${xml_dir}/manual/iterators.xml \
327 ${xml_dir}/manual/locale.xml \
328 ${xml_dir}/manual/localization.xml \
329 ${xml_dir}/manual/messages.xml \
330 ${xml_dir}/manual/mt_allocator.xml \
331 ${xml_dir}/manual/numerics.xml \
332 ${xml_dir}/manual/parallel_mode.xml \
333 ${xml_dir}/manual/prerequisites.xml \
334 ${xml_dir}/manual/profile_mode.xml \
335 ${xml_dir}/manual/shared_ptr.xml \
336 ${xml_dir}/manual/spine.xml \
337 ${xml_dir}/manual/status_cxx1998.xml \
338 ${xml_dir}/manual/status_cxx200x.xml \
339 ${xml_dir}/manual/status_cxxtr1.xml \
340 ${xml_dir}/manual/status_cxxtr24733.xml \
341 ${xml_dir}/manual/strings.xml \
342 ${xml_dir}/manual/support.xml \
343 ${xml_dir}/manual/test.xml \
344 ${xml_dir}/manual/using.xml \
345 ${xml_dir}/manual/using_exceptions.xml \
346 ${xml_dir}/manual/utilities.xml \
347 ${xml_dir}/manual/appendix_free.xml \
348 ${xml_dir}/manual/appendix_contributing.xml \
349 ${xml_dir}/manual/appendix_porting.xml
351 xml_sources_extra = \
352 ${xml_dir}/gnu/fdl-1.3.xml \
353 ${xml_dir}/gnu/gpl-3.0.xml
356 ${xml_sources_basic} \
357 ${xml_sources_manual} \
361 ${xml_dir}/book.txml \
362 ${xml_dir}/chapter.txml \
363 ${xml_dir}/class.txml
366 XSLTPROC_FLAGS = --nonet --xinclude
367 #XSL_STYLE_DIR = /usr/share/sgml/docbook/xsl-stylesheets
368 XSL_STYLE_DIR = /usr/share/sgml/docbook/xsl-ns-stylesheets
369 XSL_FO_STYLE = $(XSL_STYLE_DIR)/fo/docbook.xsl
370 #XSL_HTML_STYLE = $(XSL_STYLE_DIR)/xhtml/chunk.xsl
371 #XSL_HTML_SINGLE_STYLE = $(XSL_STYLE_DIR)/xhtml/onechunk.xsl
372 #XSL_HTML_SINGLE_STYLE = $(XSL_STYLE_DIR)/xhtml/docbook.xsl
373 XSL_HTML_STYLE = $(XSL_STYLE_DIR)/xhtml-1_1/chunk.xsl
374 XSL_HTML_SINGLE_STYLE = $(XSL_STYLE_DIR)/xhtml-1_1/docbook.xsl
375 XSL_EPUB_STYLE = $(XSL_STYLE_DIR)/epub/docbook.xsl
377 ${docbook_outdir}/epub:
378 mkdir -p ${docbook_outdir}/epub
380 ${docbook_outdir}/fo:
381 mkdir -p ${docbook_outdir}/fo
383 ${docbook_outdir}/html:
384 mkdir -p ${docbook_outdir}/html
386 ${docbook_outdir}/pdf:
387 mkdir -p ${docbook_outdir}/pdf
389 ${docbook_outdir}/texinfo:
390 mkdir -p ${docbook_outdir}/texinfo
392 ${docbook_outdir}/xml:
393 mkdir -p ${docbook_outdir}/xml
395 # Validate existing XML structure.
397 #LINT_FLAGS = --debug --xinclude --nsclean --postvalid --nowarning --nonet
398 #LINT_FLAGS = --xinclude --postvalid --noent --noblanks --noout
399 LINT_FLAGS = --debug --xinclude --noent --noblanks --nonet --noout
400 #SCHEMA_FLAGS = --relaxng /usr/share/xml/docbook5/schema/rng/5.0/docbookxi.rng
401 SCHEMA_FLAGS = --dtdvalid /usr/share/xml/docbook5/schema/dtd/5.0/docbook.dtd
402 XMLLINT_FLAGS = --xinclude --nsclean --c14n --noent --noblanks --nocdata
403 XMLLINT_VALID_FLAGS = $(LINT_FLAGS) $(SCHEMA_FLAGS)
404 doc-xml-validate-docbook: $(xml_sources)
405 @echo "Generating XML validation log..."
406 $(XMLLINT) $(XMLLINT_VALID_FLAGS) ${top_srcdir}/doc/xml/spine.xml
409 # Some info on canonicalization
410 # http://www.mail-archive.com/help-texinfo@gnu.org/msg00864.html
411 manual_xml = ${docbook_outdir}/xml/libstdc++-manual-single.xml
412 set_xml = ${docbook_outdir}/xml/libstdc++-set-single.xml
413 stamp-xml-single-docbook: $(xml_sources) ${docbook_outdir}/xml
414 @echo "Generating XML single..."
415 $(XMLLINT) $(XMLLINT_FLAGS) \
416 ${top_srcdir}/doc/xml/manual/spine.xml > ${manual_xml};
417 $(XMLLINT) $(XMLLINT_FLAGS) \
418 ${top_srcdir}/doc/xml/spine.xml > ${set_xml};
419 if [ ! -d "${docbook_outdir}/xml/images" ]; then \
420 $(LN_S) ${top_srcdir}/doc/xml/images ${docbook_outdir}/xml/; \
422 $(STAMP) stamp-xml-single-docbook
424 doc-xml-single-docbook: stamp-xml-single-docbook
426 # HTML, index plus chapters
427 stamp-html-docbook: $(xml_sources) ${docbook_outdir}/html
428 @echo "Generating html files..."
429 $(XSLTPROC) $(XSLTPROC_FLAGS) -o ${docbook_outdir}/html/ \
430 $(XSL_HTML_STYLE) ${top_srcdir}/doc/xml/spine.xml
431 $(STAMP) stamp-html-docbook
433 doc-html-docbook: stamp-html-docbook
436 manual_html = ${docbook_outdir}/html/libstdc++-manual-single.html
437 stamp-html-single-docbook: $(xml_sources) ${docbook_outdir}/html
438 @echo "Generating html single file..."
439 $(XSLTPROC) $(XSLTPROC_FLAGS) -o ${manual_html} \
440 $(XSL_HTML_SINGLE_STYLE) ${top_srcdir}/doc/xml/spine.xml
441 $(STAMP) stamp-html-single-docbook
443 doc-html-single-docbook: stamp-html-single-docbook
446 stamp-fo-docbook: $(xml_sources) ${docbook_outdir}/fo
447 @echo "Generating FO files..."
448 $(XSLTPROC) $(XSLTPROC_FLAGS) -o ${docbook_outdir}/fo/spine.fo \
449 $(XSL_FO_STYLE) ${top_srcdir}/doc/xml/spine.xml
450 $(STAMP) stamp-fo-docbook
452 doc-fo-docbook: stamp-fo-docbook
455 manual_pdf = ${docbook_outdir}/pdf/libstdc++-manual.pdf
456 DBLATEX_FLAGS = --dump --verbose --pdf -o ${manual_pdf}
457 stamp-pdf-docbook: $(xml_sources) ${docbook_outdir}/pdf
458 @echo "Generating pdf dblatex files..."
459 dblatex $(DBLATEX_FLAGS) ${top_srcdir}/doc/xml/spine.xml
460 $(STAMP) stamp-pdf-docbook
462 doc-pdf-docbook: stamp-pdf-docbook
464 # TEXINFO, via docbook2X
465 # NB: Both experimental and tempermental
466 manual_texi = ${docbook_outdir}/texinfo/libstdc++-manual.texi
467 manual_info = ${docbook_outdir}/texinfo/libstdc++-manual.info
469 --encoding=utf-8//TRANSLIT \
470 --string-param output-file="libstdc++-manual" \
471 --string-param directory-category="GNU C++ Library" \
472 --string-param explicit-node-names=true
474 stamp-texinfo-docbook: stamp-xml-single-docbook ${docbook_outdir}/texinfo
475 @echo "Generating texinfo files..."
476 db2x_docbook2texi $(DB2TEXI_FLAGS) ${set_xml}
477 mv libstdc++-manual.texi ${manual_texi}
478 $(STAMP) stamp-texinfo-docbook
480 stamp-info-docbook: stamp-texinfo-docbook
481 @echo "Generating info files..."
482 $(MAKEINFO) $(MAKEINFOFLAGS) ${manual_texi}
483 $(STAMP) stamp-info-docbook
485 doc-texinfo-docbook: stamp-texinfo-docbook
487 doc-info-docbook: stamp-info-docbook
489 # EPUB, via dbtoepub + ruby
490 manual_epub = ${docbook_outdir}/epub/libstdc++-manual.epub
491 stamp-epub-docbook: stamp-xml-single-docbook ${docbook_outdir}/epub
492 @echo "Generating epub files..."
493 ${XSL_STYLE_DIR}/epub/bin/dbtoepub -v -d -o ${manual_epub} ${set_xml}
494 $(STAMP) stamp-epub-docbook
496 doc-epub-docbook: stamp-epub-docbook
499 # Performance doc and graph configuration.
500 # Assumes pychart, beautiful soup installed.
501 # Generates the plots and graphs for performance testing.
502 doc_performance_script=${top_srcdir}/scripts/make_graphs.py
503 doc-html-performance:
504 -@(chmod + ${doc_performance_script}; \
505 ${doc_performance_script} ${top_srcdir} \
506 ${glibcxx_builddir}/testsuite \
507 ${top_srcdir}/testsuite/data/make_graph_htmls.xml \
508 ${top_srcdir}/testsuite/data/make_graph_test_infos.xml local g++)
511 .PHONY: doc-doxygen-html doc-doxygen-man doc-performance
513 # By adding these files here, automake will remove them for 'make clean'
514 CLEANFILES = *.log stamp*
516 # To remove directories.
518 rm -rf man html pdf fo xml doxygen docbook ./libstdc++-* db2t*