Commit 74080cba by Benjamin Kosnik Committed by Benjamin Kosnik

Makefile.am (xml_sources_manual): Add policy_data_structures_biblio.xml.

2012-12-10  Benjamin Kosnik  <bkoz@redhat.com>

	* doc/Makefile.am (xml_sources_manual): Add
	policy_data_structures_biblio.xml.
	(${docbook_outdir}/latex): Add.
	(doc-xml-validate-docbook): Split into..
	(doc-xml-validate-dtd-db):... this for DTD.
	(doc-xml-validate-rng-db):... this for Relax NG.
	(doc-pdf-docbook-dirs): Add.
	(doc-pdf-docbook-pre): Add.
	* doc/xml/manual/build_hacking.xml: Add literal markup.
	* doc/xml/manual/documentation_hacking.xml: Clean whitespace in
	<filename> markup. Add notes about debugging the generation process.
	* doc/xml/manual/policy_data_structures.xml: Split biblio into...
	* doc/xml/manual/policy_data_structures_biblio.xml: ... this. New.
	* doc/xml/manual/test_policy_data_structures.xml: Fixup <filename>
	markup.

From-SVN: r194379
parent b686a89c
2012-12-10 Benjamin Kosnik <bkoz@redhat.com>
* doc/Makefile.am (xml_sources_manual): Add
policy_data_structures_biblio.xml.
(${docbook_outdir}/latex): Add.
(doc-xml-validate-docbook): Split into..
(doc-xml-validate-dtd-db):... this for DTD.
(doc-xml-validate-rng-db):... this for Relax NG.
(doc-pdf-docbook-dirs): Add.
(doc-pdf-docbook-pre): Add.
* doc/xml/manual/build_hacking.xml: Add literal markup.
* doc/xml/manual/documentation_hacking.xml: Clean whitespace in
<filename> markup. Add notes about debugging the generation process.
* doc/xml/manual/policy_data_structures.xml: Split biblio into...
* doc/xml/manual/policy_data_structures_biblio.xml: ... this. New.
* doc/xml/manual/test_policy_data_structures.xml: Fixup <filename>
markup.
2012-12-10 Matthias Klose <doko@ubuntu.com> 2012-12-10 Matthias Klose <doko@ubuntu.com>
* src/Makefile.am (libstdc++-symbols.ver): Use CONFIG_HEADER. * src/Makefile.am (libstdc++-symbols.ver): Use CONFIG_HEADER.
......
...@@ -332,6 +332,7 @@ xml_sources_manual = \ ...@@ -332,6 +332,7 @@ xml_sources_manual = \
${xml_dir}/manual/numerics.xml \ ${xml_dir}/manual/numerics.xml \
${xml_dir}/manual/parallel_mode.xml \ ${xml_dir}/manual/parallel_mode.xml \
${xml_dir}/manual/policy_data_structures.xml \ ${xml_dir}/manual/policy_data_structures.xml \
${xml_dir}/manual/policy_data_structures_biblio.xml \
${xml_dir}/manual/prerequisites.xml \ ${xml_dir}/manual/prerequisites.xml \
${xml_dir}/manual/profile_mode.xml \ ${xml_dir}/manual/profile_mode.xml \
${xml_dir}/manual/shared_ptr.xml \ ${xml_dir}/manual/shared_ptr.xml \
...@@ -486,22 +487,15 @@ ${docbook_outdir}/html: ...@@ -486,22 +487,15 @@ ${docbook_outdir}/html:
${docbook_outdir}/pdf: ${docbook_outdir}/pdf:
mkdir -p ${docbook_outdir}/pdf mkdir -p ${docbook_outdir}/pdf
${docbook_outdir}/latex:
mkdir -p ${docbook_outdir}/latex
${docbook_outdir}/texinfo: ${docbook_outdir}/texinfo:
mkdir -p ${docbook_outdir}/texinfo mkdir -p ${docbook_outdir}/texinfo
${docbook_outdir}/xml: ${docbook_outdir}/xml:
mkdir -p ${docbook_outdir}/xml mkdir -p ${docbook_outdir}/xml
# Validate existing XML structure.
XMLLINT = xmllint
LINT_FLAGS = --debug --xinclude --noent --noblanks --noout
SCHEMA_FLAGS = http://www.docbook.org/xml/5.0/dtd/docbook.dtd
#SCHEMA_FLAGS = --nonet /usr/share/xml/docbook5/schema/dtd/5.0/docbook.dtd
XMLLINT_VALID_FLAGS = $(LINT_FLAGS) --dtdvalid $(SCHEMA_FLAGS)
XMLLINT_FLAGS = --xinclude --nsclean --c14n --noent --noblanks --nocdata
doc-xml-validate-docbook: $(xml_sources) $(xml_images)
@echo "Generating XML validation log..."
$(XMLLINT) $(XMLLINT_VALID_FLAGS) ${top_srcdir}/doc/xml/spine.xml
# XML, all one page # XML, all one page
# Some info on canonicalization # Some info on canonicalization
...@@ -518,6 +512,24 @@ stamp-xml-single-docbook: $(xml_sources) ${docbook_outdir}/xml ...@@ -518,6 +512,24 @@ stamp-xml-single-docbook: $(xml_sources) ${docbook_outdir}/xml
doc-xml-single-docbook: stamp-xml-single-docbook doc-xml-single-docbook: stamp-xml-single-docbook
# Validate existing XML structure.
XMLLINT = xmllint
LINT_FLAGS = --debug --xinclude --noent --noblanks --noout
SCHEMA_FLAGS = --dtdvalid http://www.docbook.org/xml/5.0/dtd/docbook.dtd
SCHEMA_RNG_FLAGS = --relaxng http://www.docbook.org/xml/5.0/rng/docbook.rng
#SCHEMA_FLAGS = --nonet --dtdvalid /usr/share/xxx/dtd/5.0/docbook.dtd
XMLLINT_VALID_FLAGS = $(LINT_FLAGS) $(SCHEMA_FLAGS)
XMLLINT_FLAGS = --xinclude --nsclean --c14n --noent --noblanks --nocdata
doc-xml-validate-docbook: doc-xml-validate-dtd-db
doc-xml-validate-dtd-db: $(xml_sources) $(xml_images)
@echo "Generating XML validation log..."
$(XMLLINT) $(XMLLINT_VALID_FLAGS) ${top_srcdir}/doc/xml/spine.xml
doc-xml-validate-rng-db: $(xml_sources) $(xml_images) doc-xml-single-docbook
@echo "Generating XML RelaxNG validation log..."
$(XMLLINT) $(LINT_FLAGS) $(SCHEMA_RNG_FLAGS) ${set_xml}
# HTML support files # HTML support files
stamp-html-docbook-images: stamp-html-docbook $(xml_images) stamp-html-docbook-images: stamp-html-docbook $(xml_images)
$(INSTALL_DATA) $(xml_images) ${docbook_outdir}/html/images $(INSTALL_DATA) $(xml_images) ${docbook_outdir}/html/images
...@@ -564,11 +576,16 @@ doc-fo-docbook: stamp-fo-docbook ...@@ -564,11 +576,16 @@ doc-fo-docbook: stamp-fo-docbook
# PDF, via dblatex # PDF, via dblatex
manual_pdf = ${docbook_outdir}/pdf/libstdc++-manual.pdf manual_pdf = ${docbook_outdir}/pdf/libstdc++-manual.pdf
DBLATEX_FLAGS = --dump --verbose --pdf DBLATEX_FLAGS = --verbose --pdf --dump --debug --tmpdir=${docbook_outdir}/latex
stamp-pdf-docbook: $(xml_sources) ${docbook_outdir}/pdf
doc-pdf-docbook-dirs: ${docbook_outdir}/pdf ${docbook_outdir}/latex
doc-pdf-docbook-pre: $(xml_sources) doc-pdf-docbook-dirs
stamp-pdf-docbook: doc-pdf-docbook-pre doc-xml-single-docbook
@echo "Generating pdf dblatex files..." @echo "Generating pdf dblatex files..."
dblatex $(DBLATEX_FLAGS) \ dblatex $(DBLATEX_FLAGS) -o ${manual_pdf} \
-o ${manual_pdf} ${top_srcdir}/doc/xml/spine.xml ${top_srcdir}/doc/xml/spine.xml
$(STAMP) stamp-pdf-docbook $(STAMP) stamp-pdf-docbook
doc-pdf-docbook: stamp-pdf-docbook doc-pdf-docbook: stamp-pdf-docbook
......
...@@ -393,6 +393,7 @@ xml_sources_manual = \ ...@@ -393,6 +393,7 @@ xml_sources_manual = \
${xml_dir}/manual/numerics.xml \ ${xml_dir}/manual/numerics.xml \
${xml_dir}/manual/parallel_mode.xml \ ${xml_dir}/manual/parallel_mode.xml \
${xml_dir}/manual/policy_data_structures.xml \ ${xml_dir}/manual/policy_data_structures.xml \
${xml_dir}/manual/policy_data_structures_biblio.xml \
${xml_dir}/manual/prerequisites.xml \ ${xml_dir}/manual/prerequisites.xml \
${xml_dir}/manual/profile_mode.xml \ ${xml_dir}/manual/profile_mode.xml \
${xml_dir}/manual/shared_ptr.xml \ ${xml_dir}/manual/shared_ptr.xml \
...@@ -528,17 +529,18 @@ XSL_HTML_STYLE = $(XSL_STYLE_DIR)/xhtml/chunk.xsl ...@@ -528,17 +529,18 @@ XSL_HTML_STYLE = $(XSL_STYLE_DIR)/xhtml/chunk.xsl
XSL_HTML_SINGLE_STYLE = $(XSL_STYLE_DIR)/html/docbook.xsl XSL_HTML_SINGLE_STYLE = $(XSL_STYLE_DIR)/html/docbook.xsl
XSL_EPUB_STYLE = $(XSL_STYLE_DIR)/epub3/chunk.xsl XSL_EPUB_STYLE = $(XSL_STYLE_DIR)/epub3/chunk.xsl
XSL_LOCAL_STYLE = ${glibcxx_builddir}/doc/xsl/customization.xsl XSL_LOCAL_STYLE = ${glibcxx_builddir}/doc/xsl/customization.xsl
LINT_FLAGS = --debug --xinclude --noent --noblanks --noout
SCHEMA_FLAGS = http://www.docbook.org/xml/5.0/dtd/docbook.dtd
#SCHEMA_FLAGS = --nonet /usr/share/xml/docbook5/schema/dtd/5.0/docbook.dtd
XMLLINT_VALID_FLAGS = $(LINT_FLAGS) --dtdvalid $(SCHEMA_FLAGS)
XMLLINT_FLAGS = --xinclude --nsclean --c14n --noent --noblanks --nocdata
# XML, all one page # XML, all one page
# Some info on canonicalization # Some info on canonicalization
# http://www.mail-archive.com/help-texinfo@gnu.org/msg00864.html # http://www.mail-archive.com/help-texinfo@gnu.org/msg00864.html
manual_xml = ${docbook_outdir}/xml/libstdc++-manual.xml manual_xml = ${docbook_outdir}/xml/libstdc++-manual.xml
set_xml = ${docbook_outdir}/xml/libstdc++-set.xml set_xml = ${docbook_outdir}/xml/libstdc++-set.xml
LINT_FLAGS = --debug --xinclude --noent --noblanks --noout
SCHEMA_FLAGS = --dtdvalid http://www.docbook.org/xml/5.0/dtd/docbook.dtd
SCHEMA_RNG_FLAGS = --relaxng http://www.docbook.org/xml/5.0/rng/docbook.rng
#SCHEMA_FLAGS = --nonet --dtdvalid /usr/share/xxx/dtd/5.0/docbook.dtd
XMLLINT_VALID_FLAGS = $(LINT_FLAGS) $(SCHEMA_FLAGS)
XMLLINT_FLAGS = --xinclude --nsclean --c14n --noent --noblanks --nocdata
# HTML, all one page # HTML, all one page
# NB: Have to generate customization XSL for UTF-8 output. # NB: Have to generate customization XSL for UTF-8 output.
...@@ -546,7 +548,7 @@ manual_html = ${docbook_outdir}/html/libstdc++-manual-single.html ...@@ -546,7 +548,7 @@ manual_html = ${docbook_outdir}/html/libstdc++-manual-single.html
# PDF, via dblatex # PDF, via dblatex
manual_pdf = ${docbook_outdir}/pdf/libstdc++-manual.pdf manual_pdf = ${docbook_outdir}/pdf/libstdc++-manual.pdf
DBLATEX_FLAGS = --dump --verbose --pdf DBLATEX_FLAGS = --verbose --pdf --dump --debug --tmpdir=${docbook_outdir}/latex
# TEXINFO, via docbook2X # TEXINFO, via docbook2X
# NB: Both experimental and tempermental # NB: Both experimental and tempermental
...@@ -896,14 +898,14 @@ ${docbook_outdir}/html: ...@@ -896,14 +898,14 @@ ${docbook_outdir}/html:
${docbook_outdir}/pdf: ${docbook_outdir}/pdf:
mkdir -p ${docbook_outdir}/pdf mkdir -p ${docbook_outdir}/pdf
${docbook_outdir}/latex:
mkdir -p ${docbook_outdir}/latex
${docbook_outdir}/texinfo: ${docbook_outdir}/texinfo:
mkdir -p ${docbook_outdir}/texinfo mkdir -p ${docbook_outdir}/texinfo
${docbook_outdir}/xml: ${docbook_outdir}/xml:
mkdir -p ${docbook_outdir}/xml mkdir -p ${docbook_outdir}/xml
doc-xml-validate-docbook: $(xml_sources) $(xml_images)
@echo "Generating XML validation log..."
$(XMLLINT) $(XMLLINT_VALID_FLAGS) ${top_srcdir}/doc/xml/spine.xml
stamp-xml-single-docbook: $(xml_sources) ${docbook_outdir}/xml stamp-xml-single-docbook: $(xml_sources) ${docbook_outdir}/xml
@echo "Generating XML single..." @echo "Generating XML single..."
$(XMLLINT) $(XMLLINT_FLAGS) \ $(XMLLINT) $(XMLLINT_FLAGS) \
...@@ -913,6 +915,15 @@ stamp-xml-single-docbook: $(xml_sources) ${docbook_outdir}/xml ...@@ -913,6 +915,15 @@ stamp-xml-single-docbook: $(xml_sources) ${docbook_outdir}/xml
$(STAMP) stamp-xml-single-docbook $(STAMP) stamp-xml-single-docbook
doc-xml-single-docbook: stamp-xml-single-docbook doc-xml-single-docbook: stamp-xml-single-docbook
doc-xml-validate-docbook: doc-xml-validate-dtd-db
doc-xml-validate-dtd-db: $(xml_sources) $(xml_images)
@echo "Generating XML validation log..."
$(XMLLINT) $(XMLLINT_VALID_FLAGS) ${top_srcdir}/doc/xml/spine.xml
doc-xml-validate-rng-db: $(xml_sources) $(xml_images) doc-xml-single-docbook
@echo "Generating XML RelaxNG validation log..."
$(XMLLINT) $(LINT_FLAGS) $(SCHEMA_RNG_FLAGS) ${set_xml}
# HTML support files # HTML support files
stamp-html-docbook-images: stamp-html-docbook $(xml_images) stamp-html-docbook-images: stamp-html-docbook $(xml_images)
...@@ -953,10 +964,15 @@ stamp-fo-docbook: $(xml_sources) ${docbook_outdir}/fo ...@@ -953,10 +964,15 @@ stamp-fo-docbook: $(xml_sources) ${docbook_outdir}/fo
$(STAMP) stamp-fo-docbook $(STAMP) stamp-fo-docbook
doc-fo-docbook: stamp-fo-docbook doc-fo-docbook: stamp-fo-docbook
stamp-pdf-docbook: $(xml_sources) ${docbook_outdir}/pdf
doc-pdf-docbook-dirs: ${docbook_outdir}/pdf ${docbook_outdir}/latex
doc-pdf-docbook-pre: $(xml_sources) doc-pdf-docbook-dirs
stamp-pdf-docbook: doc-pdf-docbook-pre doc-xml-single-docbook
@echo "Generating pdf dblatex files..." @echo "Generating pdf dblatex files..."
dblatex $(DBLATEX_FLAGS) \ dblatex $(DBLATEX_FLAGS) -o ${manual_pdf} \
-o ${manual_pdf} ${top_srcdir}/doc/xml/spine.xml ${top_srcdir}/doc/xml/spine.xml
$(STAMP) stamp-pdf-docbook $(STAMP) stamp-pdf-docbook
doc-pdf-docbook: stamp-pdf-docbook doc-pdf-docbook: stamp-pdf-docbook
......
...@@ -256,15 +256,15 @@ in the build directory starts the build process. The <literal>all</literal> targ ...@@ -256,15 +256,15 @@ in the build directory starts the build process. The <literal>all</literal> targ
<para> <para>
All the GLIBCXX_ENABLE_FOO macros use a common helper, All the <literal>GLIBCXX_ENABLE_FOO</literal> macros use a common
GLIBCXX_ENABLE. (You don't have to use it, but it's easy.) The helper, <literal>GLIBCXX_ENABLE</literal>. (You don't have to use
helper does two things for us: it, but it's easy.) The helper does two things for us:
</para> </para>
<orderedlist> <orderedlist>
<listitem> <listitem>
<para> <para>
Builds the call to the AC_ARG_ENABLE macro, with --help text Builds the call to the <literal>AC_ARG_ENABLE</literal> macro, with --help text
properly quoted and aligned. (Death to changequote!) properly quoted and aligned. (Death to changequote!)
</para> </para>
</listitem> </listitem>
...@@ -272,7 +272,7 @@ in the build directory starts the build process. The <literal>all</literal> targ ...@@ -272,7 +272,7 @@ in the build directory starts the build process. The <literal>all</literal> targ
<para> <para>
Checks the result against a list of allowed possibilities, and Checks the result against a list of allowed possibilities, and
signals a fatal error if there's no match. This means that the signals a fatal error if there's no match. This means that the
rest of the GLIBCXX_ENABLE_FOO macro doesn't need to test for rest of the <literal>GLIBCXX_ENABLE_FOO</literal> macro doesn't need to test for
strange arguments, nor do we need to protect against strange arguments, nor do we need to protect against
empty/whitespace strings with the <code>"x$foo" = "xbar"</code> empty/whitespace strings with the <code>"x$foo" = "xbar"</code>
idiom. idiom.
...@@ -319,13 +319,13 @@ in the build directory starts the build process. The <literal>all</literal> targ ...@@ -319,13 +319,13 @@ in the build directory starts the build process. The <literal>all</literal> targ
not pass --enable/--disable. It should be one of the permitted not pass --enable/--disable. It should be one of the permitted
values passed later. Examples: <code>[yes]</code>, or values passed later. Examples: <code>[yes]</code>, or
<code>[bar]</code>, or <code>[$1]</code> (which passes the <code>[bar]</code>, or <code>[$1]</code> (which passes the
argument given to the GLIBCXX_ENABLE_FOO macro as the argument given to the <literal>GLIBCXX_ENABLE_FOO</literal> macro
default). as the default).
</para> </para>
<para> <para>
For cases where we need to probe for particular models of things, For cases where we need to probe for particular models of things,
it is useful to have an undocumented "auto" value here (see it is useful to have an undocumented "auto" value here (see
GLIBCXX_ENABLE_CLOCALE for an example). <literal>GLIBCXX_ENABLE_CLOCALE</literal> for an example).
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
......
...@@ -102,14 +102,10 @@ ...@@ -102,14 +102,10 @@
in the following directories: in the following directories:
</para> </para>
<para> <para>
<filename class="directory"> <filename>doc/libstdc++/libstdc++-api.html</filename>
doc/libstdc++/libstdc++-api.html
</filename>
</para> </para>
<para> <para>
<filename class="directory"> <filename>doc/libstdc++/libstdc++-manual.html</filename>
doc/libstdc++/libstdc++-manual.html
</filename>
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
...@@ -346,6 +342,64 @@ ...@@ -346,6 +342,64 @@
</section> </section>
<section xml:id="doxygen.debug">
<info><title>Debugging Generation</title></info>
<para>
Sometimes, mis-configuration of the pre-requisite tools can
lead to errors when attempting to build the
documentation. Here are some of the obvious errors, and ways
to fix some common issues that may appear quite cryptic.
</para>
<para>
First, if using a rule like <code>make pdf</code>, try to
narrow down the scope of the error to either docbook
(<code>make doc-pdf-docbook</code>) or doxygen (<code>make
doc-pdf-doxygen</code>).
</para>
<para>
Working on the doxygen path only, closely examine the
contents of the following build directory:
<filename>build/target/libstdc++-v3/doc/doxygen/latex</filename>.
Pay attention to three files enclosed within, annotated as follows.
</para>
<itemizedlist>
<listitem>
<para>
<emphasis>refman.tex</emphasis>
</para>
<para>
The actual latex file, or partial latex file. This is generated
via <command>doxygen</command>, and is the LaTeX version of the
Doxygen XML file <filename>libstdc++-api.xml</filename>. Go to a specific
line, and look at the genrated LaTeX, and try to deduce what
markup in <filename>libstdc++-api.xml</filename> is causing it.
</para>
</listitem>
<listitem>
<para>
<emphasis>refman.out</emphasis>
<para>
A log of the compilation of the converted LaTeX form to pdf. This
is a linear list, from the beginning of the
<filename>refman.tex</filename> file: the last entry of this file
should be the end of the LaTeX file. If it is truncated, then you
know that the last entry is the last part of the generated LaTeX
source file that is valid. Often this file contains an error with
a specific line number of <filename>refman.tex</filename> that is
incorrect, or will have clues at the end of the file with the dump
of the memory usage of LaTeX.
</para>
</para>
</listitem>
</itemizedlist>
</section>
<section xml:id="doxygen.markup"><info><title>Markup</title></info> <section xml:id="doxygen.markup"><info><title>Markup</title></info>
...@@ -742,6 +796,95 @@ make <literal>XSL_STYLE_DIR="/usr/share/xml/docbook/stylesheet/nwalsh"</literal> ...@@ -742,6 +796,95 @@ make <literal>XSL_STYLE_DIR="/usr/share/xml/docbook/stylesheet/nwalsh"</literal>
</section> </section>
<section xml:id="docbook.debug">
<info><title>Debugging Generation</title></info>
<para>
Sometimes, mis-configuration of the pre-requisite tools can
lead to errors when attempting to build the
documentation. Here are some of the obvious errors, and ways
to fix some common issues that may appear quite cryptic.
</para>
<para>
First, if using a rule like <code>make pdf</code>, try to
narrow down the scope of the error to either docbook
(<code>make doc-pdf-docbook</code>) or doxygen (<code>make
doc-pdf-doxygen</code>).
</para>
<para>
Working on the docbook path only, closely examine the
contents of the following build directory:
<filename>build/target/libstdc++-v3/doc/docbook/latex</filename>.
Pay attention to three files enclosed within, annotated as follows.
</para>
<itemizedlist>
<listitem>
<para>
<emphasis>spine.tex</emphasis>
</para>
<para>
The actual latex file, or partial latex file. This is generated
via <command>dblatex</command>, and is the LaTeX version of the
DocBook XML file <filename>spine.xml</filename>. Go to a specific
line, and look at the genrated LaTeX, and try to deduce what
markup in <filename>spine.xml</filename> is causing it.
</para>
</listitem>
<listitem>
<para>
<emphasis>spine.out</emphasis>
</para>
<para>
A log of the conversion from the XML form to the LaTeX form. This
is a linear list, from the beginning of the
<filename>spine.xml</filename> file: the last entry of this file
should be the end of the DocBook file. If it is truncated, then
you know that the last entry is the last part of the XML source
file that is valid. The error is after this point.
</para>
</listitem>
<listitem>
<para>
<emphasis>spine.log</emphasis>
</para>
<para>
A log of the compilation of the converted LaTeX form to pdf. This
is a linear list, from the beginning of the
<filename>spine.tex</filename> file: the last entry of this file
should be the end of the LaTeX file. If it is truncated, then you
know that the last entry is the last part of the generated LaTeX
source file that is valid. Often this file contains an error with
a specific line number of <filename>spine.tex</filename> that is
incorrect.
</para>
</listitem>
</itemizedlist>
<para>
If the issue is not obvious after examination, or if one
encounters the inscruitable <quote>Incomplete
\ifmmode</quote> error, a fall-back strategy is to start
commenting out parts of the XML document (regardless of what
this does to over-all document validity). Start by
commenting out each of the largest parts of the
<filename>spine.xml</filename> file, section by section,
until the offending section is identified.
</para>
</section>
<section xml:id="docbook.validation"><info><title>Editing and Validation</title></info> <section xml:id="docbook.validation"><info><title>Editing and Validation</title></info>
<para> <para>
......
...@@ -35,7 +35,8 @@ ...@@ -35,7 +35,8 @@
several sources, each checking only some containers.</para> several sources, each checking only some containers.</para>
<para>For more details, consult the files in <para>For more details, consult the files in
<filename>testsuite/ext/pb_ds/regression</filename>.</para> <filename class="directory">testsuite/ext/pb_ds/regression</filename>.
</para>
</section> </section>
<!-- S02 performance --> <!-- S02 performance -->
...@@ -68,16 +69,12 @@ ...@@ -68,16 +69,12 @@
the number of values inserted.</para> the number of values inserted.</para>
<para> <para>
It uses the test file: It uses the test file:
<filename> <filename>performance/ext/pb_ds/text_find_timing_test.cc</filename>
performance/ext/pb_ds/text_find_timing_test.cc
</filename>
</para> </para>
<para> <para>
And uses the data file: And uses the data file:
<filename> <filename>filethirty_years_among_the_dead_preproc.txt</filename>
filethirty_years_among_the_dead_preproc.txt
</filename>
</para> </para>
<para>The test checks the effect of different range-hashing <para>The test checks the effect of different range-hashing
...@@ -398,9 +395,7 @@ ...@@ -398,9 +395,7 @@
<para> <para>
It uses the test file: It uses the test file:
<filename> <filename>performance/ext/pb_ds/random_int_find_timing.cc</filename>
performance/ext/pb_ds/random_int_find_timing.cc
</filename>
</para> </para>
<para>The test checks the effect of different underlying <para>The test checks the effect of different underlying
...@@ -917,9 +912,7 @@ ...@@ -917,9 +912,7 @@
<para> <para>
It uses the test file: It uses the test file:
<filename> <filename>performance/ext/pb_ds/random_int_subscript_find_timing.cc</filename>
performance/ext/pb_ds/random_int_subscript_find_timing.cc
</filename>
</para> </para>
<para>The test checks the effect of different underlying <para>The test checks the effect of different underlying
...@@ -1416,9 +1409,7 @@ ...@@ -1416,9 +1409,7 @@
<para> <para>
It uses the test file: It uses the test file:
<filename> <filename>performance/ext/pb_ds/random_int_subscript_insert_timing.cc</filename>
performance/ext/pb_ds/random_int_subscript_insert_timing.cc
</filename>
</para> </para>
<para>The test checks the effect of different underlying <para>The test checks the effect of different underlying
...@@ -1955,9 +1946,7 @@ ...@@ -1955,9 +1946,7 @@
<para> <para>
It uses the test file: It uses the test file:
<filename> <filename>performance/ext/pb_ds/hash_zlob_random_int_find_timing.cc</filename>
performance/ext/pb_ds/hash_zlob_random_int_find_timing.cc
</filename>
</para> </para>
<para>The test checks the effect of different range-hashing <para>The test checks the effect of different range-hashing
...@@ -2254,9 +2243,7 @@ ...@@ -2254,9 +2243,7 @@
<para> <para>
It uses the test file: It uses the test file:
<filename> <filename>performance/ext/pb_ds/hash_random_int_erase_mem_usage.cc</filename>
performance/ext/pb_ds/hash_random_int_erase_mem_usage.cc
</filename>
</para> </para>
...@@ -2536,9 +2523,7 @@ ...@@ -2536,9 +2523,7 @@
<para> <para>
It uses the test file: It uses the test file:
<filename> <filename>performance/ext/pb_ds/tree_text_insert_timing.cc</filename>
performance/ext/pb_ds/tree_text_insert_timing.cc
</filename>
</para> </para>
...@@ -2912,9 +2897,7 @@ ...@@ -2912,9 +2897,7 @@
<para> <para>
It uses the test file: It uses the test file:
<filename> <filename>performance/ext/pb_ds/text_find_timing.cc</filename>
performance/ext/pb_ds/text_find_timing.cc
</filename>
</para> </para>
...@@ -3185,9 +3168,7 @@ ...@@ -3185,9 +3168,7 @@
<para> <para>
It uses the test file: It uses the test file:
<filename> <filename>performance/ext/pb_ds/tree_text_lor_find_timing.cc</filename>
performance/ext/pb_ds/tree_text_lor_find_timing.cc
</filename>
</para> </para>
<para>The test checks the effect of different underlying <para>The test checks the effect of different underlying
...@@ -3424,9 +3405,7 @@ ...@@ -3424,9 +3405,7 @@
<para> <para>
It uses the test file: It uses the test file:
<filename> <filename>performance/ext/pb_ds/tree_split_join_timing.cc</filename>
performance/ext/pb_ds/tree_split_join_timing.cc
</filename>
</para> </para>
...@@ -3688,9 +3667,7 @@ ...@@ -3688,9 +3667,7 @@
<para> <para>
It uses the test file: It uses the test file:
<filename> <filename>performance/ext/pb_ds/tree_order_statistics_timing.cc</filename>
performance/ext/pb_ds/tree_order_statistics_timing.cc
</filename>
</para> </para>
<para>The test checks the performance difference of policies based <para>The test checks the performance difference of policies based
...@@ -3885,9 +3862,7 @@ ...@@ -3885,9 +3862,7 @@
<para> <para>
It uses the test file: It uses the test file:
<filename> <filename>performance/ext/pb_ds/multimap_text_find_timing_small.cc</filename>
performance/ext/pb_ds/multimap_text_find_timing_small.cc
</filename>
</para> </para>
<para>The test checks the find-time scalability of different <para>The test checks the find-time scalability of different
...@@ -4350,9 +4325,7 @@ ...@@ -4350,9 +4325,7 @@
<para> <para>
It uses the test file: It uses the test file:
<filename> <filename>performance/ext/pb_ds/multimap_text_find_timing_large.cc</filename>
performance/ext/pb_ds/multimap_text_find_timing_large.cc
</filename>
</para> </para>
<para>The test checks the find-time scalability of different <para>The test checks the find-time scalability of different
...@@ -4819,9 +4792,7 @@ ...@@ -4819,9 +4792,7 @@
<para> <para>
It uses the test file: It uses the test file:
<filename> <filename>performance/ext/pb_ds/multimap_text_insert_timing_small.cc</filename>
performance/ext/pb_ds/multimap_text_insert_timing_small.cc
</filename>
</para> </para>
<para>The test checks the insert-time scalability of different <para>The test checks the insert-time scalability of different
...@@ -5288,9 +5259,7 @@ ...@@ -5288,9 +5259,7 @@
<para> <para>
It uses the test file: It uses the test file:
<filename> <filename>performance/ext/pb_ds/multimap_text_insert_timing_large.cc</filename>
performance/ext/pb_ds/multimap_text_insert_timing_large.cc
</filename>
</para> </para>
<para>The test checks the insert-time scalability of different <para>The test checks the insert-time scalability of different
...@@ -5751,9 +5720,7 @@ ...@@ -5751,9 +5720,7 @@
<para> <para>
It uses the test file: It uses the test file:
<filename> <filename>performance/ext/pb_ds/multimap_text_insert_mem_usage_small.cc</filename>
performance/ext/pb_ds/multimap_text_insert_mem_usage_small.cc
</filename>
</para> </para>
<para>The test checks the memory scalability of different <para>The test checks the memory scalability of different
...@@ -6213,9 +6180,7 @@ ...@@ -6213,9 +6180,7 @@
<para> <para>
It uses the test file: It uses the test file:
<filename> <filename>performance/ext/pb_ds/multimap_text_insert_mem_usage_large.cc</filename>
performance/ext/pb_ds/multimap_text_insert_mem_usage_large.cc
</filename>
</para> </para>
<para>The test checks the memory scalability of different <para>The test checks the memory scalability of different
...@@ -6675,9 +6640,7 @@ ...@@ -6675,9 +6640,7 @@
<para> <para>
It uses the test file: It uses the test file:
<filename> <filename>performance/ext/pb_ds/priority_queue_text_push_timing.cc</filename>
performance/ext/pb_ds/priority_queue_text_push_timing.cc
</filename>
</para> </para>
<para>The test checks the effect of different underlying data <para>The test checks the effect of different underlying data
...@@ -7062,9 +7025,7 @@ ...@@ -7062,9 +7025,7 @@
<para> <para>
It uses the test file: It uses the test file:
<filename> <filename>performance/ext/pb_ds/priority_queue_text_push_pop_timing.cc</filename>
performance/ext/pb_ds/priority_queue_text_push_pop_timing.cc
</filename>
</para> </para>
<para>The test checks the effect of different underlying data <para>The test checks the effect of different underlying data
...@@ -7429,9 +7390,7 @@ ...@@ -7429,9 +7390,7 @@
<para> <para>
It uses the test file: It uses the test file:
<filename> <filename>performance/ext/pb_ds/priority_queue_random_int_push_timing.cc</filename>
performance/ext/pb_ds/priority_queue_random_int_push_timing.cc
</filename>
</para> </para>
<para>The test checks the effect of different underlying data <para>The test checks the effect of different underlying data
...@@ -7785,9 +7744,7 @@ ...@@ -7785,9 +7744,7 @@
<para> <para>
It uses the test file: It uses the test file:
<filename> <filename>performance/ext/pb_ds/priority_queue_random_int_push_pop_timing.cc</filename>
performance/ext/pb_ds/priority_queue_random_int_push_pop_timing.cc
</filename>
</para> </para>
<para>The test checks the effect of different underlying data <para>The test checks the effect of different underlying data
...@@ -8050,9 +8007,7 @@ ...@@ -8050,9 +8007,7 @@
number of values pushed to the container.</para> number of values pushed to the container.</para>
<para> <para>
It uses the test file: It uses the test file:
<filename> <filename>performance/ext/pb_ds/priority_queue_text_pop_mem_usage.cc</filename>
performance/ext/pb_ds/priority_queue_text_pop_mem_usage.cc
</filename>
</para> </para>
<para>The test checks the effect of different underlying data <para>The test checks the effect of different underlying data
...@@ -8302,9 +8257,7 @@ ...@@ -8302,9 +8257,7 @@
the average time as a function of the number of values.</para> the average time as a function of the number of values.</para>
<para> <para>
It uses the test file: It uses the test file:
<filename> <filename>performance/ext/pb_ds/priority_queue_text_join_timing.cc</filename>
performance/ext/pb_ds/priority_queue_text_join_timing.cc
</filename>
</para> </para>
<para>The test checks the effect of different underlying data <para>The test checks the effect of different underlying data
...@@ -8554,9 +8507,7 @@ ...@@ -8554,9 +8507,7 @@
<para> <para>
It uses the test file: It uses the test file:
<filename> <filename>performance/ext/pb_ds/priority_queue_text_modify_up_timing.cc</filename>
performance/ext/pb_ds/priority_queue_text_modify_up_timing.cc
</filename>
</para> </para>
<para>The test checks the effect of different underlying data <para>The test checks the effect of different underlying data
...@@ -8920,9 +8871,7 @@ ...@@ -8920,9 +8871,7 @@
<para> <para>
It uses the test file: It uses the test file:
<filename> <filename>performance/ext/pb_ds/priority_queue_text_modify_down_timing.cc</filename>
performance/ext/pb_ds/priority_queue_text_modify_down_timing.cc
</filename>
</para> </para>
<para>The main purpose of this test is to contrast Priority Queue <para>The main purpose of this test is to contrast Priority Queue
...@@ -9771,4 +9720,4 @@ ...@@ -9771,4 +9720,4 @@
</section> <!-- performance --> </section> <!-- performance -->
</section> </section>
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment