Makefile.am revision 1.10
1## Makefile for the doc subdirectory of the GNU C++ Standard library. 2## 3## Copyright (C) 2008-2019 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 23include $(top_srcdir)/fragment.am 24 25# Documentation Overview 26# 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 30# doc/xml/. 31# 32# A third and more obscure option deals with charting performance 33# tests, and should be considered experimental. 34 35# Documentation conditionals for output. 36if BUILD_XML 37STAMP_XML = doc-xml 38STAMP_INSTALL_XML = doc-install-xml 39else 40STAMP_XML = 41STAMP_INSTALL_XML = 42endif 43 44if BUILD_HTML 45STAMP_HTML = doc-html 46STAMP_INSTALL_HTML = doc-install-html 47else 48STAMP_HTML = 49STAMP_INSTALL_HTML = 50endif 51 52if BUILD_MAN 53STAMP_MAN = doc-man 54STAMP_INSTALL_MAN = doc-install-man 55else 56STAMP_MAN = 57STAMP_INSTALL_MAN = 58endif 59 60if BUILD_PDF 61STAMP_PDF = doc-pdf 62STAMP_INSTALL_PDF = doc-install-pdf 63else 64STAMP_PDF = 65STAMP_INSTALL_PDF = 66endif 67 68if BUILD_EPUB 69STAMP_EPUB = doc-epub 70STAMP_INSTALL_EPUB = doc-install-epub 71else 72STAMP_EPUB = doc-epub 73STAMP_INSTALL_EPUB = doc-install-epub 74endif 75 76# Documentation primary rules. 77# 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 95xml: $(STAMP_XML) 96install-xml: $(STAMP_INSTALL_XML) 97 98html: $(STAMP_HTML) 99install-html: $(STAMP_INSTALL_HTML) 100 101man: $(STAMP_MAN) 102install-man: $(STAMP_INSTALL_MAN) 103 104pdf: $(STAMP_PDF) 105install-pdf: $(STAMP_INSTALL_PDF) 106 107epub: $(STAMP_EPUB) 108install-epub: $(STAMP_INSTALL_EPUB) 109 110info: 111install-info: 112 113ps: 114install-ps: 115 116dvi: 117install-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 123# and layouts. 124 125# XML 126xmldir="$(DESTDIR)@docdir@" 127stamp-xml: stamp-xml-single-docbook stamp-xml-single-doxygen 128 $(STAMP) stamp-xml 129 130doc-xml: stamp-xml 131 132doc-install-xml: doc-xml 133 test -z ${xmldir} || $(mkinstalldirs) ${xmldir} 134 $(INSTALL_DATA) ${manual_xml} ${xmldir} 135 $(INSTALL_DATA) ${api_xml} ${xmldir} 136 137# HTML 138htmldir="$(DESTDIR)@docdir@" 139stamp-html: stamp-html-docbook-data stamp-html-doxygen 140 $(STAMP) stamp-html 141 142doc-html: stamp-html 143 144doc-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; 148 149# PDF 150pdfdir="$(DESTDIR)@docdir@" 151stamp-pdf: stamp-pdf-docbook stamp-pdf-doxygen 152 $(STAMP) stamp-pdf 153 154doc-pdf: stamp-pdf 155 156doc-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} 160 161# MAN 162mandir="$(DESTDIR)@mandir@" 163stamp-man: stamp-man-doxygen 164 $(STAMP) stamp-man 165 166doc-man: stamp-man 167 168doc-install-man: doc-man 169 test -z ${mandir} || $(mkinstalldirs) ${mandir} 170 cp -r ${doxygen_outdir}/man/man3 ${mandir} 171 172# TEXINFO,INFO 173infodir="$(DESTDIR)@infodir@" 174stamp-texinfo: stamp-texinfo-docbook 175 $(STAMP) stamp-texinfo 176 177stamp-info: stamp-info-docbook 178 $(STAMP) stamp-info 179 180doc-texinfo: stamp-texinfo 181 182doc-info: stamp-info 183 184doc-install-texinfo: doc-texinfo 185 test -z ${infodir} || $(mkinstalldirs) ${infodir} 186 $(INSTALL_DATA) ${manual_texi} ${infodir} 187 188doc-install-info: doc-info 189 test -z ${infodir} || $(mkinstalldirs) ${infodir} 190 $(INSTALL_DATA) ${manual_info} ${infodir} 191 192# EPUB 193# Assumes ruby installed 194epubdir="$(DESTDIR)@docdir@" 195stamp-epub: stamp-epub-docbook 196 $(STAMP) stamp-epub 197 198doc-epub: stamp-epub 199 200doc-install-epub: doc-epub 201 test -z ${epubdir} || $(mkinstalldirs) ${epubdir} 202 $(INSTALL_DATA) ${manual_epub} ${epubdir} 203 204 205# Doxygen configuration 206# Assumes doxygen, graphviz (with dot), pdflatex installed 207doxygen_script=${top_srcdir}/scripts/run_doxygen 208doxygen_outdir = ${glibcxx_builddir}/doc/doxygen 209api_xml = ${doxygen_outdir}/xml/libstdc++-api.xml 210doxygen_pdf = ${doxygen_outdir}/latex/refman.pdf 211api_pdf = ${doxygen_outdir}/pdf/libstdc++-api.pdf 212 213${doxygen_outdir}/xml: 214 mkdir -p ${doxygen_outdir}/xml 215 216${doxygen_outdir}/html: 217 mkdir -p ${doxygen_outdir}/html 218 219${doxygen_outdir}/latex: 220 mkdir -p ${doxygen_outdir}/latex 221 222${doxygen_outdir}/pdf: 223 mkdir -p ${doxygen_outdir}/pdf 224 225${doxygen_outdir}/man: 226 mkdir -p ${doxygen_outdir}/man 227 228stamp-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 234 235stamp-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 240 241stamp-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 247 248stamp-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 254 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# Errors like "File `foo.sty' not found" mean a TeX package is missing. 261stamp-pdf-doxygen: stamp-latex-doxygen ${doxygen_outdir}/pdf 262 -(cd ${doxygen_outdir}/latex && $(MAKE) -i pdf;) 263 echo "Generating doxygen pdf file..."; 264 if [ -f ${doxygen_pdf} ]; then \ 265 mv ${doxygen_pdf} ${api_pdf} ; \ 266 echo ":: PDF file is ${api_pdf}"; \ 267 else \ 268 echo "... error"; \ 269 grep -F 'LaTeX Error' ${doxygen_outdir}/latex/refman.log; \ 270 exit 12; \ 271 fi 272 $(STAMP) stamp-pdf-doxygen 273 274stamp-man-doxygen: ${doxygen_outdir}/man 275 -(srcdir=`cd ${top_srcdir}; ${PWD_COMMAND}`; \ 276 builddir=`cd ..; ${PWD_COMMAND}`; \ 277 ${SHELL} ${doxygen_script} \ 278 --host_alias=${host_alias} --mode=man $${srcdir} $${builddir} YES) 279 $(STAMP) stamp-man-doxygen 280 281doc-xml-doxygen: stamp-xml-doxygen 282doc-xml-single-doxygen: stamp-xml-single-doxygen 283doc-html-doxygen: stamp-html-doxygen 284doc-latex-doxygen: stamp-latex-doxygen 285doc-pdf-doxygen: stamp-pdf-doxygen 286doc-man-doxygen: stamp-man-doxygen 287 288 289# Docbook configuration. 290# Assumes 291# libxslt 292# dblatex 293# pdflatex 294# docbook-style-xsl 295# emacs-nxml-mode 296docbook_outdir = ${glibcxx_builddir}/doc/docbook 297xml_dir = ${glibcxx_srcdir}/doc/xml 298 299xml_sources_basic = \ 300 ${xml_dir}/spine.xml \ 301 ${xml_dir}/authors.xml \ 302 ${xml_dir}/api.xml \ 303 ${xml_dir}/faq.xml 304 305xml_sources_manual = \ 306 ${xml_dir}/manual/abi.xml \ 307 ${xml_dir}/manual/algorithms.xml \ 308 ${xml_dir}/manual/allocator.xml \ 309 ${xml_dir}/manual/auto_ptr.xml \ 310 ${xml_dir}/manual/atomics.xml \ 311 ${xml_dir}/manual/backwards_compatibility.xml \ 312 ${xml_dir}/manual/bitmap_allocator.xml \ 313 ${xml_dir}/manual/build_hacking.xml \ 314 ${xml_dir}/manual/codecvt.xml \ 315 ${xml_dir}/manual/concurrency.xml \ 316 ${xml_dir}/manual/concurrency_extensions.xml \ 317 ${xml_dir}/manual/configure.xml \ 318 ${xml_dir}/manual/containers.xml \ 319 ${xml_dir}/manual/ctype.xml \ 320 ${xml_dir}/manual/debug_mode.xml \ 321 ${xml_dir}/manual/debug.xml \ 322 ${xml_dir}/manual/diagnostics.xml \ 323 ${xml_dir}/manual/documentation_hacking.xml \ 324 ${xml_dir}/manual/evolution.xml \ 325 ${xml_dir}/manual/extensions.xml \ 326 ${xml_dir}/manual/internals.xml \ 327 ${xml_dir}/manual/intro.xml \ 328 ${xml_dir}/manual/io.xml \ 329 ${xml_dir}/manual/iterators.xml \ 330 ${xml_dir}/manual/locale.xml \ 331 ${xml_dir}/manual/localization.xml \ 332 ${xml_dir}/manual/messages.xml \ 333 ${xml_dir}/manual/mt_allocator.xml \ 334 ${xml_dir}/manual/numerics.xml \ 335 ${xml_dir}/manual/parallel_mode.xml \ 336 ${xml_dir}/manual/policy_data_structures.xml \ 337 ${xml_dir}/manual/policy_data_structures_biblio.xml \ 338 ${xml_dir}/manual/prerequisites.xml \ 339 ${xml_dir}/manual/profile_mode.xml \ 340 ${xml_dir}/manual/shared_ptr.xml \ 341 ${xml_dir}/manual/spine.xml \ 342 ${xml_dir}/manual/status_cxx1998.xml \ 343 ${xml_dir}/manual/status_cxx2011.xml \ 344 ${xml_dir}/manual/status_cxx2014.xml \ 345 ${xml_dir}/manual/status_cxxtr1.xml \ 346 ${xml_dir}/manual/status_cxxtr24733.xml \ 347 ${xml_dir}/manual/strings.xml \ 348 ${xml_dir}/manual/support.xml \ 349 ${xml_dir}/manual/test.xml \ 350 ${xml_dir}/manual/test_policy_data_structures.xml \ 351 ${xml_dir}/manual/using.xml \ 352 ${xml_dir}/manual/using_exceptions.xml \ 353 ${xml_dir}/manual/utilities.xml \ 354 ${xml_dir}/manual/appendix_free.xml \ 355 ${xml_dir}/manual/appendix_contributing.xml \ 356 ${xml_dir}/manual/appendix_porting.xml 357 358xml_sources_extra = \ 359 ${xml_dir}/gnu/fdl-1.3.xml \ 360 ${xml_dir}/gnu/gpl-3.0.xml 361 362xml_sources = \ 363 ${xml_sources_basic} \ 364 ${xml_sources_manual} \ 365 ${xml_sources_extra} 366 367xml_image_dir = ${xml_dir}/images 368xml_image_basic = \ 369 ${xml_image_dir}/confdeps.png \ 370 ${xml_image_dir}/pbds_balls_and_bins.png \ 371 ${xml_image_dir}/pbds_container_tag_hierarchy.png \ 372 ${xml_image_dir}/pbds_different_underlying_dss_1.png \ 373 ${xml_image_dir}/pbds_different_underlying_dss_2.png \ 374 ${xml_image_dir}/pbds_embedded_lists_1.png \ 375 ${xml_image_dir}/pbds_embedded_lists_2.png \ 376 ${xml_image_dir}/pbds_embedded_lists_3.png \ 377 ${xml_image_dir}/pbds_exception_hierarchy.png \ 378 ${xml_image_dir}/pbds_hash_policy_cd.png \ 379 ${xml_image_dir}/pbds_hash_ranged_hash_range_hashing_fns.png \ 380 ${xml_image_dir}/pbds_hash_range_hashing_seq_diagram2.png \ 381 ${xml_image_dir}/pbds_hash_range_hashing_seq_diagram.png \ 382 ${xml_image_dir}/pbds_insert_resize_sequence_diagram1.png \ 383 ${xml_image_dir}/pbds_insert_resize_sequence_diagram2.png \ 384 ${xml_image_dir}/pbds_insert_resize_sequence_diagram3.png \ 385 ${xml_image_dir}/pbds_invalidation_guarantee_erase.png \ 386 ${xml_image_dir}/pbds_invalidation_tag_hierarchy.png \ 387 ${xml_image_dir}/pbds_list_update.png \ 388 ${xml_image_dir}/pbds_node_invariants.png \ 389 ${xml_image_dir}/pbds_pat_trie.png \ 390 ${xml_image_dir}/pbds_point_iterator_hierarchy.png \ 391 ${xml_image_dir}/pbds_point_iterators_range_ops_1.png \ 392 ${xml_image_dir}/pbds_point_iterators_range_ops_2.png \ 393 ${xml_image_dir}/pbds_priority_queue_different_underlying_dss.png \ 394 ${xml_image_dir}/pbds_priority_queue_tag_hierarchy.png \ 395 ${xml_image_dir}/pbds_rationale_null_node_updator.png \ 396 ${xml_image_dir}/pbds_resize_policy_cd.png \ 397 ${xml_image_dir}/pbds_restoring_node_invariants.png \ 398 ${xml_image_dir}/pbds_simple_list.png \ 399 ${xml_image_dir}/pbds_tree_node_invalidations.png \ 400 ${xml_image_dir}/pbds_tree_node_invariants.png \ 401 ${xml_image_dir}/pbds_tree_node_updator_policy_cd.png \ 402 ${xml_image_dir}/pbds_trie_node_updator_policy_cd.png \ 403 ${xml_image_dir}/pbds_update_seq_diagram.png 404 405xml_image_generated = \ 406 ${xml_image_dir}/pbds_binary_priority_queue_int_push_pop.png \ 407 ${xml_image_dir}/pbds_binary_priority_queue_int_push.png \ 408 ${xml_image_dir}/pbds_ccgp_hash_int_subscript_insert.png \ 409 ${xml_image_dir}/pbds_cc_hash_int_find.png \ 410 ${xml_image_dir}/pbds_cc_hash_int_subscript_find.png \ 411 ${xml_image_dir}/pbds_cc_hash_int_subscript_insert.png \ 412 ${xml_image_dir}/pbds_gp_hash_int_find.png \ 413 ${xml_image_dir}/pbds_gp_hash_int_subscript_find.png \ 414 ${xml_image_dir}/pbds_gp_hash_int_subscript_insert.png \ 415 ${xml_image_dir}/pbds_hash_int_erase_mem.png \ 416 ${xml_image_dir}/pbds_hash_text_find.png \ 417 ${xml_image_dir}/pbds_hash_zlob_int_find.png \ 418 ${xml_image_dir}/pbds_multimap_text_find_large_s2p_hash.png \ 419 ${xml_image_dir}/pbds_multimap_text_find_large_s2p_tree.png \ 420 ${xml_image_dir}/pbds_multimap_text_find_small_s2p_hash.png \ 421 ${xml_image_dir}/pbds_multimap_text_find_small_s2p_tree.png \ 422 ${xml_image_dir}/pbds_multimap_text_insert_large_s2p_hash.png \ 423 ${xml_image_dir}/pbds_multimap_text_insert_large_s2p_tree.png \ 424 ${xml_image_dir}/pbds_multimap_text_insert_mem_large_s2p_hash.png \ 425 ${xml_image_dir}/pbds_multimap_text_insert_mem_large_s2p_tree.png \ 426 ${xml_image_dir}/pbds_multimap_text_insert_mem_small_s2p_hash.png \ 427 ${xml_image_dir}/pbds_multimap_text_insert_mem_small_s2p_tree.png \ 428 ${xml_image_dir}/pbds_multimap_text_insert_small_s2p_hash.png \ 429 ${xml_image_dir}/pbds_multimap_text_insert_small_s2p_tree.png \ 430 ${xml_image_dir}/pbds_pairing_priority_queue_text_modify_down_thin.png \ 431 ${xml_image_dir}/pbds_pairing_priority_queue_text_modify_up_thin.png \ 432 ${xml_image_dir}/pbds_pairing_priority_queue_text_push_pop.png \ 433 ${xml_image_dir}/pbds_pairing_priority_queue_text_push.png \ 434 ${xml_image_dir}/pbds_priority_queue_int_push_pop.png \ 435 ${xml_image_dir}/pbds_priority_queue_int_push.png \ 436 ${xml_image_dir}/pbds_priority_queue_text_join.png \ 437 ${xml_image_dir}/pbds_priority_queue_text_modify_down.png \ 438 ${xml_image_dir}/pbds_priority_queue_text_modify_up.png \ 439 ${xml_image_dir}/pbds_priority_queue_text_pop_mem.png \ 440 ${xml_image_dir}/pbds_priority_queue_text_push_pop.png \ 441 ${xml_image_dir}/pbds_priority_queue_text_push.png \ 442 ${xml_image_dir}/pbds_tree_int_find.png \ 443 ${xml_image_dir}/pbds_tree_order_statistics.png \ 444 ${xml_image_dir}/pbds_tree_split_join.png \ 445 ${xml_image_dir}/pbds_tree_text_find.png \ 446 ${xml_image_dir}/pbds_tree_text_insert_node.png \ 447 ${xml_image_dir}/pbds_tree_text_insert_trie.png \ 448 ${xml_image_dir}/pbds_tree_text_insert_vector.png \ 449 ${xml_image_dir}/pbds_tree_text_lor_find.png 450 451xml_images = ${xml_image_basic} ${xml_image_generated} 452 453xml_noinst = \ 454 ${xml_dir}/book.txml \ 455 ${xml_dir}/chapter.txml \ 456 ${xml_dir}/class.txml \ 457 ${xml_image_dir}/confdeps.dot \ 458 ${xml_image_dir}/confdeps.pdf 459 460XSLTPROC = xsltproc 461XSLT_FLAGS = --nonet --xinclude 462XSLT_PARAM = --param toc.section.depth 4 --param generate.consistent.ids 1 463#XSL_STYLE_DIR = /usr/share/xml/docbook/stylesheet/docbook-xsl-ns 464#XSL_STYLE_DIR = /usr/share/sgml/docbook/xsl-ns-stylesheets 465XSL_FO_STYLE = $(XSL_STYLE_DIR)/fo/docbook.xsl 466XSL_HTML_STYLE = $(XSL_STYLE_DIR)/xhtml/chunk.xsl 467XSL_HTML_SINGLE_STYLE = $(XSL_STYLE_DIR)/html/docbook.xsl 468XSL_EPUB_STYLE = $(XSL_STYLE_DIR)/epub3/chunk.xsl 469XSL_LOCAL_STYLE = ${glibcxx_builddir}/doc/xsl/customization.xsl 470 471${docbook_outdir}/epub: 472 mkdir -p ${docbook_outdir}/epub 473 mkdir -p ${docbook_outdir}/epub/OEBPS/images 474 475${docbook_outdir}/fo: 476 mkdir -p ${docbook_outdir}/fo 477 478${docbook_outdir}/html: 479 mkdir -p ${docbook_outdir}/html 480 mkdir -p ${docbook_outdir}/html/images 481 mkdir -p ${docbook_outdir}/html/manual 482 483${docbook_outdir}/pdf: 484 mkdir -p ${docbook_outdir}/pdf 485 486${docbook_outdir}/latex: 487 mkdir -p ${docbook_outdir}/latex 488 489${docbook_outdir}/texinfo: 490 mkdir -p ${docbook_outdir}/texinfo 491 492${docbook_outdir}/xml: 493 mkdir -p ${docbook_outdir}/xml 494 495 496# XML, all one page 497# Some info on canonicalization 498# http://www.mail-archive.com/help-texinfo@gnu.org/msg00864.html 499manual_xml = ${docbook_outdir}/xml/libstdc++-manual.xml 500set_xml = ${docbook_outdir}/xml/libstdc++-set.xml 501stamp-xml-single-docbook: $(xml_sources) ${docbook_outdir}/xml 502 @echo "Generating XML single..." 503 $(XMLLINT) $(XMLLINT_FLAGS) \ 504 ${top_srcdir}/doc/xml/manual/spine.xml > ${manual_xml}; 505 $(XMLLINT) $(XMLLINT_FLAGS) \ 506 ${top_srcdir}/doc/xml/spine.xml > ${set_xml}; 507 $(STAMP) stamp-xml-single-docbook 508 509doc-xml-single-docbook: stamp-xml-single-docbook 510 511# Validate existing XML structure. 512XMLLINT = xmllint 513LINT_FLAGS = --debug --xinclude --noent --noblanks --noout 514SCHEMA_FLAGS = --dtdvalid http://www.docbook.org/xml/5.0/dtd/docbook.dtd 515SCHEMA_RNG_FLAGS = --relaxng http://www.docbook.org/xml/5.0/rng/docbook.rng 516#SCHEMA_FLAGS = --nonet --dtdvalid /usr/share/xxx/dtd/5.0/docbook.dtd 517XMLLINT_VALID_FLAGS = $(LINT_FLAGS) $(SCHEMA_FLAGS) 518XMLLINT_FLAGS = --xinclude --nsclean --c14n --noent --noblanks --nocdata 519doc-xml-validate-docbook: doc-xml-validate-dtd-db 520 521doc-xml-validate-dtd-db: $(xml_sources) $(xml_images) 522 @echo "Generating XML validation log..." 523 $(XMLLINT) $(XMLLINT_VALID_FLAGS) ${top_srcdir}/doc/xml/spine.xml 524 525doc-xml-validate-rng-db: $(xml_sources) $(xml_images) doc-xml-single-docbook 526 @echo "Generating XML RelaxNG validation log..." 527 $(XMLLINT) $(LINT_FLAGS) $(SCHEMA_RNG_FLAGS) ${set_xml} 528 529# HTML support files 530stamp-html-docbook-images: stamp-html-docbook $(xml_images) 531 $(INSTALL_DATA) $(xml_images) ${docbook_outdir}/html/images 532 $(STAMP) stamp-html-docbook-images 533 534stamp-html-docbook-data: stamp-html-docbook-images 535 $(STAMP) stamp-html-docbook-data 536 537# HTML, "chunked" into index plus chapters as separate pages 538stamp-html-docbook: $(xml_sources) ${docbook_outdir}/html 539 @echo "Generating html files..." 540 $(XSLTPROC) $(XSLT_PARAM) $(XSLT_FLAGS) -o ${docbook_outdir}/html/ \ 541 --stringparam chunker.output.encoding UTF-8 \ 542 $(XSL_HTML_STYLE) \ 543 ${top_srcdir}/doc/xml/spine.xml 544 $(STAMP) stamp-html-docbook 545 546doc-html-docbook: stamp-html-docbook-data 547 548# Generate the HTML pages and copy them back to the source tree. 549doc-html-docbook-regenerate: doc-html-docbook 550 $(INSTALL_DATA) ${docbook_outdir}/html/*.html ${top_srcdir}/doc/html 551 $(INSTALL_DATA) ${docbook_outdir}/html/images/* ${top_srcdir}/doc/html/images 552 $(INSTALL_DATA) ${docbook_outdir}/html/manual/*.html ${top_srcdir}/doc/html/manual 553 554# HTML, all one page 555# NB: Have to generate customization XSL for UTF-8 output. 556manual_html = ${docbook_outdir}/html/libstdc++-manual-single.html 557stamp-html-single-docbook: $(xml_sources) ${docbook_outdir}/html 558 @echo "Generating html single file..." 559 $(XSLTPROC) $(XSLT_PARAM) $(XSLT_FLAGS) -o ${manual_html} \ 560 ${XSL_LOCAL_STYLE} \ 561 ${top_srcdir}/doc/xml/spine.xml 562 $(STAMP) stamp-html-single-docbook 563 564doc-html-single-docbook: stamp-html-single-docbook 565 566# FO 567stamp-fo-docbook: $(xml_sources) ${docbook_outdir}/fo 568 @echo "Generating FO files..." 569 $(XSLTPROC) $(XSLT_FLAGS) -o ${docbook_outdir}/fo/spine.fo \ 570 $(XSL_FO_STYLE) ${top_srcdir}/doc/xml/spine.xml 571 $(STAMP) stamp-fo-docbook 572 573doc-fo-docbook: stamp-fo-docbook 574 575# PDF, via dblatex 576manual_pdf = ${docbook_outdir}/pdf/libstdc++-manual.pdf 577DBLATEX_FLAGS = --verbose --pdf --dump --debug --tmpdir=${docbook_outdir}/latex 578 579doc-pdf-docbook-dirs: ${docbook_outdir}/pdf ${docbook_outdir}/latex 580 581doc-pdf-docbook-pre: $(xml_sources) doc-pdf-docbook-dirs 582 583stamp-pdf-docbook: doc-pdf-docbook-pre doc-xml-single-docbook 584 @echo "Generating pdf dblatex files..." 585 dblatex $(DBLATEX_FLAGS) -o ${manual_pdf} \ 586 ${top_srcdir}/doc/xml/spine.xml 587 $(STAMP) stamp-pdf-docbook 588 589doc-pdf-docbook: stamp-pdf-docbook 590 591# TEXINFO, via docbook2X 592# NB: Both experimental and tempermental 593manual_texi = ${docbook_outdir}/texinfo/libstdc++-manual.texi 594manual_info = ${docbook_outdir}/texinfo/libstdc++-manual.info 595DB2TEXI_FLAGS = \ 596 --encoding=utf-8//TRANSLIT \ 597 --string-param output-file="libstdc++-manual" \ 598 --string-param directory-category="GNU C++ Library" \ 599 --string-param explicit-node-names=true 600 601stamp-texinfo-docbook: stamp-xml-single-docbook ${docbook_outdir}/texinfo 602 @echo "Generating texinfo files..." 603 db2x_docbook2texi $(DB2TEXI_FLAGS) ${set_xml} 604 mv libstdc++-manual.texi ${manual_texi} 605 $(STAMP) stamp-texinfo-docbook 606 607stamp-info-docbook: stamp-texinfo-docbook 608 @echo "Generating info files..." 609 $(MAKEINFO) $(MAKEINFOFLAGS) ${manual_texi} 610 $(STAMP) stamp-info-docbook 611 612doc-texinfo-docbook: stamp-texinfo-docbook 613 614doc-info-docbook: stamp-info-docbook 615 616# EPUB version 3 617# http://sourceforge.net/projects/docbook/files/epub3/ 618# Can verify document with epubcheck 619manual_epub = ${docbook_outdir}/epub/libstdc++-manual.epub 620stamp-epub-docbook: stamp-xml-single-docbook ${docbook_outdir}/epub 621 @echo "Generating epub files..." 622 if [ ! -d "${docbook_outdir}/images" ]; then \ 623 $(LN_S) ${top_srcdir}/doc/xml/images ${docbook_outdir}/; \ 624 fi 625 $(XSLTPROC) $(XSLT_PARAM) $(XSLT_FLAGS) \ 626 --stringparam base.dir "${docbook_outdir}/epub/OEBPS/" \ 627 $(XSL_EPUB_STYLE) ${top_srcdir}/doc/xml/spine.xml 628 $(INSTALL_DATA) $(xml_images) ${docbook_outdir}/epub/OEBPS/images 629 zip -X0 ${manual_epub} ${docbook_outdir}/epub/mimetype 630 zip -r -X9 ${manual_epub} ${docbook_outdir}/epub/META-INF ${docbook_outdir}/epub/OEBPS 631 $(STAMP) stamp-epub-docbook 632 633doc-epub-docbook: stamp-epub-docbook 634 635# Performance doc and graph configuration. 636# Assumes pychart, beautiful soup installed. 637# Generates the plots/graph imagery for performance testing. 638doc_performance_script=${top_srcdir}/scripts/make_graph.py 639doc-svg-performance: ${docbook_outdir}/xml 640 -@(chmod + ${doc_performance_script}; \ 641 ${doc_performance_script} \ 642 ${top_srcdir}/testsuite/data/make_graph_test_infos.xml \ 643 ${glibcxx_builddir}/testsuite \ 644 ${glibcxx_builddir}/doc/docbook/xml/images) 645 646.PHONY: doc-doxygen-html doc-doxygen-man doc-performance 647 648# By adding these files here, automake will remove them for 'make clean' 649CLEANFILES = *.log stamp* 650 651# To remove directories. 652clean-local: 653 rm -rf man html pdf fo xml doxygen docbook ./libstdc++-* db2t* 654
