boost/test
2
0
Fork 0
mirror of https://github.com/boostorg/test.git synced 2026-01-23 18:12:12 +00:00
Code Issues Projects Releases Wiki Activity

*** empty log message ***

Browse Source 
[SVN r30028]
This commit is contained in:
Gennadiy Rozental
2005-07-13 05:02:28 +00:00
parent 2dd5c916e4
commit 8127680935
16 changed files with 266 additions and 176 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
doc/components/execution_monitor/execution_aborted.html Normal file
View File

@@ -0,0 +1,28 @@
<HTML>
<HEAD>
<TITLE>boost::execution_aborted</TITLE>
<LINK rel="stylesheet" type="text/css" href="../../style/btl.css" media="screen">
<LINK rel="stylesheet" type="text/css" href="../../style/btl-print.css" media="print">
<META http-equiv="Content-Language" content="en-us">
<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</HEAD>
<BODY>
<DIV class="header"> <A href="../../index.html">Boost.Test</A> > <A href="../index.html">Components</A> > <A href="index.html">The
Execution Monitor</A> > <SPAN class="current_article">boost::execution_aborted</SPAN></DIV>
<DIV class="body"> <IMG src='../../btl1.gif' width='252' height='43' alt="Boost Test logo">
<H1 class="subtitle">boost::execution_aborted</H1>
<PRE class="code"><SPAN class="reserv-word">struct</SPAN> <SPAN class="new-term">execution_aborted</SPAN> {};
</PRE>
<P class="first-line-indented"> This is trivial default constructible class that is used to report gracefull execution abort. </P>
</DIV>
<DIV class="footer">
<DIV class="footer-body">
<P> &copy <A name="Copyright">Copyright</A> <A href='mailto:boost-test at emailaccount dot com (please unobscure)'>Gennadiy Rozental</A> 2001-2005. <BR>
Distributed under the Boost Software License, Version 1.0.
(See accompanying file <A href="../../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</A> or copy at
<A href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</A>)</P>
<P>Revised: <!-- #BeginDate format:Sw1 -->10 July, 2005<!-- #EndDate --> </P>
</DIV>
</DIV>
</BODY>
</HTML>

49
doc/components/test_tools/reference/BOOST_CHECK_SMALL.html Normal file
View File

@@ -0,0 +1,49 @@
<HTML>
<HEAD>
<TITLE>The Test Tools</TITLE>
<LINK rel="stylesheet" type="text/css" href="../../../style/btl.css" media="screen">
<LINK rel="stylesheet" type="text/css" href="../../../style/btl-print.css" media="print">
<META http-equiv="Content-Language" content="en-us">
<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<STYLE type="text/css">
H4
{
margin: 0px;
}
</STYLE>
</HEAD>
<BODY>
<DIV class="body">
<H3>BOOST_WARN_SMALL( val, tolerance )<BR>
BOOST_CHECK_CLOSE( val, tolerance )<BR>
BOOST_REQUIRE_CLOSE( val, tolerance )</H3>
<P class="first-line-indented">These tools are used to check that supplied
values is small enough. The &quot;smallness&quot; 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<A href="../../../../../../boost/test/floating_point_comparison.hpp">
floating_point_comparison.hpp</A>. Use these tools with caution. To compare
to values on closeness it's preferable to use <A href="BOOST_CHECK_CLOSE.html">BOOST_&lt;level&gt;_CLOSE</A> tools. </P>
<P class="first-line-indented">The first parameter is the value to check. The
second parameter is the tolerance .</P>
<H4>Example: test.cpp</H4>
<PRE class="code"><SPAN class="cpp-type">int</SPAN> test_main( <SPAN class="cpp-type">int</SPAN>, <SPAN class="cpp-type">char</SPAN>* [] ) {
<SPAN class="cpp-type">double</SPAN> v = -<SPAN class="literal">1.23456e-3</SPAN>;
BOOST_CHECK_SMALL( v, <SPAN class="literal">0.000001</SPAN> );
<SPAN class="reserv-word">return</SPAN> <SPAN class="literal">0</SPAN>;
}</PRE>
<H4>Output:</H4>
<P class="test-output">test.cpp(4) : error in test_main: absolute value of
v{1.23456e-3} exeeds 1e-06</P>
<DIV class="see_also">
<H4>See Also</H4>
<P class="see-also-content"><A href="BOOST_CHECK_CLOSE.html" target="descr">BOOST_CHECK_CLOSE</A>,
<A href="../floating_point_comparison.html" target="_top">Floating point
comparison algorithms</A></P>
</DIV>
</DIV>
</BODY>
</HTML>
<!-- Copyright Gennadiy Rozental 2001-2005.
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) -->

