From 8127680935fcb1f9132ddc19efb154e0c2fb285e Mon Sep 17 00:00:00 2001 From: Gennadiy Rozental Date: Wed, 13 Jul 2005 05:02:28 +0000 Subject: [PATCH] *** empty log message *** [SVN r30028] --- .../execution_monitor/execution_aborted.html | 28 +++++++++ .../reference/BOOST_CHECK_SMALL.html | 49 ++++++++++++++++ .../test_tools/reference/BOOST_REQUIRE.html | 46 --------------- .../reference/BOOST_REQUIRE_PREDICATE.html | 51 ----------------- .../test_tools/reference/BOOST_WARN.html | 46 --------------- doc/components/utf/parameters/build_info.html | 4 +- .../utf/parameters/catch_system_errors.html | 5 +- .../utf/parameters/detect_memory_leaks.html | 57 +++++++++++++++++++ doc/components/utf/parameters/index.html | 15 +++-- doc/components/utf/parameters/log_format.html | 8 +-- doc/components/utf/parameters/log_level.html | 11 +--- .../utf/parameters/output_format.html | 8 +-- doc/components/utf/parameters/random.html | 52 +++++++++++++++++ .../utf/parameters/report_format.html | 7 +-- .../utf/parameters/report_level.html | 6 +- .../utf/parameters/show_progress.html | 49 ++++++++++++++++ 16 files changed, 266 insertions(+), 176 deletions(-) create mode 100644 doc/components/execution_monitor/execution_aborted.html create mode 100644 doc/components/test_tools/reference/BOOST_CHECK_SMALL.html delete mode 100644 doc/components/test_tools/reference/BOOST_REQUIRE.html delete mode 100644 doc/components/test_tools/reference/BOOST_REQUIRE_PREDICATE.html delete mode 100644 doc/components/test_tools/reference/BOOST_WARN.html create mode 100644 doc/components/utf/parameters/detect_memory_leaks.html create mode 100644 doc/components/utf/parameters/random.html create mode 100644 doc/components/utf/parameters/show_progress.html diff --git a/doc/components/execution_monitor/execution_aborted.html b/doc/components/execution_monitor/execution_aborted.html new file mode 100644 index 00000000..a1a53468 --- /dev/null +++ b/doc/components/execution_monitor/execution_aborted.html @@ -0,0 +1,28 @@ + + +boost::execution_aborted + + + + + + +
Boost.Test > Components > The + Execution Monitor > boost::execution_aborted
+
Boost Test logo +

boost::execution_aborted

+
struct execution_aborted {};
+
+

This is trivial default constructible class that is used to report gracefull execution abort.

+
+ + + diff --git a/doc/components/test_tools/reference/BOOST_CHECK_SMALL.html b/doc/components/test_tools/reference/BOOST_CHECK_SMALL.html new file mode 100644 index 00000000..314501a4 --- /dev/null +++ b/doc/components/test_tools/reference/BOOST_CHECK_SMALL.html @@ -0,0 +1,49 @@ + + +The Test Tools + + + + + + + +
+

BOOST_WARN_SMALL( val, tolerance )
+ BOOST_CHECK_CLOSE( val, tolerance )
+ BOOST_REQUIRE_CLOSE( val, tolerance )

+

These tools are used to check that supplied + values is small enough. The "smallness" is defined by absolute + value of the tolerance supplied as a second argument. Note that to use these + tools you need to include additional header + floating_point_comparison.hpp. Use these tools with caution. To compare + to values on closeness it's preferable to use BOOST_<level>_CLOSE tools.

+

The first parameter is the value to check. The + second parameter is the tolerance .

+

Example: test.cpp

+
int test_main( int, char* [] ) {
+    double v = -1.23456e-3;
+
+    BOOST_CHECK_SMALL( v, 0.000001 );
+    return 0;
+}
+

Output:

+

test.cpp(4) : error in test_main: absolute value of + v{1.23456e-3} exeeds 1e-06

