2
0
mirror of https://github.com/boostorg/test.git synced 2026-01-26 07:02:12 +00:00
Files
test/doc/components/unit_test_framework/parameters/index.html
Gennadiy Rozental 7db4a2cdec New Version
[SVN r18712]
2003-06-09 08:16:56 +00:00

50 lines
2.9 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> > <A href="../../index.html">Components</A>
> <A href="../index.html">The Unit Test Framework</A> > <SPAN class="current_article">Parameters</SPAN>
</DIV>
<DIV class="body"> <IMG src='../../../btl.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="log_level.html">log level</A></LI>
<LI><A href="no_result_code.html">no result code</A></LI>
<LI><A href="report_level.html">report level</A></LI>
<LI><A href="build_info.html">build info</A></LI>
</UL>
</DIV>
<DIV class="footer">
<DIV class="footer-body">
<P>Copyright &copy <A href='mailto:rogeeff@emailaccount.com'>Gennadiy Rozental</A> 2001-2003.<BR>
Permission to copy, use, modify, sell and distribute this document is granted provided this copyright
notice appears in all copies. This document is provided "as is" without express or implied warranty
and with no claim as to its suitability for any purpose.</P>
<P>Revised: 9 June, 2003</P>
</DIV>
</DIV>
</BODY>
</HTML>