46
doc/components/test_tools/reference/BOOST_REQUIRE.html
View File

@@ -1,46 +0,0 @@
<HTML>
<HEAD>
<TITLE>The Test Tools</TITLE>
<LINK rel="stylesheet" type="text/css" href="../../../style/btl.css" media="screen">
<LINK rel="stylesheet" type="text/css" href="../../../style/btl-print.css" media="print">
<META http-equiv="Content-Language" content="en-us">
<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<STYLE type="text/css">
H4
{
margin: 0px;
}
</STYLE>
</HEAD>
<BODY>
<DIV class="body">
<H3>BOOST_REQUIRE( predicate )</H3>
<P class="first-line-indented">This tool is used to validate the predicate value and abort the current
test case processing if it fails. </P>
<P class="first-line-indented">If predicate evaluates to <I>true</I>, 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 &quot;fatal error in &lt;test case name&gt;:
test &lt;predicate&gt; fail&quot; and then abort the current test case processing.</P>
<P class="first-line-indented">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.</P>
<H4>Example: test.cpp</H4>
<PRE class="code"><SPAN class="cpp-type">int</SPAN> test_main( <SPAN class="cpp-type">int</SPAN>, <SPAN class="cpp-type">char</SPAN>* [] ) {
<SPAN class="cpp-type">int</SPAN> i = <SPAN class="literal">3</SPAN>;
BOOST_REQUIRE( i &gt; <SPAN class="literal">5</SPAN> );
BOOST_CHECK( i == <SPAN class="literal">6</SPAN> ); <SPAN class="comment">// will never reach this check</SPAN>
<SPAN class="reserv-word">return</SPAN> <SPAN class="literal">0</SPAN>;
}</PRE>
<H4>Output:</H4>
<P class="test-output">test.cpp(3) : fatal error in test_main: test i&gt;5 failed </P>
<DIV class="see_also">
<H4>See Also</H4>
<P class="see-also-content"><A href="BOOST_CHECK.html" target="descr">BOOST_CHECK</A></P>
</DIV>
</DIV>
</BODY>
</HTML>
<!-- Copyright Gennadiy Rozental 2001-2004.
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) -->

51
doc/components/test_tools/reference/BOOST_REQUIRE_PREDICATE.html
View File

@@ -1,51 +0,0 @@
<HTML>
<HEAD>
<TITLE>The Test Tools</TITLE>
<LINK rel="stylesheet" type="text/css" href="../../../style/btl.css" media="screen">
<LINK rel="stylesheet" type="text/css" href="../../../style/btl-print.css" media="print">
<META http-equiv="Content-Language" content="en-us">
<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<STYLE type="text/css">
H4
{
margin: 0px;
}
</STYLE>
</HEAD>
<BODY>
<DIV class="body">
<H3>BOOST_REQUIRE_PREDICATE( predicate, arity, arguments_list ) </H3>
<P class="first-line-indented">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 <A href="BOOST_REQUIRE.html" target="descr">BOOST_REQUIRE</A>
tool. The advantage of this tool is that shows arguments values in case of predicate failure.</P>
<P class="first-line-indented">If predicate evaluates to <I> true</I>, 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 &quot;error in &lt;test case name&gt;: test &lt;predicate&gt;(
arguments_list ) fail for (arguments values)&quot; and abort the current test case processing.</P>
<H4>Example: test.cpp</H4>
<PRE class="code"><SPAN class="cpp-type">int</SPAN> test.cpp( <SPAN class="cpp-type">int</SPAN>, <SPAN class="cpp-type">char</SPAN>* [] ) {
<SPAN class="cpp-type">double</SPAN> fp1 = <SPAN class="literal">1.23456e-10</SPAN>;
<SPAN class="cpp-type">double</SPAN> fp2 = <SPAN class="literal">1.23457e-10</SPAN>;
<SPAN class="cpp-type">double</SPAN> epsilon = <SPAN class="literal">8.1e-6</SPAN>;
<SPAN class="comment">// check weak closeness </SPAN>
BOOST_REQUIRE_PREDICATE( close_at_tolerance&lt;double&gt;( epsilon, <SPAN class="reserv-word">false</SPAN> ),
<SPAN class="literal">2</SPAN>, ( fp1, fp2 ) ); <SPAN class="comment">// should pass</SPAN>
<SPAN class="reserv-word">return</SPAN> <SPAN class="literal">0</SPAN>;
}
</PRE>
<H4>Output:</H4>
<P class="test-output">&nbsp;</P>
<DIV class="see_also">
<H4>See Also</H4>
<P class="see-also-content"><A href="BOOST_REQUIRE.html" target="descr">BOOST_REQUIRE</A></P>
</DIV>
</DIV>
</BODY>
</HTML>
<!-- Copyright Gennadiy Rozental 2001-2004.
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) -->