+ +
+ + + diff --git a/doc/components/test_tools/reference/BOOST_REQUIRE.html b/doc/components/test_tools/reference/BOOST_REQUIRE.html deleted file mode 100644 index 795cc27d..00000000 --- a/doc/components/test_tools/reference/BOOST_REQUIRE.html +++ /dev/null @@ -1,46 +0,0 @@ - - -The Test Tools - - - - - - - -
-

BOOST_REQUIRE( predicate )

-

This tool is used to validate the predicate value and abort the current - test case processing if it fails.

-

If predicate evaluates to true, the tool produces a confirmation - message (note: to manage what messages appear in the test output stream set the proper log level), - in other case it produces an error message in a form "fatal error in <test case name>: - test <predicate> fail" and then abort the current test case processing.

-

The only parameter of this tool is the boolean predicate value that gets - validated. This could be any expression that could be evaluated and converted to boolean value. The - expression gets evaluated only once, so it's safe to pass complex expression for validation.

-

Example: test.cpp

-
int test_main( int, char* [] ) {
-    int i = 3;
-    BOOST_REQUIRE( i > 5 );
-    BOOST_CHECK( i == 6 ); // will never reach this check
-
-    return 0;
-}
-

Output:

-

test.cpp(3) : fatal error in test_main: test i>5 failed

-
-

See Also

-

BOOST_CHECK

-
-
- - - diff --git a/doc/components/test_tools/reference/BOOST_REQUIRE_PREDICATE.html b/doc/components/test_tools/reference/BOOST_REQUIRE_PREDICATE.html deleted file mode 100644 index b30e4d8e..00000000 --- a/doc/components/test_tools/reference/BOOST_REQUIRE_PREDICATE.html +++ /dev/null @@ -1,51 +0,0 @@ - - -The Test Tools - - - - - - - -
-

BOOST_REQUIRE_PREDICATE( predicate, arity, arguments_list )

-

This tool is used to validate the supplied predicate and abort the current - test case processing if it fails. This test tool is generic. It allows to validate arbitrary one or - two arity predicate. To validate zero or more then two arity predicate use BOOST_REQUIRE - tool. The advantage of this tool is that shows arguments values in case of predicate failure.

-

If predicate evaluates to true, the tool produces a confirmation - message (note: to manage what messages appear in the test output stream set the proper log level), - in other case it produces an error message in a form "error in <test case name>: test <predicate>( - arguments_list ) fail for (arguments values)" and abort the current test case processing.

-

Example: test.cpp

-
int test.cpp( int, char* [] ) {
-    double fp1     = 1.23456e-10;
-    double fp2     = 1.23457e-10;
-    double epsilon = 8.1e-6;
-
-    // check weak closeness 
-    BOOST_REQUIRE_PREDICATE( close_at_tolerance<double>( epsilon, false ),
-                             2, ( fp1, fp2 ) ); // should pass
-
-    return 0;
-}
-
-

Output:

- -

 

-
-

See Also

-

BOOST_REQUIRE

-
-
- - - diff --git a/doc/components/test_tools/reference/BOOST_WARN.html b/doc/components/test_tools/reference/BOOST_WARN.html deleted file mode 100644 index 9d350aa3..00000000 --- a/doc/components/test_tools/reference/BOOST_WARN.html +++ /dev/null @@ -1,46 +0,0 @@ - - -The Test Tools - - - - - - - -
-

BOOST_WARN( predicate )

-

This tool is used to perform a weak validation - of the predicate. This check failure does not cause the test case to fail, - but only warning message logged in test output stream. Use this tool to - validate aspects less important then correctness: performance, portability, - usability etc.

-

If predicate evaluates to true, the tool produces a confirmation - message (note: to manage what messages appear in the test output stream set the proper log level), - in other case it produces a warning message in a form "warning in <test case name>: condition - <predicate> is not satisfied"

-

Example: test.cpp

-
int test_main( int, char* [] ) {
-    BOOST_WARN( sizeof(int) == sizeof(short) );
-
-    return 0;
-}
-

Output:

-

test.cpp(2) : warning in test_main: condition sizeof(int) - == sizeof(short) is not satisfied -

-
-

See Also

-

BOOST_CHECK

-
-
- - - diff --git a/doc/components/utf/parameters/build_info.html b/doc/components/utf/parameters/build_info.html index 5a667397..943f0df9 100644 --- a/doc/components/utf/parameters/build_info.html +++ b/doc/components/utf/parameters/build_info.html @@ -9,7 +9,7 @@
Boost.Test > Components > The Unit Test Framework > > Parameters - > The build info + > Build info
Boost Test logo

The 'build info' parameter

@@ -44,7 +44,7 @@ Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at www.boost.org/LICENSE_1_0.txt)

-

Revised: 7 January, 2004

+

Revised: 13 July, 2005

diff --git a/doc/components/utf/parameters/catch_system_errors.html b/doc/components/utf/parameters/catch_system_errors.html index 12cd500b..87f742d2 100644 --- a/doc/components/utf/parameters/catch_system_errors.html +++ b/doc/components/utf/parameters/catch_system_errors.html @@ -8,7 +8,8 @@
Boost.Test > Components - > The Unit Test Framework > > Parameters > catch system errors
+ > The Unit Test Framework > > Parameters > Catch + system errors
Boost Test logo

The 'catch system errors' parameter

@@ -43,7 +44,7 @@ Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at www.boost.org/LICENSE_1_0.txt)

-

Revised: 7 January, 2004

+

Revised: 13 July, 2005

diff --git a/doc/components/utf/parameters/detect_memory_leaks.html b/doc/components/utf/parameters/detect_memory_leaks.html new file mode 100644 index 00000000..30d68bf6 --- /dev/null +++ b/doc/components/utf/parameters/detect_memory_leaks.html @@ -0,0 +1,57 @@ + + +The 'detect memory leaks' parameter + + + + + + +
Boost.Test > Components + > The Unit Test Framework > > Parameters + > Detect memory leaks
+
Boost Test logo +

The 'build info' parameter

+
+ + + + + + + + + + + + + + + + + + + + +
Parameter Name:detect memory leaks
Environment variable name:BOOST_TEST_DETECT_MEMORY_LEAK
Command line argument name:detect_memory_leak
Acceptable Values:0
+ 1
+ integer value > 1
Description:positive value tells the framework to detect the memory leaks (if any). + Any value greater then 1 in addition is treated as leak allocation number + and setup runtime breakpoint. In other words setting this parameter to + the positive value N greater than 1 causes the framework to set a breakpoint +at Nth memory allocation (don't do that from the command line - only when you + are under debugger). Note: if your test program produce memory leaks + notifications, they are combined with allocation number values you could + use to set a breakpoint. Currently only applies to MS family of compilers
+
+ + + diff --git a/doc/components/utf/parameters/index.html b/doc/components/utf/parameters/index.html index 4c5943ab..69d211a8 100644 --- a/doc/components/utf/parameters/index.html +++ b/doc/components/utf/parameters/index.html @@ -30,14 +30,17 @@ match the name in parameter specification.

Here is the list of all parameters:

diff --git a/doc/components/utf/parameters/log_format.html b/doc/components/utf/parameters/log_format.html index d6f66ad5..4a5d13be 100644 --- a/doc/components/utf/parameters/log_format.html +++ b/doc/components/utf/parameters/log_format.html @@ -8,8 +8,8 @@
Boost.Test > Components - > The Unit Test Framework > > Parameters > The - log format
+ > The Unit Test Framework > > Parameters > Log + format
Boost Test logo

The 'log format' parameter

@@ -43,7 +43,7 @@
Description: allows to select the unit test framework log format from the list of - formats supplied by the framework. To specify custom log format use unit_test_log + formats supplied by the framework. To specify custom log format use unit_test_log API.
@@ -54,7 +54,7 @@ Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at www.boost.org/LICENSE_1_0.txt)

-

Revised: 7 January, 2004

+

Revised: 13 July, 2005

