Skip to content

R
riscv-gcc-1
Commit b56d48ef by Jonathan Wakely Committed by Jonathan Wakely
Options

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
parent 409d5555
Showing with 118 additions and 56 deletions
libstdc++-v3/ChangeLog
2016-08-18 Jonathan Wakely <jwakely@redhat.com> 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 * doc/xml/manual/build_hacking.xml: New section on shared library
versioning. versioning.
......
libstdc++-v3/doc/xml/manual/test.xml
...@@ -386,104 +386,163 @@ cat 27_io/objects/char/3_xin.in | a.out</programlisting> ...@@ -386,104 +386,163 @@ cat 27_io/objects/char/3_xin.in | a.out</programlisting>
following: following:
</para> </para>
<programlisting> <variablelist>
<varlistentry>
<term><userinput>
make testsuite_files make testsuite_files
</programlisting> </userinput></term>>
<listitem>
<para> <para>
Five files are generated that determine what test files Five files are generated that determine what test files
are run. These files are: are run. These files are:
</para>
<itemizedlist> <variablelist>
<listitem> <varlistentry>
<para> <term> <filename>testsuite_files</filename> </term>
<emphasis>testsuite_files</emphasis> <listitem>
</para>
<para>
This is a list of all the test cases that will be run. Each 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 test case is on a separate line, given with an absolute path
from the <emphasis>libsrcdir/testsuite</emphasis> directory. from the
</para> <filename class="directory"><replaceable>libsrcdir</replaceable>/testsuite</filename>
</listitem> directory.
</listitem>
<listitem> </varlistentry>
<para>
<emphasis>testsuite_files_interactive</emphasis> <varlistentry>
</para> <term> <filename>testsuite_files_interactive</filename> </term>
<para> <listitem>
This is a list of all the interactive test cases, using the This is a list of all the interactive test cases, using the
same format as the file list above. These tests are not run same format as the file list above. These tests are not run
by default. by default.
</para> </listitem>
</listitem> </varlistentry>
<listitem> <varlistentry>
<para> <term> <filename>testsuite_files_performance</filename> </term>
<emphasis>testsuite_files_performance</emphasis> <listitem>
</para>
<para>
This is a list of all the performance test cases, using the This is a list of all the performance test cases, using the
same format as the file list above. These tests are not run same format as the file list above. These tests are not run
by default. by default.
</para> </listitem>
</listitem> </varlistentry>
<listitem> <varlistentry>
<para> <term> <filename>testsuite_thread</filename> </term>
<emphasis>testsuite_thread</emphasis> <listitem>
</para>
<para>
This file indicates that the host system can run tests which This file indicates that the host system can run tests which
involved multiple threads. involved multiple threads.
</para> </listitem>
</listitem> </varlistentry>
<listitem> <varlistentry>
<para> <term> <filename>testsuite_wchar_t</filename> </term>
<emphasis>testsuite_wchar_t</emphasis> <listitem>
</para> This file indicates that the host system can run the
<para> <code>wchar_t</code> tests, and corresponds to the macro
This file indicates that the host system can run the wchar_t definition <literal>_GLIBCXX_USE_WCHAR_T</literal> in the
tests, and corresponds to the macro definition <code> file <filename>c++config.h</filename>.
_GLIBCXX_USE_WCHAR_T</code> in the file c++config.h. </listitem>
</para> </varlistentry>
</listitem> </variablelist>
</itemizedlist> </para>
</listitem>
</varlistentry>
<programlisting> <varlistentry>
<term><userinput>
make check-abi make check-abi
</programlisting> </userinput></term>>
<listitem>
<para> <para>
The library ABI can be tested. This involves testing the shared The library ABI can be tested. This involves testing the shared
library against an ABI-defining previous version of symbol library against a baseline list of symbol exports that defines the
exports. 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>
<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> </para>
</listitem>
</varlistentry>
<programlisting> <varlistentry>
<term><userinput>
make check-compile make check-compile
</programlisting> </userinput></term>>
<listitem>
<para> <para>
This rule compiles, but does not link or execute, the 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. output on stdout.
</para> </para>
</listitem>
</varlistentry>
<programlisting> <varlistentry>
<term><userinput>
make check-performance make check-performance
</programlisting> </userinput></term>>
<listitem>
<para> <para>
This rule runs through the 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 collects information for performance analysis and can be used to
spot performance regressions. Various timing information is spot performance regressions. Various timing information is
collected, as well as number of hard page faults, and memory collected, as well as number of hard page faults, and memory
used. This is not run by default, and the implementation is in used. This is not run by default, and the implementation is in
flux. flux.
</para> </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> <para>
We are interested in any strange failures of the testsuite; We are interested in any strange failures of the testsuite;
......
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