46
doc/components/test_tools/reference/BOOST_WARN.html
View File

@@ -1,46 +0,0 @@
<HTML>
<HEAD>
<TITLE>The Test Tools</TITLE>
<LINK rel="stylesheet" type="text/css" href="../../../style/btl.css" media="screen">
<LINK rel="stylesheet" type="text/css" href="../../../style/btl-print.css" media="print">
<META http-equiv="Content-Language" content="en-us">
<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<STYLE type="text/css">
H4
{
margin: 0px;
}
</STYLE>
</HEAD>
<BODY>
<DIV class="body">
<H3>BOOST_WARN( predicate )</H3>
<P class="first-line-indented">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.</P>
<P class="first-line-indented">If predicate evaluates to <I>true</I>, 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 &quot;warning in &lt;test case name&gt;: condition
&lt;predicate&gt; is not satisfied&quot;</P>
<H4>Example: test.cpp</H4>
<PRE class="code"><SPAN class="cpp-type">int</SPAN> test_main( <SPAN class="cpp-type">int</SPAN>, <SPAN class="cpp-type">char</SPAN>* [] ) {
BOOST_WARN( <SPAN class="reserv-word">sizeof</SPAN>(<SPAN class="cpp-type">int</SPAN>) == <SPAN class="reserv-word">sizeof</SPAN>(<SPAN class="cpp-type">short</SPAN>) );
<SPAN class="reserv-word">return</SPAN> <SPAN class="literal">0</SPAN>;
}</PRE>
<H4>Output:</H4>
<P class="test-output">test.cpp(2) : warning in test_main: condition sizeof(int)
== sizeof(short) is not satisfied
</P>
<DIV class="see_also">
<H4>See Also</H4>
<P class="see-also-content"><A href="BOOST_CHECK.html" target="descr">BOOST_CHECK</A></P>
</DIV>
</DIV>
</BODY>
</HTML>
<!-- Copyright Gennadiy Rozental 2001-2004.
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) -->

4
doc/components/utf/parameters/build_info.html
View File

@@ -9,7 +9,7 @@
<BODY>
<DIV class="header"> <A href="../../../index.html">Boost.Test</A> > <A href="../../index.html">Components</A>
> <A href="../index.html">The Unit Test Framework</A> > > <A href="index.html">Parameters</A>
> <SPAN class="current_article">The build info</SPAN>
> <SPAN class="current_article">Build info</SPAN>
</DIV>
<DIV class="body"> <IMG src='../../../btl1.gif' width='252' height='43' alt="Boost Test logo">
<H1 class="subtitle">The 'build info' parameter</H1>
@@ -44,7 +44,7 @@
Distributed under the Boost Software License, Version 1.0.
(See accompanying file <A href="../../../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</A> or copy at
<A href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</A>)</P>
<P>Revised: <!-- #BeginDate format:Sw1 -->7 January, 2004<!-- #EndDate --> </P>
<P>Revised: <!-- #BeginDate format:Sw1 -->13 July, 2005<!-- #EndDate --> </P>
</DIV>
</DIV>
</BODY>

5
doc/components/utf/parameters/catch_system_errors.html
View File

