From b56d48ef86bea5622de8074c6fabee7c3c0646ef Mon Sep 17 00:00:00 2001 From: Jonathan Wakely Date: Thu, 18 Aug 2016 14:47:37 +0100 Subject: [PATCH] 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 --- libstdc++-v3/ChangeLog | 3 + libstdc++-v3/doc/xml/manual/test.xml | 171 ++++++++++++++++++--------- 2 files changed, 118 insertions(+), 56 deletions(-) diff --git a/libstdc++-v3/ChangeLog b/libstdc++-v3/ChangeLog index b6628023cf5..5acc88e0293 100644 --- a/libstdc++-v3/ChangeLog +++ b/libstdc++-v3/ChangeLog @@ -1,5 +1,8 @@ 2016-08-18 Jonathan Wakely + * 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. diff --git a/libstdc++-v3/doc/xml/manual/test.xml b/libstdc++-v3/doc/xml/manual/test.xml index 740323ab57c..cbba3894786 100644 --- a/libstdc++-v3/doc/xml/manual/test.xml +++ b/libstdc++-v3/doc/xml/manual/test.xml @@ -386,104 +386,163 @@ cat 27_io/objects/char/3_xin.in | a.out following: - + + + make testsuite_files - + > + Five files are generated that determine what test files are run. These files are: - - - - - testsuite_files - - + + + testsuite_files + 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 libsrcdir/testsuite directory. - - - - - - testsuite_files_interactive - - + from the + libsrcdir/testsuite + directory. + + + + + testsuite_files_interactive + 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. - - + + - - - testsuite_files_performance - - + + testsuite_files_performance + 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. - - + + - - - testsuite_thread - - + + testsuite_thread + This file indicates that the host system can run tests which involved multiple threads. - - - - - - testsuite_wchar_t - - - This file indicates that the host system can run the wchar_t - tests, and corresponds to the macro definition - _GLIBCXX_USE_WCHAR_T in the file c++config.h. - - - + + + + + testsuite_wchar_t + + This file indicates that the host system can run the + wchar_t tests, and corresponds to the macro + definition _GLIBCXX_USE_WCHAR_T in the + file c++config.h. + + + + + + - + + make check-abi - + > + 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 Versioning for more details + of the ABI version history. + + + + + + + make new-abi-baseline + > + + + + Generate a new baseline set of symbols exported from the library + (written to a file under + libsrcdir/config/abi/post/target/). + A different baseline symbols file is needed for each architecture and + is used by the check-abi target described above. + The files are usually re-generated by target maintainers for releases. + + - + + make check-compile - + > + This rule compiles, but does not link or execute, the - testsuite_files test cases and displays the + testsuite_files test cases and displays the output on stdout. + + - + + make check-performance - + > + This rule runs through the - testsuite_files_performance test cases and + testsuite_files_performance 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. + + + + + + make check-debug + > + + + + This rule runs through the test suite under the + debug mode. + + + + + + + make check-parallel + > + + + + This rule runs through the test suite under the + parallel mode. + + + + + We are interested in any strange failures of the testsuite; -- 2.30.2