OpenE2K
/
gcc
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Improve documentation of libstdc++ test targets 

* doc/xml/manual/test.xml: Improve documentation of test targets.
	Document new-abi-baseline, check-debug, and check-parallel targets.

From-SVN: r239573
This commit is contained in:
Jonathan Wakely 2016-08-18 14:47:37 +01:00 committed by Jonathan Wakely
parent 409d55557b
commit b56d48ef86
2 changed files with 116 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
libstdc++-v3/ChangeLog
View File

@ -1,5 +1,8 @@
2016-08-18 Jonathan Wakely <jwakely@redhat.com>
* doc/xml/manual/test.xml: Improve documentation of test targets.
Document new-abi-baseline, check-debug, and check-parallel targets.
* doc/xml/manual/build_hacking.xml: New section on shared library
versioning.

167
libstdc++-v3/doc/xml/manual/test.xml
View File

@ -386,104 +386,163 @@ cat 27_io/objects/char/3_xin.in | a.out</programlisting>
following:
</para>
<programlisting>
<variablelist>
<varlistentry>
<term><userinput>
make testsuite_files
</programlisting>
</userinput></term>>
<listitem>
<para>
Five files are generated that determine what test files
are run. These files are:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis>testsuite_files</emphasis>
</para>
<para>
<variablelist>
<varlistentry>
<term> <filename>testsuite_files</filename> </term>
<listitem>
This is a list of all the test cases that will be run. Each
test case is on a separate line, given with an absolute path
from the <emphasis>libsrcdir/testsuite</emphasis> directory.
</para>
</listitem>
from the
<filename class="directory"><replaceable>libsrcdir</replaceable>/testsuite</filename>
directory.
</listitem>
</varlistentry>
<listitem>
<para>
<emphasis>testsuite_files_interactive</emphasis>
</para>
<para>
<varlistentry>
<term> <filename>testsuite_files_interactive</filename> </term>
<listitem>
This is a list of all the interactive test cases, using the
same format as the file list above. These tests are not run
by default.
</para>
</listitem>
</listitem>
</varlistentry>
<listitem>
<para>
<emphasis>testsuite_files_performance</emphasis>
</para>
<para>
<varlistentry>
<term> <filename>testsuite_files_performance</filename> </term>
<listitem>
This is a list of all the performance test cases, using the
same format as the file list above. These tests are not run
by default.
</para>
</listitem>
</listitem>
</varlistentry>
<listitem>
<para>
<emphasis>testsuite_thread</emphasis>
</para>
<para>
<varlistentry>
<term> <filename>testsuite_thread</filename> </term>
<listitem>
This file indicates that the host system can run tests which
involved multiple threads.
</para>
</listitem>
</listitem>
</varlistentry>
<listitem>
<para>
<emphasis>testsuite_wchar_t</emphasis>
</para>
<para>
This file indicates that the host system can run the wchar_t
tests, and corresponds to the macro definition <code>
_GLIBCXX_USE_WCHAR_T</code> in the file c++config.h.
</para>
</listitem>
</itemizedlist>
<varlistentry>
<term> <filename>testsuite_wchar_t</filename> </term>
<listitem>
This file indicates that the host system can run the
<code>wchar_t</code> tests, and corresponds to the macro
definition <literal>_GLIBCXX_USE_WCHAR_T</literal> in the
file <filename>c++config.h</filename>.
</listitem>
</varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
<programlisting>
<varlistentry>
<term><userinput>
make check-abi
</programlisting>
</userinput></term>>
<listitem>
<para>
The library ABI can be tested. This involves testing the shared
library against an ABI-defining previous version of symbol
exports.
library against a baseline list of symbol exports that defines the
previous version of the ABI. The tests require that no exported
symbols are removed, no new symbols are added to the old symbol
versions, and any new symbols have the latest symbol version.
See <link linkend="abi.versioning">Versioning</link> for more details
of the ABI version history.
</para>
</listitem>
</varlistentry>
<programlisting>
<varlistentry>
<term><userinput>
make new-abi-baseline
</userinput></term>>
<listitem>
<para>
Generate a new baseline set of symbols exported from the library
(written to a file under
<filename class="directory"><replaceable>libsrcdir</replaceable>/config/abi/post/<replaceable>target</replaceable>/</filename>).
A different baseline symbols file is needed for each architecture and
is used by the <literal>check-abi</literal> target described above.
The files are usually re-generated by target maintainers for releases.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>
make check-compile
</programlisting>
</userinput></term>>
<listitem>
<para>
This rule compiles, but does not link or execute, the
<emphasis>testsuite_files</emphasis> test cases and displays the
<filename>testsuite_files</filename> test cases and displays the
output on stdout.
</para>
</listitem>
</varlistentry>
<programlisting>
<varlistentry>
<term><userinput>
make check-performance
</programlisting>
</userinput></term>>
<listitem>
<para>
This rule runs through the
<emphasis>testsuite_files_performance</emphasis> test cases and
<filename>testsuite_files_performance</filename> test cases and
collects information for performance analysis and can be used to
spot performance regressions. Various timing information is
collected, as well as number of hard page faults, and memory
used. This is not run by default, and the implementation is in
flux.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>
make check-debug
</userinput></term>>
<listitem>
<para>
This rule runs through the test suite under the
<link linkend="manual.ext.debug_mode">debug mode</link>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput>
make check-parallel
</userinput></term>>
<listitem>
<para>
This rule runs through the test suite under the
<link linkend="manual.ext.parallel_mode">parallel mode</link>.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
We are interested in any strange failures of the testsuite;