@@ -8,7 +8,8 @@
</HEAD>
<BODY>
<DIV class="header"> <A href="../../../index.html">Boost.Test</A> > <A href="../../index.html">Components</A>
> <A href="../index.html">The Unit Test Framework</A> > > <A href="index.html">Parameters</A> > <SPAN class="current_article">catch system errors </SPAN></DIV>
> <A href="../index.html">The Unit Test Framework</A> > > <A href="index.html">Parameters</A> > <SPAN class="current_article">Catch
system errors </SPAN></DIV>
<DIV class="body"> <IMG src='../../../btl1.gif' width='252' height='43' alt="Boost Test logo">
<H1 class="subtitle">The 'catch system errors' parameter</H1>
<TABLE class="parameter-table" cellspacing="0">
@@ -43,7 +44,7 @@
Distributed under the Boost Software License, Version 1.0.
(See accompanying file <A href="../../../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</A> or copy at
<A href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</A>)</P>
<P>Revised: <!-- #BeginDate format:Sw1 -->7 January, 2004<!-- #EndDate --> </P>
<P>Revised: <!-- #BeginDate format:Sw1 -->13 July, 2005<!-- #EndDate --> </P>
</DIV>
</DIV>
</BODY>

57
doc/components/utf/parameters/detect_memory_leaks.html Normal file
View File

@@ -0,0 +1,57 @@
<HTML>
<HEAD>
<TITLE>The 'detect memory leaks' parameter</TITLE>
<LINK rel="stylesheet" type="text/css" href="../../../style/btl.css" media="screen">
<LINK rel="stylesheet" type="text/css" href="../../../style/btl-print.css" media="print">
<META http-equiv="Content-Language" content="en-us">
<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</HEAD>
<BODY>
<DIV class="header"> <A href="../../../index.html">Boost.Test</A> > <A href="../../index.html">Components</A>
> <A href="../index.html">The Unit Test Framework</A> > > <A href="index.html">Parameters</A>
> <SPAN class="current_article">Detect memory leaks </SPAN></DIV>
<DIV class="body"> <IMG src='../../../btl1.gif' width='252' height='43' alt="Boost Test logo">
<H1 class="subtitle">The 'build info' parameter</H1>
<TABLE class="parameter-table" cellspacing="0">
<TR>
<TD class="name"><B>Parameter Name:</B></TD>
<TD><EM>detect memory leaks </EM></TD>
</TR>
<TR>
<TD class="name"><B>Environment variable name:</B></TD>
<TD>BOOST_TEST_DETECT_MEMORY_LEAK</TD>
</TR>
<TR>
<TD class="name"><B>Command line argument name:</B></TD>
<TD>detect_memory_leak</TD>
</TR>
<TR>
<TD class="name"><B>Acceptable Values:</B></TD>
<TD>0<BR>
<STRONG>1</STRONG><BR>
integer value &gt; 1 </TD>
</TR>
<TR>
<TD class="name"><B>Description:</B></TD>
<TD>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</TD>
</TR>
</TABLE>
</DIV>
<DIV class="footer">
<DIV class="footer-body">
<P> &copy <A name="Copyright">Copyright</A> <A href='mailto:boost-test at emailaccount dot com (please unobscure)'>Gennadiy Rozental</A> 2001-2005. <BR>
Distributed under the Boost Software License, Version 1.0.
(See accompanying file <A href="../../../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</A> or copy at
<A href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</A>)</P>
<P>Revised: <!-- #BeginDate format:Sw1 -->13 July, 2005<!-- #EndDate --> </P>
</DIV>
</DIV>
</BODY>
</HTML>

15
doc/components/utf/parameters/index.html
View File

@@ -30,14 +30,17 @@
match the name in parameter specification.</P>
<P class="first-line-indented">Here is the list of all parameters:</P>
<UL>
<LI><A href="build_info.html">build info</A></LI>
<LI><A href="catch_system_errors.html">catch_system_errors</A></LI>
<LI><A href="detect_memory_leaks.html">detect_memory_leaks</A></LI>
<LI><A href="log_format.html">log_format</A></LI>
<LI><A href="log_level.html">log level</A></LI>
<LI><A href="no_result_code.html">no result code</A></LI>
<LI><A href="output_format.html">output_format</A></LI>
<LI><A href="random.html">random</A></LI>
<LI><A href="report_format.html">report_format</A></LI>
<LI><A href="report_level.html">report level</A></LI>
<LI><A href="build_info.html">build info</A></LI>
<LI><a href="log_format.html">log_format</a></LI>
<LI><a href="report_format.html">report_format</a></LI>
<LI><a href="output_format.html">output_format</a></LI>
<LI><a href="catch_system_errors.html">catch_system_errors</a></LI>
<LI><A href="show_progress.html">show_progress</A></LI>
</UL>
</DIV>
<DIV class="footer">
@@ -46,7 +49,7 @@
Distributed under the Boost Software License, Version 1.0.
(See accompanying file <A href="../../../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</A> or copy at
<A href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</A>)</P>
<P>Revised: <!-- #BeginDate format:Sw1 -->7 January, 2004<!-- #EndDate --> </P>
<P>Revised: <!-- #BeginDate format:Sw1 -->13 July, 2005<!-- #EndDate --> </P>
</DIV>
</DIV>
</BODY>

