2
0
mirror of https://github.com/boostorg/test.git synced 2026-01-24 06:22:12 +00:00
Files
test/doc/components/utf/parameters/index.html
Gennadiy Rozental 06e7e97366 in progress
[SVN r33093]
2006-02-23 19:29:10 +00:00

57 lines
3.5 KiB
HTML

<HTML>
<HEAD>
<TITLE>The Unit Test Framework parameters</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> &gt; <A href="../../index.html">Components</A>
> <A href="../index.html">The Unit Test Framework</A> &gt; <SPAN class="current_article">Parameters</SPAN>
</DIV>
<DIV class="body"> <IMG src="../../btl1.gif" width="252" height="43" alt="Boost Test logo">
<H1 class="subtitle">The Unit Test Framework parameters</H1>
<P class="first-line-indented">The Unit Test Framework supports two ways to configure test program execution
at runtime: using command line arguments and setting environment variables. Command line argument
always prevails the environment variable value.</P>
<P class="first-line-indented">A parameter's specification includes: the full parameter name, corresponding
environment variable name, command line argument name, acceptable values and long description. The
default value for the parameter is bolded in a list of parameters. All values are case sensitive and
are required to exactly match the parameter specification.</P>
<P class="first-line-indented"></P>
<P class="first-line-indented">The Unit Test Framework parses command line and exclude all framework
parameters and their values from the arguments list forwarded to the user's function init_unit_test_suite.
The command line arguments format expected by the framework is: --&lt;parameter name&gt;=&lt;parameter_value&gt;.
The parameter name is case sensitive. The parameter name is required to exactly match the name in
parameter specification. The should not be any spaces between '=' and both parameter name and parameter
value.</P>
<P class="first-line-indented">The environment variable name is case sensitive and is required to exactly
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="show_progress.html">show_progress</A></LI>
</UL>
</DIV>
<DIV class="footer">
<DIV class="footer-body">
<P> &copy; <A name="Copyright">Copyright</A> <A href="mailto:boost-test%20at%20emailaccount%20dot%20com%20%28please%20unobscure%29">Gennadiy Rozental</A> 2001-2006. <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>