diff --git a/doc/components/utf/parameters/log_level.html b/doc/components/utf/parameters/log_level.html index 4f362650..0e90a7e3 100644 --- a/doc/components/utf/parameters/log_level.html +++ b/doc/components/utf/parameters/log_level.html @@ -8,8 +8,8 @@
Boost.Test > Components - > The Unit Test Framework > > Parameters > The - log level
+ > The Unit Test Framework > > Parameters > Log + level
Boost Test logo

The 'log level' parameter

@@ -66,11 +66,6 @@ - - - - @@ -93,7 +88,7 @@ Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at www.boost.org/LICENSE_1_0.txt)

-

Revised: 7 January, 2004

+

Revised: 13 July, 2005

diff --git a/doc/components/utf/parameters/output_format.html b/doc/components/utf/parameters/output_format.html index 9d2b45b8..2a3136b5 100644 --- a/doc/components/utf/parameters/output_format.html +++ b/doc/components/utf/parameters/output_format.html @@ -8,8 +8,8 @@
Boost.Test > Components - > The Unit Test Framework > > Parameters > The - output format
+ > The Unit Test Framework > > Parameters > Output + format
Boost Test reporto

The 'output format' parameter

fatal_errors - report only user or system originated fatal errors (for example, memory access violation)
progress- report only progress information: number of run test cases vs. overall number of test - cases
nothing - does not report any information
@@ -42,7 +42,7 @@ - +
Description: combines an effest of report_format and log_format parameters. Has more priority than either of them if specified. combines an effest of report_format and log_format parameters. Has more priority than either of them if specified.
@@ -52,7 +52,7 @@ Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at www.boost.org/LICENSE_1_0.txt)

-

Revised: 7 January, 2004

+

Revised: 13 July, 2005

diff --git a/doc/components/utf/parameters/random.html b/doc/components/utf/parameters/random.html new file mode 100644 index 00000000..21538ced --- /dev/null +++ b/doc/components/utf/parameters/random.html @@ -0,0 +1,52 @@ + + +The 'random' parameter + + + + + + +
Boost.Test > Components + > The Unit Test Framework > > Parameters + > The random seed
+
Boost Test logo +

The 'build info' parameter

+ + + + + + + + + + + + + + + + + + + + + +
Parameter Name:random seed for random order of test cases
Environment variable name:BOOST_TEST_RANDOM
Command line argument name:random
Acceptable Values:0
+ 1
+ integer value > 1
Description:positive value makes the framework to run the test cases in random + order. Also if this value is greater than 1 it's used as a random seed. + In other case random seed is generated based on current time
+
+ + + diff --git a/doc/components/utf/parameters/report_format.html b/doc/components/utf/parameters/report_format.html index 56436639..07250c68 100644 --- a/doc/components/utf/parameters/report_format.html +++ b/doc/components/utf/parameters/report_format.html @@ -8,8 +8,8 @@
Boost.Test > Components - > The Unit Test Framework > > Parameters > The - report format
+ > The Unit Test Framework > > Parameters > Report + format
Boost Test reporto

The 'report format' parameter

@@ -51,8 +51,7 @@
Boost Test logo

The 'report level' parameter

@@ -46,7 +46,7 @@ Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at www.boost.org/LICENSE_1_0.txt)

-

Revised: 7 January, 2004

+

Revised: 13 July, 2005

diff --git a/doc/components/utf/parameters/show_progress.html b/doc/components/utf/parameters/show_progress.html new file mode 100644 index 00000000..c88752f5 --- /dev/null +++ b/doc/components/utf/parameters/show_progress.html @@ -0,0 +1,49 @@ + + +The 'show progress' parameter + + + + + + + +
Boost Test logo +

The 'build info' parameter

+
+ + + + + + + + + + + + + + + + + + + + +
Parameter Name:Show progress
Environment variable name:BOOST_TEST_SHOW_PROGRESS
Command line argument name:show_progress
Acceptable Values:no
+ yes
Description:makes the framework to print progress information.
+
+ + +