libstdc++-v3/doc/Makefile.am

   1 ## Makefile for the doc subdirectory of the GNU C++ Standard library.
   2 ##
   3 ## Copyright (C) 2008, 2009 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
  26 # Doxygen configuration
  27 # Assumes doxygen, graphviz (with dot) installed
  28 doc_doxygen_script=${top_srcdir}/scripts/run_doxygen
  29 doc-html-doxygen:
  30         -(srcdir=`cd ${top_srcdir}; ${PWD_COMMAND}`; \
  31           builddir=`cd ..; ${PWD_COMMAND}`; \
  32           ${SHELL} ${doc_doxygen_script} \
  33           --host_alias=${host_alias} --mode=html $${srcdir} $${builddir})
  34
  35 doc-man-doxygen:
  36         -(srcdir=`cd ${top_srcdir}; ${PWD_COMMAND}`; \
  37           builddir=`cd ..; ${PWD_COMMAND}`; \
  38           ${SHELL} ${doc_doxygen_script} \
  39           --host_alias=${host_alias} --mode=man $${srcdir} $${builddir})
  40
  41 doc-xml-doxygen:
  42         -(srcdir=`cd ${top_srcdir}; ${PWD_COMMAND}`; \
  43           builddir=`cd ..; ${PWD_COMMAND}`; \
  44           ${SHELL} ${doc_doxygen_script} \
  45           --host_alias=${host_alias} --mode=xml $${srcdir} $${builddir})
  46
  47 doxygen_xmldir = ${glibcxx_builddir}/doc/doxygen/xml
  48 doc-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.
  55 # Generates the plots and graphs for performance testing.
  56 doc_performance_script=${top_srcdir}/scripts/make_graphs.py
  57 doc-html-performance:
  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
  64
  65 # Docbook configuration.
  66 # Assumes
  67 # libxslt
  68 # docbook-style-xsl
  69 # emacs-nxml-mode
  70 # xmlto passivetex
  71 xml_srcdir = ${glibcxx_srcdir}/doc/xml
  72 xml_sources = \
  73         ${xml_srcdir}/spine.xml \
  74         ${xml_srcdir}/authors.xml \
  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 \
  81         ${xml_srcdir}/manual/build_hacking.xml \
  82         ${xml_srcdir}/manual/codecvt.xml \
  83         ${xml_srcdir}/manual/concurrency.xml \
  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 \
 102         ${xml_srcdir}/manual/prerequisites.xml \
 103         ${xml_srcdir}/manual/internals.xml \
 104         ${xml_srcdir}/manual/shared_ptr.xml \
 105         ${xml_srcdir}/manual/spine.xml \
 106         ${xml_srcdir}/manual/status_cxx1998.xml \
 107         ${xml_srcdir}/manual/status_cxx200x.xml \
 108         ${xml_srcdir}/manual/status_cxxtr1.xml \
 109         ${xml_srcdir}/manual/strings.xml \
 110         ${xml_srcdir}/manual/support.xml \
 111         ${xml_srcdir}/manual/test.xml \
 112         ${xml_srcdir}/manual/using.xml \
 113         ${xml_srcdir}/manual/utilities.xml \
 114         ${xml_srcdir}/manual/appendix_free.xml \
 115         ${xml_srcdir}/manual/appendix_contributing.xml \
 116         ${xml_srcdir}/manual/appendix_porting.xml \
 117         ${xml_srcdir}/api.xml \
 118         ${xml_srcdir}/faq.xml
 119
 120 xml_sources_extra = \
 121         ${xml_srcdir}/gnu/fdl-1.2.xml \
 122         ${xml_srcdir}/gnu/gpl-2.0.xml
 123
 124 xml_noinst = \
 125         ${xml_srcdir}/book.txml \
 126         ${xml_srcdir}/chapter.txml \
 127         ${xml_srcdir}/class.txml
 128
 129
 130 XSLTPROC       = xsltproc
 131 XSLTPROC_FLAGS = --nonet --xinclude
 132 XSL_STYLE_DIR = /usr/share/sgml/docbook/xsl-stylesheets
 133 XSL_FO_STYLE = $(XSL_STYLE_DIR)/fo/docbook.xsl
 134 XSL_HTML_STYLE = $(XSL_STYLE_DIR)/xhtml/chunk.xsl
 135 #XSL_HTML_SINGLE_STYLE = $(XSL_STYLE_DIR)/xhtml/onechunk.xsl
 136 XSL_HTML_SINGLE_STYLE = $(XSL_STYLE_DIR)/xhtml/docbook.xsl
 137
 138 ${glibcxx_builddir}/doc/html:
 139         mkdir ${glibcxx_builddir}/doc/html
 140
 141 ${glibcxx_builddir}/doc/pdf:
 142         mkdir ${glibcxx_builddir}/doc/pdf
 143
 144 ${glibcxx_builddir}/doc/fo:
 145         mkdir ${glibcxx_builddir}/doc/fo
 146
 147 ${glibcxx_builddir}/doc/xml:
 148         mkdir ${glibcxx_builddir}/doc/xml
 149
 150 # Validate existing XML structure.
 151 XMLLINT = xmllint
 152 #LINT_FLAGS = --debug --nonet --xinclude --nsclean --postvalid --nowarning
 153 #LINT_FLAGS = --noblanks --noout --xinclude --postvalid --noent
 154 LINT_FLAGS = --postvalid --debug --xinclude --noent --noblanks  --nonet --noout
 155 VALID_FLAGS = --dtdvalid http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd
 156 XMLLINT_FLAGS = $(LINT_FLAGS) $(VALID_FLAGS)
 157 doc-xml-validate: $(xml_sources)
 158         @echo "Generating XML validation log..."
 159         $(XMLLINT) $(XMLLINT_FLAGS) ${top_srcdir}/doc/xml/spine.xml
 160
 161 doc-xml-single: $(xml_sources) ${glibcxx_builddir}/doc/xml
 162         @echo "Generating XML single..."
 163         $(XMLLINT) --xinclude --noent --noblanks \
 164         -o ${glibcxx_builddir}/doc/xml/spine-single.xml \
 165         ${top_srcdir}/doc/xml/spine.xml
 166
 167 # HTML, index plus chapters
 168 doc-html: $(xml_sources) ${glibcxx_builddir}/doc/html
 169         @echo "Generating html files..."
 170         $(XSLTPROC) $(XSLTPROC_FLAGS) -o ${glibcxx_builddir}/doc/html/ \
 171         $(XSL_HTML_STYLE) ${top_srcdir}/doc/xml/spine.xml
 172
 173 # HTML, all one page
 174 doc-html-single: $(xml_sources) ${glibcxx_builddir}/doc/html
 175         @echo "Generating html single file..."
 176         $(XSLTPROC) $(XSLTPROC_FLAGS) -o ${glibcxx_builddir}/doc/html/ \
 177         $(XSL_HTML_SINGLE_STYLE) ${top_srcdir}/doc/xml/spine.xml
 178
 179 # FO
 180 doc-fo: $(xml_sources) ${glibcxx_builddir}/doc/fo
 181         @echo "Generating FO files..."
 182         $(XSLTPROC) $(XSLTPROC_FLAGS) -o ${glibcxx_builddir}/doc/fo/spine.fo \
 183         $(XSL_FO_STYLE) ${top_srcdir}/doc/xml/spine.xml
 184
 185 # PDF
 186 # Points to current best xml to PDF generation process.
 187 doc-pdf: doc-pdf-prince
 188
 189 # PDF 1
 190 # fop
 191 FOP = fop
 192 FOP_FLAGS = -d -r
 193 doc-pdf-fop-xml: $(xml_sources) ${glibcxx_builddir}/doc/pdf
 194         @echo "Generating pdf fop files from xml..."
 195         $(FOP) $(FOP_FLAGS) -xml ${top_srcdir}/doc/xml/spine.xml \
 196         -xsl $(XSL_FO_STYLE) -pdf ${glibcxx_builddir}/doc/pdf/spine.pdf
 197
 198 doc-pdf-fop-fo: $(xml_sources) ${glibcxx_builddir}/doc/pdf doc-fo
 199         @echo "Generating pdf fop files from fo..."
 200         $(FOP) $(FOP_FLAGS) -fo ${glibcxx_builddir}/doc/fo/spine.fo \
 201         -pdf ${glibcxx_builddir}/doc/pdf/spine.pdf
 202
 203 # PDF 2
 204 # xmlto
 205 XML2PDF = xmlto
 206 XML2PDF_FLAGS = -v pdf --skip-validation -o pdf
 207 doc-pdf-xmlto: $(xml_sources) ${glibcxx_builddir}/doc/pdf
 208         @echo "Generating pdf xmlto files..."
 209         $(XML2PDF) $(XML2PDF_FLAGS) ${top_srcdir}/doc/xml/spine.xml
 210
 211 # PDF 3
 212 # xmlroff
 213 XMLROFF = xmlroff
 214 XMLROFF_FLAGS = --format=pdf --backend=cairo --warn=1 --debug=1 --continue
 215 doc-pdf-xmlroff: $(xml_sources) doc-fo
 216         @echo "Generating pdf xmlroff files..."
 217         $(XMLROFF) $(XMLROFF_FLAGS) ${glibcxx_builddir}/doc/fo/spine.fo
 218
 219 # PDF 4
 220 # prince
 221 PRINCE = prince
 222 PRINCE_FLAGS = --log prince.log -o pdf/spine.pdf
 223 doc-pdf-prince: $(xml_sources) ${glibcxx_builddir}/doc/pdf
 224         @echo "Generating pdf prince files..."
 225         $(PRINCE) $(PRINCE_FLAGS) ${top_srcdir}/doc/xml/spine.xml
 226
 227
 228 .PHONY: doc-doxygen-html doc-doxygen-man doc-performance
 229
 230 # By adding these files here, automake will remove them for 'make clean'
 231 CLEANFILES = *.log
 232
 233 # To remove directories.
 234 clean-local:
 235         rm -rf man html pdf fo doxygen xml