8
doc/components/utf/parameters/log_format.html
View File

@@ -8,8 +8,8 @@
</HEAD>
<BODY>
<DIV class="header"> <A href="../../../index.html">Boost.Test</A> > <A href="../../index.html">Components</A>
> <A href="../index.html">The Unit Test Framework</A> > > <A href="index.html">Parameters</A> > <SPAN class="current_article">The
log format</SPAN> </DIV>
> <A href="../index.html">The Unit Test Framework</A> > > <A href="index.html">Parameters</A> > <SPAN class="current_article">Log
format</SPAN> </DIV>
<DIV class="body"> <IMG src='../../../btl1.gif' width='252' height='43' alt="Boost Test logo">
<H1 class="subtitle">The 'log format' parameter</H1>
<TABLE class="parameter-table" cellspacing="0">
@@ -43,7 +43,7 @@
<TR>
<TD class="name"> <B>Description:</B> </TD>
<TD> allows to select the unit test framework log format from the list of
formats supplied by the framework. To specify custom log format use <a href="../components/test_log/index.html">unit_test_log</a>
formats supplied by the framework. To specify custom log format use <A href="../components/test_log/index.html">unit_test_log</A>
API.</TD>
</TR>
</TABLE>
@@ -54,7 +54,7 @@
Distributed under the Boost Software License, Version 1.0.
(See accompanying file <A href="../../../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</A> or copy at
<A href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</A>)</P>
<P>Revised: <!-- #BeginDate format:Sw1 -->7 January, 2004<!-- #EndDate --> </P>
<P>Revised: <!-- #BeginDate format:Sw1 -->13 July, 2005<!-- #EndDate --> </P>
</DIV>
</DIV>
</BODY>

11
doc/components/utf/parameters/log_level.html
View File

@@ -8,8 +8,8 @@
</HEAD>
<BODY>
<DIV class="header"> <A href="../../../index.html">Boost.Test</A> > <A href="../../index.html">Components</A>
> <A href="../index.html">The Unit Test Framework</A> > > <A href="index.html">Parameters</A> > <SPAN class="current_article">The
log level</SPAN> </DIV>
> <A href="../index.html">The Unit Test Framework</A> > > <A href="index.html">Parameters</A> > <SPAN class="current_article">Log
level</SPAN> </DIV>
<DIV class="body"> <IMG src='../../../btl1.gif' width='252' height='43' alt="Boost Test logo">
<H1 class="subtitle">The 'log level' parameter</H1>
<TABLE class="parameter-table" cellspacing="0">
@@ -66,11 +66,6 @@
<TD>fatal_errors</TD>
<TD>- report only user or system originated fatal errors (for example, memory access violation)</TD>
</TR>
<TR>
<TD>progress</TD>
<TD>- report only progress information: number of run test cases vs. overall number of test
cases</TD>
</TR>
<TR>
<TD>nothing</TD>
<TD>- does not report any information</TD>
@@ -93,7 +88,7 @@
Distributed under the Boost Software License, Version 1.0.
(See accompanying file <A href="../../../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</A> or copy at
<A href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</A>)</P>
<P>Revised: <!-- #BeginDate format:Sw1 -->7 January, 2004<!-- #EndDate --> </P>
<P>Revised: <!-- #BeginDate format:Sw1 -->13 July, 2005<!-- #EndDate --> </P>
</DIV>
</DIV>
</BODY>

8
doc/components/utf/parameters/output_format.html
View File

