1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Runtime parameters reference</title>
<link rel="stylesheet" href="../../../../style/style.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
<link rel="home" href="../../../index.html" title="Boost Test Library">
<link rel="up" href="../runtime-config.html" title="Runtime configuration or what are the strings I can pull?">
<link rel="prev" href="run-by-name.html" title="Running specific test units selected by their name">
<link rel="next" href="../../testing-tools.html" title="The UTF testing tools or tester's toolbox for all occasions">
<script language="JavaScript1.2" src="../../../../js/boost-test.js"></script>
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table width="100%"><tr>
<td width="10%"><a href="../../../index.html"><img alt="Home" width="229" height="61" border="0" src="../../../../../../../libs/test/docbook/img/boost.test.logo.png"></a></td>
<td valign="middle" align="left"> > <a href="../../../utf.html">The Unit Test Framework</a> > <a href="../../user-guide.html">User's guide</a><a href="../../testing-tools.html">
>
</a><a href="../runtime-config.html">Runtime configuration </a> > <b>Parameters reference</b>
</td>
<td><div class="spirit-nav">
<a href="run-by-name.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a href="../../testing-tools.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div></td>
</tr></table>
<hr>
<div class="section" lang="en">
<div class="titlepage"><div><div><h5 class="title">
<a name="utf.user-guide.runtime-config.reference"></a>Runtime parameters reference</h5></div></div></div>
<p class="first-line-indented">
Each parameter specification includes: the full parameter name, corresponding environment variable name, command
line argument name, acceptable values and a long description. The default value for the parameter is bold in the
acceptable values list. All values are case sensitive and are required to exactly match the parameter specification.
</p>
<script language="JavaScript1.2">
var id296286;
</script><table class="inline-reference"><tr>
<td class="index" valign="top"><ul>
<li><a href="#" onclick="id296286 = select_form_page( 'utf.user-guide.runtime-config.parameters.auto_start_dbg', id296286 ); return false;">auto_start_dbg</a></li>
<li><a href="#" onclick="id296286 = select_form_page( 'utf.user-guide.runtime-config.parameters.build_info', id296286 ); return false;">build_info</a></li>
<li><a href="#" onclick="id296286 = select_form_page( 'utf.user-guide.runtime-config.parameters.catch_system_errors', id296286 ); return false;">catch_system_errors</a></li>
<li><a href="#" onclick="id296286 = select_form_page( 'utf.user-guide.runtime-config.parameters.detect_memory_leak', id296286 ); return false;">detect_memory_leak</a></li>
<li><a href="#" onclick="id296286 = select_form_page( 'utf.user-guide.runtime-config.parameters.detect_fp_exceptions', id296286 ); return false;">detect_fp_exceptions</a></li>
<li><a href="#" onclick="id296286 = select_form_page( 'utf.user-guide.runtime-config.parameters.log_format', id296286 ); return false;">log_format</a></li>
<li><a href="#" onclick="id296286 = select_form_page( 'utf.user-guide.runtime-config.parameters.log_level', id296286 ); return false;">log_level</a></li>
<li><a href="#" onclick="id296286 = select_form_page( 'utf.user-guide.runtime-config.parameters.output_format', id296286 ); return false;">output_format</a></li>
<li><a href="#" onclick="id296286 = select_form_page( 'utf.user-guide.runtime-config.parameters.random', id296286 ); return false;">random</a></li>
<li><a href="#" onclick="id296286 = select_form_page( 'utf.user-guide.runtime-config.parameters.report_format', id296286 ); return false;">report_format</a></li>
<li><a href="#" onclick="id296286 = select_form_page( 'utf.user-guide.runtime-config.parameters.report_level', id296286 ); return false;">report_level</a></li>
<li><a href="#" onclick="id296286 = select_form_page( 'utf.user-guide.runtime-config.parameters.result_code', id296286 ); return false;">result_code</a></li>
<li><a href="#" onclick="id296286 = select_form_page( 'utf.user-guide.runtime-config.parameters.run_test', id296286 ); return false;">run_test</a></li>
<li><a href="#" onclick="id296286 = select_form_page( 'utf.user-guide.runtime-config.parameters.show_progress', id296286 ); return false;">show_progress</a></li>
<li><a href="#" onclick="id296286 = select_form_page( 'utf.user-guide.runtime-config.parameters.use_alt_stack', id296286 ); return false;">use_alt_stack</a></li>
</ul></td>
<td class="content" valign="top">
<div class="entry" id="utf.user-guide.runtime-config.parameters.auto_start_dbg"><div class="segmentedlist">
<table class="seglistitem">
<tr class="seg">
<td><strong><nobr><span class="segtitle">Parameter Name</span></nobr></strong></td>
<td>: </td>
<td><span class="emphasis"><em>Automatically attach debugger in case of system failure</em></span></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Environment variable name</span></nobr></strong></td>
<td>: </td>
<td><code class="varname">BOOST_TEST_AUTO_START_DBG</code></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Command line argument name</span></nobr></strong></td>
<td>: </td>
<td><em class="parameter"><code>auto_start_dbg</code></em></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Acceptable Values</span></nobr></strong></td>
<td>: </td>
<td><table class="simplelist" border="0" summary="Simple list">
<tr><td><span class="bold"><strong>no</strong></span></td></tr>
<tr><td>yes</td></tr>
<tr><td>debugger identifier</td></tr>
</table></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Description</span></nobr></strong></td>
<td>: </td>
<td><p>
specifies whether Boost.Test should try to attach a debugger in case if fatal system error occurs. If value is "yes"
the default debugger configured for the platform is going to be attempted. Alternatively the debugger identified
by the argument value of the parameter is used. For more details on advanced debugger support in Boost.Test check
section dedicated to Boost.Test debug API.
</p></td>
</tr>
</table>
<br>
</div></div>
<div class="entry" id="utf.user-guide.runtime-config.parameters.build_info"><div class="segmentedlist">
<table class="seglistitem">
<tr class="seg">
<td><strong><nobr><span class="segtitle">Parameter Name</span></nobr></strong></td>
<td>: </td>
<td><span class="emphasis"><em>Print build info</em></span></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Environment variable name</span></nobr></strong></td>
<td>: </td>
<td><code class="varname">BOOST_TEST_BUILD_INFO</code></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Command line argument name</span></nobr></strong></td>
<td>: </td>
<td><em class="parameter"><code>build_info</code></em></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Acceptable Values</span></nobr></strong></td>
<td>: </td>
<td><table class="simplelist" border="0" summary="Simple list">
<tr><td><span class="bold"><strong>no</strong></span></td></tr>
<tr><td>yes</td></tr>
</table></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Description</span></nobr></strong></td>
<td>: </td>
<td><p>
makes the framework to print build information that include: platform, compiler, STL implementation in use and
boost version.
</p></td>
</tr>
</table>
<br>
</div></div>
<div class="entry" id="utf.user-guide.runtime-config.parameters.catch_system_errors"><div class="segmentedlist">
<table class="seglistitem">
<tr class="seg">
<td><strong><nobr><span class="segtitle">Parameter Name</span></nobr></strong></td>
<td>: </td>
<td><span class="emphasis"><em>Catch system errors</em></span></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Environment variable name</span></nobr></strong></td>
<td>: </td>
<td><code class="varname">BOOST_TEST_CATCH_SYSTEM_ERRORS</code></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Command line argument name</span></nobr></strong></td>
<td>: </td>
<td><em class="parameter"><code>catch_system_errors</code></em></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Acceptable Values</span></nobr></strong></td>
<td>: </td>
<td><table class="simplelist" border="0" summary="Simple list">
<tr><td><span class="bold"><strong>yes</strong></span></td></tr>
<tr><td>no</td></tr>
</table></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Description</span></nobr></strong></td>
<td>: </td>
<td><p>
value "no" prohibits the framework from catching asynchronous system events. This could be used for test programs
executed within GUI or to get a coredump for stack analysis. See usage recommendations page for more details.
</p></td>
</tr>
</table>
<br>
</div></div>
<div class="entry" id="utf.user-guide.runtime-config.parameters.detect_memory_leak"><div class="segmentedlist">
<table class="seglistitem">
<tr class="seg">
<td><strong><nobr><span class="segtitle">Parameter Name</span></nobr></strong></td>
<td>: </td>
<td><span class="emphasis"><em>Detect memory leaks</em></span></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Environment variable name</span></nobr></strong></td>
<td>: </td>
<td><code class="varname">BOOST_TEST_DETECT_MEMORY_LEAK</code></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Command line argument name</span></nobr></strong></td>
<td>: </td>
<td><em class="parameter"><code>build_info</code></em></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Acceptable Values</span></nobr></strong></td>
<td>: </td>
<td><table class="simplelist" border="0" summary="Simple list">
<tr><td>0</td></tr>
<tr><td><span class="bold"><strong>1</strong></span></td></tr>
<tr><td>integer value > 1</td></tr>
</table></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Description</span></nobr></strong></td>
<td>: </td>
<td><p>
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.
</p></td>
</tr>
</table>
<br>
</div></div>
<div class="entry" id="utf.user-guide.runtime-config.parameters.detect_fp_exceptions"><div class="segmentedlist">
<table class="seglistitem">
<tr class="seg">
<td><strong><nobr><span class="segtitle">Parameter Name</span></nobr></strong></td>
<td>: </td>
<td><span class="emphasis"><em>[Do not] trap floating point exceptions</em></span></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Environment variable name</span></nobr></strong></td>
<td>: </td>
<td><code class="varname">BOOST_TEST_DETECT_FP_EXCEPTIONS</code></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Command line argument name</span></nobr></strong></td>
<td>: </td>
<td><em class="parameter"><code>detect_fp_exceptions</code></em></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Acceptable Values</span></nobr></strong></td>
<td>: </td>
<td><table class="simplelist" border="0" summary="Simple list">
<tr><td><span class="bold"><strong>no</strong></span></td></tr>
<tr><td>yes</td></tr>
</table></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Description</span></nobr></strong></td>
<td>: </td>
<td><p>
enables/disable hardware traps for the floating point exception if they are supported. By default is disabled.
</p></td>
</tr>
</table>
<br>
</div></div>
<div class="entry" id="utf.user-guide.runtime-config.parameters.log_format"><div class="segmentedlist">
<table class="seglistitem">
<tr class="seg">
<td><strong><nobr><span class="segtitle">Parameter Name</span></nobr></strong></td>
<td>: </td>
<td><span class="emphasis"><em>The log format</em></span></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Environment variable name</span></nobr></strong></td>
<td>: </td>
<td><code class="varname">BOOST_TEST_LOG_FORMAT</code></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Command line argument name</span></nobr></strong></td>
<td>: </td>
<td><em class="parameter"><code>log_format</code></em></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Acceptable Values</span></nobr></strong></td>
<td>: </td>
<td><table class="simplelist" border="0" summary="Simple list">
<tr><td>
<span class="bold"><strong>HRF</strong></span> - human readable format</td></tr>
<tr><td>XML - XML format for automated output processing</td></tr>
</table></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Description</span></nobr></strong></td>
<td>: </td>
<td><p>
allows selecting the <acronym class="acronym">UTF</acronym> log format from the list of formats supplied by the framework. To specify custom log
format use the <a class="link" href="../test-output/log-ct-config.html#utf.user-guide.test-output.log.ct-config.log-formatter" title="Custom log format support">unit_test_log API</a>.
</p></td>
</tr>
</table>
<br>
</div></div>
<div class="entry" id="utf.user-guide.runtime-config.parameters.log_level"><div class="segmentedlist">
<table class="seglistitem">
<tr class="seg">
<td><strong><nobr><span class="segtitle">Parameter Name</span></nobr></strong></td>
<td>: </td>
<td><span class="emphasis"><em>The UTF log level</em></span></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Environment variable name</span></nobr></strong></td>
<td>: </td>
<td><code class="varname">BOOST_TEST_LOG_LEVEL</code></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Command line argument name</span></nobr></strong></td>
<td>: </td>
<td><em class="parameter"><code>log_level</code></em></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Acceptable Values</span></nobr></strong></td>
<td>: </td>
<td><div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term">all</span> - </p></td>
<td>report all log messages including the passed test notification</td>
</tr>
<tr>
<td><p><span class="term">success</span> - </p></td>
<td>the same as all</td>
</tr>
<tr>
<td><p><span class="term">test_suite</span> - </p></td>
<td>show test suite messages</td>
</tr>
<tr>
<td><p><span class="term">message</span> - </p></td>
<td>show user messages</td>
</tr>
<tr>
<td><p><span class="term">warning</span> - </p></td>
<td>report warnings issued by user</td>
</tr>
<tr>
<td><p><span class="term"><span class="bold"><strong>error</strong></span></span> - </p></td>
<td>report all error conditions</td>
</tr>
<tr>
<td><p><span class="term">cpp_exception</span> - </p></td>
<td>report uncaught c++ exception</td>
</tr>
<tr>
<td><p><span class="term">system_error</span> - </p></td>
<td>report system originated non-fatal errors (for example, timeout or floating point exception)</td>
</tr>
<tr>
<td><p><span class="term">fatal_error</span> - </p></td>
<td>report only user or system originated fatal errors (for example, memory access violation)</td>
</tr>
<tr>
<td><p><span class="term">nothing</span> - </p></td>
<td>do not report any information</td>
</tr>
</tbody>
</table></div></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Description</span></nobr></strong></td>
<td>: </td>
<td><p>
allows setting the <acronym class="acronym">UTF</acronym> log level in a range from a
complete log, when all successful tests are confirmed and all test suite messages are included, to an empty
log when nothing is logged a test output stream. Note that log levels are accumulating, in other words each
log level includes also all the information reported by less restrictive ones.
</p></td>
</tr>
</table>
<br>
</div></div>
<div class="entry" id="utf.user-guide.runtime-config.parameters.output_format"><div class="segmentedlist">
<table class="seglistitem">
<tr class="seg">
<td><strong><nobr><span class="segtitle">Parameter Name</span></nobr></strong></td>
<td>: </td>
<td><span class="emphasis"><em>The output format</em></span></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Environment variable name</span></nobr></strong></td>
<td>: </td>
<td><code class="varname">BOOST_TEST_OUTPUT_FORMAT</code></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Command line argument name</span></nobr></strong></td>
<td>: </td>
<td><em class="parameter"><code>output_format</code></em></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Acceptable Values</span></nobr></strong></td>
<td>: </td>
<td><table class="simplelist" border="0" summary="Simple list">
<tr><td>
<span class="bold"><strong>HRF</strong></span> - human readable format</td></tr>
<tr><td>XML - XML format for automated output processing</td></tr>
</table></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Description</span></nobr></strong></td>
<td>: </td>
<td><p>
combines an effect of report_format and log_format parameters. Has higher priority than either one of them if
specified.
</p></td>
</tr>
</table>
<br>
</div></div>
<div class="entry" id="utf.user-guide.runtime-config.parameters.random"><div class="segmentedlist">
<table class="seglistitem">
<tr class="seg">
<td><strong><nobr><span class="segtitle">Parameter Name</span></nobr></strong></td>
<td>: </td>
<td><span class="emphasis"><em>Random seed for random order of test cases</em></span></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Environment variable name</span></nobr></strong></td>
<td>: </td>
<td><code class="varname">BOOST_TEST_RANDOM</code></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Command line argument name</span></nobr></strong></td>
<td>: </td>
<td><em class="parameter"><code>random</code></em></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Acceptable Values</span></nobr></strong></td>
<td>: </td>
<td><table class="simplelist" border="0" summary="Simple list">
<tr><td><span class="bold"><strong>0</strong></span></td></tr>
<tr><td>1</td></tr>
<tr><td>integer value > 1</td></tr>
</table></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Description</span></nobr></strong></td>
<td>: </td>
<td><p>
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.
</p></td>
</tr>
</table>
<br>
</div></div>
<div class="entry" id="utf.user-guide.runtime-config.parameters.report_format"><div class="segmentedlist">
<table class="seglistitem">
<tr class="seg">
<td><strong><nobr><span class="segtitle">Parameter Name</span></nobr></strong></td>
<td>: </td>
<td><span class="emphasis"><em>The report format</em></span></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Environment variable name</span></nobr></strong></td>
<td>: </td>
<td><code class="varname">BOOST_TEST_REPORT_FORMAT</code></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Command line argument name</span></nobr></strong></td>
<td>: </td>
<td><em class="parameter"><code>report</code></em></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Acceptable Values</span></nobr></strong></td>
<td>: </td>
<td><table class="simplelist" border="0" summary="Simple list">
<tr><td>
<span class="bold"><strong>HRF</strong></span> - human readable format</td></tr>
<tr><td>XML - XML format for automated output processing</td></tr>
</table></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Description</span></nobr></strong></td>
<td>: </td>
<td><p>
allows selecting the <acronym class="acronym">UTF</acronym> report format from the list of formats supplied by the framework. To
specify custom report format use unit_test_report API.
</p></td>
</tr>
</table>
<br>
</div></div>
<div class="entry" id="utf.user-guide.runtime-config.parameters.report_level"><div class="segmentedlist">
<table class="seglistitem">
<tr class="seg">
<td><strong><nobr><span class="segtitle">Parameter Name</span></nobr></strong></td>
<td>: </td>
<td><span class="emphasis"><em>The results report level</em></span></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Environment variable name</span></nobr></strong></td>
<td>: </td>
<td><code class="varname">BOOST_TEST_LOG_FORMAT</code></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Command line argument name</span></nobr></strong></td>
<td>: </td>
<td><em class="parameter"><code>log_format</code></em></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Acceptable Values</span></nobr></strong></td>
<td>: </td>
<td><table class="simplelist" border="0" summary="Simple list">
<tr><td>no</td></tr>
<tr><td><span class="bold"><strong>confirm</strong></span></td></tr>
<tr><td>short</td></tr>
<tr><td>detailed</td></tr>
</table></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Description</span></nobr></strong></td>
<td>: </td>
<td><p>
allows setting the level of detailization for the testing results report generated by the framework. Use value
"no" to eliminate the results report completely. See the
<a class="xref" href="../test-output/results-report.html" title="Test report output">the section called “Test report output”</a> for description of different report formats.
</p></td>
</tr>
</table>
<br>
</div></div>
<div class="entry" id="utf.user-guide.runtime-config.parameters.result_code"><div class="segmentedlist">
<table class="seglistitem">
<tr class="seg">
<td><strong><nobr><span class="segtitle">Parameter Name</span></nobr></strong></td>
<td>: </td>
<td><span class="emphasis"><em>[Do not] return result code</em></span></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Environment variable name</span></nobr></strong></td>
<td>: </td>
<td><code class="varname">BOOST_TEST_RESULT_CODE</code></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Command line argument name</span></nobr></strong></td>
<td>: </td>
<td><em class="parameter"><code>result_code</code></em></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Acceptable Values</span></nobr></strong></td>
<td>: </td>
<td><table class="simplelist" border="0" summary="Simple list">
<tr><td><span class="bold"><strong>yes</strong></span></td></tr>
<tr><td>no</td></tr>
</table></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Description</span></nobr></strong></td>
<td>: </td>
<td><p>
value "no" enforces the framework to always return zero result code. This could be used for test programs
executed within GUI. See <a class="link" href="../../usage-recommendations/dot-net-specific.html" title="Microsoft Visual Studio .NET usage recommendations">usage recommendations</a>
section for more details.
</p></td>
</tr>
</table>
<br>
</div></div>
<div class="entry" id="utf.user-guide.runtime-config.parameters.run_test"><div class="segmentedlist">
<table class="seglistitem">
<tr class="seg">
<td><strong><nobr><span class="segtitle">Parameter Name</span></nobr></strong></td>
<td>: </td>
<td><span class="emphasis"><em>Test units to run</em></span></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Environment variable name</span></nobr></strong></td>
<td>: </td>
<td><code class="varname">BOOST_TESTS_TO_RUN</code></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Command line argument name</span></nobr></strong></td>
<td>: </td>
<td><em class="parameter"><code>run_test</code></em></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Acceptable Values</span></nobr></strong></td>
<td>: </td>
<td><table class="simplelist" border="0" summary="Simple list"><tr><td>
<a class="link" href="run-by-name.html" title="Running specific test units selected by their name">specification</a> of test units to run
</td></tr></table></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Description</span></nobr></strong></td>
<td>: </td>
<td><p>
specifies which test units to run.
</p></td>
</tr>
</table>
<br>
</div></div>
<div class="entry" id="utf.user-guide.runtime-config.parameters.show_progress"><div class="segmentedlist">
<table class="seglistitem">
<tr class="seg">
<td><strong><nobr><span class="segtitle">Parameter Name</span></nobr></strong></td>
<td>: </td>
<td><span class="emphasis"><em>Show progress</em></span></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Environment variable name</span></nobr></strong></td>
<td>: </td>
<td><code class="varname">BOOST_TEST_SHOW_PROGRESS</code></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Command line argument name</span></nobr></strong></td>
<td>: </td>
<td><em class="parameter"><code>show_progress</code></em></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Acceptable Values</span></nobr></strong></td>
<td>: </td>
<td><table class="simplelist" border="0" summary="Simple list">
<tr><td><span class="bold"><strong>no</strong></span></td></tr>
<tr><td>yes</td></tr>
</table></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Description</span></nobr></strong></td>
<td>: </td>
<td><p>makes the framework to print progress information.</p></td>
</tr>
</table>
<br>
</div></div>
<div class="entry" id="utf.user-guide.runtime-config.parameters.use_alt_stack"><div class="segmentedlist">
<table class="seglistitem">
<tr class="seg">
<td><strong><nobr><span class="segtitle">Parameter Name</span></nobr></strong></td>
<td>: </td>
<td><span class="emphasis"><em>Use alternative stack</em></span></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Environment variable name</span></nobr></strong></td>
<td>: </td>
<td><code class="varname">BOOST_TEST_USE_ALT_STACK</code></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Command line argument name</span></nobr></strong></td>
<td>: </td>
<td><em class="parameter"><code>use_alt_stack</code></em></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Acceptable Values</span></nobr></strong></td>
<td>: </td>
<td><table class="simplelist" border="0" summary="Simple list">
<tr><td><span class="bold"><strong>yes</strong></span></td></tr>
<tr><td>no</td></tr>
</table></td>
</tr>
<tr class="seg">
<td><strong><nobr><span class="segtitle">Description</span></nobr></strong></td>
<td>: </td>
<td><p>
specifies whether or not the Boost.Test Execution Monitor should employ an alternative stack for signals
processing on platforms where they are supported.
</p></td>
</tr>
</table>
<br>
</div></div>
</td>
</tr></table>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright 2001-2007 Gennadiy Rozental</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="run-by-name.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../runtime-config.html"><img src="../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../../testing-tools.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>
|
