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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Language" content="en-us" />
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
<link rel="stylesheet" type="text/css" href=
"../../../doc/src/boostbook.css" />
<title>Libary Status</title>
<style type="text/css">
/*<![CDATA[*/
span.c3 {color: #FF0000; font-style: italic}
a.c2 {font-style: italic}
td.c1 {font-style: italic}
/*]]>*/
</style>
</head>
<body>
<table border="0">
<tr>
<td><img border="0" src="../../../boost.png" width="277" height="86"
alt="boost.png (6897 bytes)" /></td>
<td>
<h1>Generating Library Status Tables</h1>
</td>
</tr>
</table>
<h3>Purpose</h3>Any time one considers using a library as large and complex
as the Boost libraries, he must have a way of validating the the library
functions in his environment. This should be done when the library is
installed and anytime questions are raised regarding its applicabililty
and/or its usage.
<p>The procedures described here permit a user to run any combination of
tests on any or all libraries and generate a set of convenient tables which
show which libraries pass which tests under what conditions.</p>
<h3>Preliminaries</h3>Generating these tables requires a couple of utility
programs: <code>process_jam_log</code> and <code>library_status</code>.
These can be built by moving to the directory
<code>tools/regression/build</code> and invoking bjam. If all goes well
these utility programs will be found in the directory
<code>dist/bin</code>. From there they should be moved to a place in the
current path.
<h3>Running Tests for One Library</h3>
<ol>
<li>Start from your command line environment.</li>
<li>set the current directory to:../libs/<library name>/test</li>
<li>Invoke one of the following:
<ul>
<li><code>../../../tools/regression/src/library_test (*nix)</code>.</li>
<li><code>..\..\..\tools\regression\src\library_test
(windows)</code>.</li>
</ul>
</li>
<li>This will display short help message describing the how to set the
command line arguments for the compilers and variants you want to appear
in the final table.</li>
<li>Setting these arguments requires rudimentary knowledge of bjam usage.
Hopefully, if you've arrived at this page you've gained the required
knowledge during the installation and library build process.</li>
<li>Rerun the abve command with the argument set accordingly.</li>
<li>When the command terminates, there should be a file named
"library_status.html" in the current directory.</li>
<li>Display this file with any web browser.</li>
</ol>There should appear a table similar to the following for the regex
library.
<table border="1" cellspacing="0" cellpadding="5">
<tr>
<td rowspan="4">Test Name</td>
<td align="center" colspan="4">msvc-7.1</td>
</tr>
<tr>
<td align="center" colspan="2">debug</td>
<td align="center" colspan="2">release</td>
</tr>
<tr>
<td align="center">link-static</td>
<td align="center" rowspan="2">threading-multi</td>
<td align="center">link-static</td>
<td align="center" rowspan="2">threading-multi</td>
</tr>
<tr>
<td align="center">threading-multi</td>
<td align="center">threading-multi</td>
</tr>
<tr>
<td>bad_expression_test</td>
<td class="c1" align="right">Missing</td>
<td align="right"><a class="c2" href=
"links.html#C:-Boost134-bin.v2-libs-regex-test-bad_expression_test.test-msvc-7.1-debug-threading-multi">
Warn</a></td>
<td class="c1" align="right">Missing</td>
<td align="right"><a class="c2" href=
"links.html#C:-Boost134-bin.v2-libs-regex-test-bad_expression_test.test-msvc-7.1-release-threading-multi">
Warn</a></td>
</tr>
<tr>
<td>captures</td>
<td class="c1" align="right">Missing</td>
<td align="right"><a href=
"links.html#C:-Boost134-bin.v2-libs-regex-test-captures-msvc-7.1-debug-threading-multi">
<span class="c3">Fail</span></a></td>
<td class="c1" align="right">Missing</td>
<td align="right"><a href=
"links.html#C:-Boost134-bin.v2-libs-regex-test-captures-msvc-7.1-release-threading-multi">
<span class="c3">Fail</span></a></td>
</tr>
<tr>
<td>captures_test</td>
<td class="c1" align="right">Missing</td>
<td align="right"><a class="c2" href=
"links.html#C:-Boost134-bin.v2-libs-regex-test-captures_test.test-msvc-7.1-debug-threading-multi">
Warn</a></td>
<td class="c1" align="right">Missing</td>
<td align="right"><a class="c2" href=
"links.html#C:-Boost134-bin.v2-libs-regex-test-captures_test.test-msvc-7.1-release-threading-multi">
Warn</a></td>
</tr>
<tr>
<td>concept_check</td>
<td class="c1" align="right">Missing</td>
<td align="right">Pass</td>
<td class="c1" align="right">Missing</td>
<td align="right">Pass</td>
</tr>
<tr>
<td>icu_concept_check</td>
<td class="c1" align="right">Missing</td>
<td align="right">Pass</td>
<td class="c1" align="right">Missing</td>
<td align="right">Pass</td>
</tr>
<tr>
<td>object_cache_test</td>
<td class="c1" align="right">Missing</td>
<td align="right"><a class="c2" href=
"links.html#C:-Boost134-bin.v2-libs-regex-test-object_cache_test.test-msvc-7.1-debug-threading-multi">
Warn</a></td>
<td class="c1" align="right">Missing</td>
<td align="right"><a class="c2" href=
"links.html#C:-Boost134-bin.v2-libs-regex-test-object_cache_test.test-msvc-7.1-release-threading-multi">
Warn</a></td>
</tr>
<tr>
<td>posix_api_check</td>
<td class="c1" align="right">Missing</td>
<td align="right"><a class="c2" href=
"links.html#C:-Boost134-bin.v2-libs-regex-test-posix_api_check.test-msvc-7.1-debug-threading-multi">
Warn</a></td>
<td class="c1" align="right">Missing</td>
<td align="right"><a class="c2" href=
"links.html#C:-Boost134-bin.v2-libs-regex-test-posix_api_check.test-msvc-7.1-release-threading-multi">
Warn</a></td>
</tr>
<tr>
<td>posix_api_check_cpp</td>
<td class="c1" align="right">Missing</td>
<td align="right">Pass</td>
<td class="c1" align="right">Missing</td>
<td align="right">Pass</td>
</tr>
<tr>
<td>recursion_test</td>
<td class="c1" align="right">Missing</td>
<td align="right"><a class="c2" href=
"links.html#C:-Boost134-bin.v2-libs-regex-test-recursion_test.test-msvc-7.1-debug-threading-multi">
Warn</a></td>
<td class="c1" align="right">Missing</td>
<td align="right"><a class="c2" href=
"links.html#C:-Boost134-bin.v2-libs-regex-test-recursion_test.test-msvc-7.1-release-threading-multi">
Warn</a></td>
</tr>
<tr>
<td>regex_config_info</td>
<td class="c1" align="right">Missing</td>
<td align="right"><a href=
"links.html#C:-Boost134-bin.v2-libs-regex-test-regex_config_info.test-msvc-7.1-debug-threading-multi">
Pass</a></td>
<td class="c1" align="right">Missing</td>
<td align="right"><a href=
"links.html#C:-Boost134-bin.v2-libs-regex-test-regex_config_info.test-msvc-7.1-release-threading-multi">
Pass</a></td>
</tr>
<tr>
<td>regex_dll_config_info</td>
<td class="c1" align="right">Missing</td>
<td align="right"><a href=
"links.html#C:-Boost134-bin.v2-libs-regex-test-regex_dll_config_info.test-msvc-7.1-debug-threading-multi">
Pass</a></td>
<td class="c1" align="right">Missing</td>
<td align="right"><a href=
"links.html#C:-Boost134-bin.v2-libs-regex-test-regex_dll_config_info.test-msvc-7.1-release-threading-multi">
Pass</a></td>
</tr>
<tr>
<td>regex_regress</td>
<td align="right"><a href=
"links.html#C:-Boost134-bin.v2-libs-regex-test-regex_regress.test-msvc-7.1-debug-link-static-threading-multi">
Pass</a><sup>*</sup></td>
<td class="c1" align="right">Missing</td>
<td align="right"><a href=
"links.html#C:-Boost134-bin.v2-libs-regex-test-regex_regress.test-msvc-7.1-release-link-static-threading-multi">
Pass</a><sup>*</sup></td>
<td class="c1" align="right">Missing</td>
</tr>
<tr>
<td>regex_regress_dll</td>
<td class="c1" align="right">Missing</td>
<td align="right"><a href=
"links.html#C:-Boost134-bin.v2-libs-regex-test-regex_regress_dll.test-msvc-7.1-debug-threading-multi">
Pass</a><sup>*</sup></td>
<td class="c1" align="right">Missing</td>
<td align="right"><a href=
"links.html#C:-Boost134-bin.v2-libs-regex-test-regex_regress_dll.test-msvc-7.1-release-threading-multi">
Pass</a><sup>*</sup></td>
</tr>
<tr>
<td>regex_regress_threaded</td>
<td class="c1" align="right">Missing</td>
<td align="right">Pass</td>
<td class="c1" align="right">Missing</td>
<td align="right">Pass</td>
</tr>
<tr>
<td>static_mutex_test</td>
<td class="c1" align="right">Missing</td>
<td align="right">Pass</td>
<td class="c1" align="right">Missing</td>
<td align="right">Pass</td>
</tr>
<tr>
<td>test_collate_info</td>
<td class="c1" align="right">Missing</td>
<td align="right"><a class="c2" href=
"links.html#C:-Boost134-bin.v2-libs-regex-test-test_collate_info.test-msvc-7.1-debug-threading-multi">
Warn</a></td>
<td class="c1" align="right">Missing</td>
<td align="right"><a class="c2" href=
"links.html#C:-Boost134-bin.v2-libs-regex-test-test_collate_info.test-msvc-7.1-release-threading-multi">
Warn</a></td>
</tr>
<tr>
<td>unicode_iterator_test</td>
<td class="c1" align="right">Missing</td>
<td align="right"><a class="c2" href=
"links.html#C:-Boost134-bin.v2-libs-regex-test-unicode_iterator_test.test-msvc-7.1-debug-threading-multi">
Warn</a></td>
<td class="c1" align="right">Missing</td>
<td align="right"><a class="c2" href=
"links.html#C:-Boost134-bin.v2-libs-regex-test-unicode_iterator_test.test-msvc-7.1-release-threading-multi">
Warn</a></td>
</tr>
<tr>
<td>wide_posix_api_check_c</td>
<td class="c1" align="right">Missing</td>
<td align="right"><a class="c2" href=
"links.html#C:-Boost134-bin.v2-libs-regex-test-wide_posix_api_check_c.test-msvc-7.1-debug-threading-multi">
Warn</a></td>
<td class="c1" align="right">Missing</td>
<td align="right"><a class="c2" href=
"links.html#C:-Boost134-bin.v2-libs-regex-test-wide_posix_api_check_c.test-msvc-7.1-release-threading-multi">
Warn</a></td>
</tr>
<tr>
<td>wide_posix_api_check_cpp</td>
<td class="c1" align="right">Missing</td>
<td align="right"><a class="c2" href=
"links.html#C:-Boost134-bin.v2-libs-regex-test-wide_posix_api_check_cpp.test-msvc-7.1-debug-threading-multi">
Warn</a></td>
<td class="c1" align="right">Missing</td>
<td align="right"><a class="c2" href=
"links.html#C:-Boost134-bin.v2-libs-regex-test-wide_posix_api_check_cpp.test-msvc-7.1-release-threading-multi">
Warn</a></td>
</tr>
</table>
<p>This table was generated by invoking the following command line:</p>
<p><code>../../../tools/regression/src/library_test --toolset=msvc-7.1
variant=debug,release</code></p>
<p>from within the .../libs/regex/test directory.</p>
<p>This table shows the regex test results for both debug and release
versions of the library. Also it displays the fact that one of the tests is
run specifically with the static linking/multi-threading versions of the
runtime libraries. The cells marked "Missing" correspond to tests that were
not run for some reason or another. This is usually because the
corresponding <code>Jamfile.v2</code> excludes this test for the given
combination of compiler and build attributes. In this example, all tests
were run with the same compiler. If additional compilers were used, they
would appear as more columns in the table.</p>
<p>The table above is just an illustration so the links don't actually
point to anything. In the table you generated, the links will display a
page describing any errors, warnings or other available information about
the tests. If the test passes, usually, there is no additional information
and hence no link.</p>
<p>The tables are cumulative. That is, if you run one set of tests now and
tests with different attributes later, the table will contain all the
results to date. The test results are stored in
<code>../bin.v2/libs/test/<library%gt;/...</code>. To reinitialize the
test results to empty, delete the corresponding files in this
directory.</p>
<p>The procedure above assumes that the table are generated within the
directory <code>../libs/<library>/test</code>. This is the most
common case since this directory contains the <code>Jamfile.v2</code> as
well as the source code that is used by official boost testers. However,
this is just a convention. The table can be generated for other directories
within the libary. One possiblity would be to generate the table for all
the examples in <code>../libs/%lt;library%gt;/example</code>. Or one might
have a special directory of performance tests which take a long time to run
and hence are not suitable for running by official boost testers. Just
remember that library status table is generated in the directory from which
the <code>library_test</code> command is invoked.</p>
<h3>Running Tests for All Libraries</h3>For those with *nix or cygwin
command line shells, there is shell script that can be run from the boost
root directory:
<p><code>tools/regression/src/library_test_all</code></p>
<p>The command line arguments are the same as for running the test for one
library. This script creates all the html files in all the test directories
as well as an html page in the <code>status</code> directory named
<code>library_status_summary.html</code>. This can be used to browse
through all test results for all test in all libraries.</p>
<hr />
<p>Copyright 2011 Bryce Lelbach.</p>
<p>Copyright 2007-2011 Robert Ramey.</p>
<p>Distributed under the Boost Software
License, Version 1.0. (See accompanying file LICENSE_1_0.txt or
http://www.boost.org/LICENSE_1_0.txt)</p>
<p>Revised $Date$</p>
</body>
</html>
|