@@ -8,8 +8,8 @@
</HEAD>
<BODY>
<DIV class="header"> <A href="../../../index.html">Boost.Test</A> > <A href="../../index.html">Components</A>
> <A href="../index.html">The Unit Test Framework</A> > > <A href="index.html">Parameters</A> > <SPAN class="current_article">The
output format</SPAN></DIV>
> <A href="../index.html">The Unit Test Framework</A> > > <A href="index.html">Parameters</A> > <SPAN class="current_article">Output
format</SPAN></DIV>
<DIV class="body"> <IMG src='../../../btl1.gif' width='252' height='43' alt="Boost Test reporto">
<H1 class="subtitle">The 'output format' parameter</H1>
<TABLE class="parameter-table" cellspacing="0">
@@ -42,7 +42,7 @@
</TR>
<TR>
<TD class="name"> <B>Description:</B> </TD>
<TD> combines an effest of <a href="report_format.html">report_format</a> and <a href="log_format.html">log_format</a> parameters. Has more priority than either of them if specified.</TD>
<TD> combines an effest of <A href="report_format.html">report_format</A> and <A href="log_format.html">log_format</A> parameters. Has more priority than either of them if specified.</TD>
</TR>
</TABLE>
</DIV>
@@ -52,7 +52,7 @@
Distributed under the Boost Software License, Version 1.0.
(See accompanying file <A href="../../../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</A> or copy at
<A href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</A>)</P>
<P>Revised: <!-- #BeginDate format:Sw1 -->7 January, 2004<!-- #EndDate --> </P>
<P>Revised: <!-- #BeginDate format:Sw1 -->13 July, 2005<!-- #EndDate --> </P>
</DIV>
</DIV>
</BODY>

52
doc/components/utf/parameters/random.html Normal file
View File

@@ -0,0 +1,52 @@
<HTML>
<HEAD>
<TITLE>The 'random' parameter</TITLE>
<LINK rel="stylesheet" type="text/css" href="../../../style/btl.css" media="screen">
<LINK rel="stylesheet" type="text/css" href="../../../style/btl-print.css" media="print">
<META http-equiv="Content-Language" content="en-us">
<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</HEAD>
<BODY>
<DIV class="header"> <A href="../../../index.html">Boost.Test</A> > <A href="../../index.html">Components</A>
> <A href="../index.html">The Unit Test Framework</A> > > <A href="index.html">Parameters</A>
> <SPAN class="current_article">The random seed </SPAN></DIV>
<DIV class="body"> <IMG src='../../../btl1.gif' width='252' height='43' alt="Boost Test logo">
<H1 class="subtitle">The 'build info' parameter</H1>
<TABLE class="parameter-table" cellspacing="0">
<TR>
<TD class="name"><B>Parameter Name:</B></TD>
<TD><EM>random seed for random order of test cases</EM></TD>
</TR>
<TR>
<TD class="name"><B>Environment variable name:</B></TD>
<TD>BOOST_TEST_RANDOM</TD>
</TR>
<TR>
<TD class="name"><B>Command line argument name:</B></TD>
<TD>random</TD>
</TR>
<TR>
<TD class="name"><B>Acceptable Values:</B></TD>
<TD><B>0</B><BR>
1<BR>
integer value &gt; 1 </TD>
</TR>
<TR>
<TD class="name"><B>Description:</B></TD>
<TD>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</TD>
</TR>
</TABLE>
</DIV>
<DIV class="footer">
<DIV class="footer-body">
<P> &copy <A name="Copyright">Copyright</A> <A href='mailto:boost-test at emailaccount dot com (please unobscure)'>Gennadiy Rozental</A> 2001-2005. <BR>
Distributed under the Boost Software License, Version 1.0.
(See accompanying file <A href="../../../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</A> or copy at
<A href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</A>)</P>
<P>Revised: <!-- #BeginDate format:Sw1 -->13 July, 2005<!-- #EndDate --> </P>
</DIV>
</DIV>
</BODY>
</HTML>

7
doc/components/utf/parameters/report_format.html
View File

@@ -8,8 +8,8 @@
</HEAD>
<BODY>
<DIV class="header"> <A href="../../../index.html">Boost.Test</A> > <A href="../../index.html">Components</A>
> <A href="../index.html">The Unit Test Framework</A> > > <A href="index.html">Parameters</A> > <SPAN class="current_article">The
report format</SPAN> </DIV>
> <A href="../index.html">The Unit Test Framework</A> > > <A href="index.html">Parameters</A> > <SPAN class="current_article">Report
format</SPAN> </DIV>
<DIV class="body"> <IMG src='../../../btl1.gif' width='252' height='43' alt="Boost Test reporto">
<H1 class="subtitle">The 'report format' parameter</H1>
<TABLE class="parameter-table" cellspacing="0">
@@ -51,8 +51,7 @@
<DIV class="footer">
<DIV class="footer-body">
<P> &copy <A name="Copyright">Copyright</A> <A href='mailto:boost-test at emailaccount dot com (please unobscure)'>Gennadiy Rozental</A> 2001-2005. <BR>
Distributed under the Boost Software License, Version 1.0.
(See accompanying file <A href="../../../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</A> or copy at
Distributed under the Boost Software License, Version 1.0.<!-- #BeginDate format:Sw1 -->13 July, 2005<!-- #EndDate -->CENSE_1_0.txt">LICENSE_1_0.txt</A> or copy at
<A href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</A>)</P>
<P>Revised: <!-- #BeginDate format:Sw1 -->18 January, 2004<!-- #EndDate --> </P>
</DIV>

6
doc/components/utf/parameters/report_level.html
View File

@@ -8,8 +8,8 @@
</HEAD>
<BODY>
<DIV class="header"> <A href="../../../index.html">Boost.Test</A> > <A href="../../index.html">Components</A>
> <A href="../index.html">The Unit Test Framework</A> > > <A href="index.html">Parameters</A> > <SPAN class="current_article">The
report level</SPAN> </DIV>
> <A href="../index.html">The Unit Test Framework</A> > > <A href="index.html">Parameters</A> > <SPAN class="current_article">Report
level</SPAN> </DIV>
<DIV class="body"> <IMG src='../../../btl1.gif' width='252' height='43' alt="Boost Test logo">
<H1 class="subtitle">The 'report level' parameter</H1>
<TABLE class="parameter-table" cellspacing="0">
@@ -46,7 +46,7 @@
Distributed under the Boost Software License, Version 1.0.
(See accompanying file <A href="../../../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</A> or copy at
<A href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</A>)</P>
<P>Revised: <!-- #BeginDate format:Sw1 -->7 January, 2004<!-- #EndDate --> </P>
<P>Revised: <!-- #BeginDate format:Sw1 -->13 July, 2005<!-- #EndDate --> </P>
</DIV>
</DIV>
</BODY>

49
doc/components/utf/parameters/show_progress.html Normal file
View File

@@ -0,0 +1,49 @@
<HTML>
<HEAD>
<TITLE>The 'show progress' parameter</TITLE>
<LINK rel="stylesheet" type="text/css" href="../../../style/btl.css" media="screen">
<LINK rel="stylesheet" type="text/css" href="../../../style/btl-print.css" media="print">
<META http-equiv="Content-Language" content="en-us">
<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</HEAD>
<BODY>
<DIV class="header"> <A href="../../../index.html">Boost.Test</A> > <A href="../../index.html">Components</A>
> <A href="../index.html">The Unit Test Framework</A> > > <A href="index.html">Parameters</A>
> <SPAN class="current_article">Show progress </SPAN></DIV>
<DIV class="body"> <IMG src='../../../btl1.gif' width='252' height='43' alt="Boost Test logo">
<H1 class="subtitle">The 'build info' parameter</H1>
<TABLE class="parameter-table" cellspacing="0">
<TR>
<TD class="name"><B>Parameter Name:</B></TD>
<TD><I>Show progress </I></TD>
</TR>
<TR>
<TD class="name"><B>Environment variable name:</B></TD>
<TD>BOOST_TEST_SHOW_PROGRESS</TD>
</TR>
<TR>
<TD class="name"><B>Command line argument name:</B></TD>
<TD>show_progress</TD>
</TR>
<TR>
<TD class="name"><B>Acceptable Values:</B></TD>
<TD><B>no</B><BR>
yes </TD>
</TR>
<TR>
<TD class="name"><B>Description:</B></TD>
<TD>makes the framework to print progress information.</TD>
</TR>
</TABLE>
</DIV>
<DIV class="footer">
<DIV class="footer-body">
<P> &copy <A name="Copyright">Copyright</A> <A href='mailto:boost-test at emailaccount dot com (please unobscure)'>Gennadiy Rozental</A> 2001-2005. <BR>
Distributed under the Boost Software License, Version 1.0.
(See accompanying file <A href="../../../../../../LICENSE_1_0.txt">LICENSE_1_0.txt</A> or copy at
<A href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</A>)</P>
<P>Revised: <!-- #BeginDate format:Sw1 -->13 July, 2005<!-- #EndDate --> </P>
</DIV>
</DIV>
</BODY>
</HTML>