library_status.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <meta http-equiv="Content-Language" content="en-us" />
  6. <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
  7. <link rel="stylesheet" type="text/css" href=
  8. "../../../doc/html/boostbook.css" />
  9. <title>Libary Status</title>
  10. <style type="text/css">
  11. /*<![CDATA[*/
  12. span.c3 {color: #FF0000; font-style: italic}
  13. a.c2 {font-style: italic}
  14. td.c1 {font-style: italic}
  15. /*]]>*/
  16. </style>
  17. </head>
  18. <body>
  19. <table border="0">
  20. <tr>
  21. <td><img border="0" src="../../../boost.png" width="277" height="86"
  22. alt="boost.png (6897 bytes)" /></td>
  23. <td>
  24. <h1>Generating Library Status Tables</h1>
  25. </td>
  26. </tr>
  27. </table>
  28. <h3>Purpose</h3>Any time one considers using a library as large and complex
  29. as the Boost libraries, he must have a way of validating the the library
  30. functions in his environment. This should be done when the library is
  31. installed and anytime questions are raised regarding its applicabililty
  32. and/or its usage.
  33. <p>The procedures described here permit a user to run any combination of
  34. tests on any or all libraries and generate a set of convenient tables which
  35. show which libraries pass which tests under what conditions.</p>
  36. <h3>Preliminaries</h3>Generating these tables requires a couple of utility
  37. programs: <code>process_jam_log</code> and <code>library_status</code>.
  38. These can be built by moving to the directory
  39. <code>tools/regression/build</code> and invoking bjam. If all goes well
  40. these utility programs will be found in the directory
  41. <code>dist/bin</code>. From there they should be moved to a place in the
  42. current path.
  43. <h3>Running Tests for One Library</h3>
  44. <ol>
  45. <li>Start from your command line environment.</li>
  46. <li>set the current directory to:../libs/&lt;library name&gt;/test</li>
  47. <li>Invoke one of the following:
  48. <ul>
  49. <li><code>../../../tools/regression/library_test (*nix)</code>.</li>
  50. <li><code>..\..\..\tools\regression\library_test
  51. (windows)</code>.</li>
  52. </ul>
  53. </li>
  54. <li>This will display short help message describing the how to set the
  55. command line arguments for the compilers and variants you want to appear
  56. in the final table.</li>
  57. <li>Setting these arguments requires rudimentary knowledge of bjam usage.
  58. Hopefully, if you've arrived at this page you've gained the required
  59. knowledge during the installation and library build process.</li>
  60. <li>Rerun the abve command with the argument set accordingly.</li>
  61. <li>When the command terminates, there should be a file named
  62. "library_status.html" in the current directory.</li>
  63. <li>Display this file with any web browser.</li>
  64. </ol>There should appear a table similar to the following for the regex
  65. library.
  66. <table border="1" cellspacing="0" cellpadding="5">
  67. <tr>
  68. <td rowspan="4">Test Name</td>
  69. <td align="center" colspan="4">msvc-7.1</td>
  70. </tr>
  71. <tr>
  72. <td align="center" colspan="2">debug</td>
  73. <td align="center" colspan="2">release</td>
  74. </tr>
  75. <tr>
  76. <td align="center">link-static</td>
  77. <td align="center" rowspan="2">threading-multi</td>
  78. <td align="center">link-static</td>
  79. <td align="center" rowspan="2">threading-multi</td>
  80. </tr>
  81. <tr>
  82. <td align="center">threading-multi</td>
  83. <td align="center">threading-multi</td>
  84. </tr>
  85. <tr>
  86. <td>bad_expression_test</td>
  87. <td class="c1" align="right">Missing</td>
  88. <td align="right"><a class="c2" href=
  89. "links.html#C:-Boost134-bin.v2-libs-regex-test-bad_expression_test.test-msvc-7.1-debug-threading-multi">
  90. Warn</a></td>
  91. <td class="c1" align="right">Missing</td>
  92. <td align="right"><a class="c2" href=
  93. "links.html#C:-Boost134-bin.v2-libs-regex-test-bad_expression_test.test-msvc-7.1-release-threading-multi">
  94. Warn</a></td>
  95. </tr>
  96. <tr>
  97. <td>captures</td>
  98. <td class="c1" align="right">Missing</td>
  99. <td align="right"><a href=
  100. "links.html#C:-Boost134-bin.v2-libs-regex-test-captures-msvc-7.1-debug-threading-multi">
  101. <span class="c3">Fail</span></a></td>
  102. <td class="c1" align="right">Missing</td>
  103. <td align="right"><a href=
  104. "links.html#C:-Boost134-bin.v2-libs-regex-test-captures-msvc-7.1-release-threading-multi">
  105. <span class="c3">Fail</span></a></td>
  106. </tr>
  107. <tr>
  108. <td>captures_test</td>
  109. <td class="c1" align="right">Missing</td>
  110. <td align="right"><a class="c2" href=
  111. "links.html#C:-Boost134-bin.v2-libs-regex-test-captures_test.test-msvc-7.1-debug-threading-multi">
  112. Warn</a></td>
  113. <td class="c1" align="right">Missing</td>
  114. <td align="right"><a class="c2" href=
  115. "links.html#C:-Boost134-bin.v2-libs-regex-test-captures_test.test-msvc-7.1-release-threading-multi">
  116. Warn</a></td>
  117. </tr>
  118. <tr>
  119. <td>concept_check</td>
  120. <td class="c1" align="right">Missing</td>
  121. <td align="right">Pass</td>
  122. <td class="c1" align="right">Missing</td>
  123. <td align="right">Pass</td>
  124. </tr>
  125. <tr>
  126. <td>icu_concept_check</td>
  127. <td class="c1" align="right">Missing</td>
  128. <td align="right">Pass</td>
  129. <td class="c1" align="right">Missing</td>
  130. <td align="right">Pass</td>
  131. </tr>
  132. <tr>
  133. <td>object_cache_test</td>
  134. <td class="c1" align="right">Missing</td>
  135. <td align="right"><a class="c2" href=
  136. "links.html#C:-Boost134-bin.v2-libs-regex-test-object_cache_test.test-msvc-7.1-debug-threading-multi">
  137. Warn</a></td>
  138. <td class="c1" align="right">Missing</td>
  139. <td align="right"><a class="c2" href=
  140. "links.html#C:-Boost134-bin.v2-libs-regex-test-object_cache_test.test-msvc-7.1-release-threading-multi">
  141. Warn</a></td>
  142. </tr>
  143. <tr>
  144. <td>posix_api_check</td>
  145. <td class="c1" align="right">Missing</td>
  146. <td align="right"><a class="c2" href=
  147. "links.html#C:-Boost134-bin.v2-libs-regex-test-posix_api_check.test-msvc-7.1-debug-threading-multi">
  148. Warn</a></td>
  149. <td class="c1" align="right">Missing</td>
  150. <td align="right"><a class="c2" href=
  151. "links.html#C:-Boost134-bin.v2-libs-regex-test-posix_api_check.test-msvc-7.1-release-threading-multi">
  152. Warn</a></td>
  153. </tr>
  154. <tr>
  155. <td>posix_api_check_cpp</td>
  156. <td class="c1" align="right">Missing</td>
  157. <td align="right">Pass</td>
  158. <td class="c1" align="right">Missing</td>
  159. <td align="right">Pass</td>
  160. </tr>
  161. <tr>
  162. <td>recursion_test</td>
  163. <td class="c1" align="right">Missing</td>
  164. <td align="right"><a class="c2" href=
  165. "links.html#C:-Boost134-bin.v2-libs-regex-test-recursion_test.test-msvc-7.1-debug-threading-multi">
  166. Warn</a></td>
  167. <td class="c1" align="right">Missing</td>
  168. <td align="right"><a class="c2" href=
  169. "links.html#C:-Boost134-bin.v2-libs-regex-test-recursion_test.test-msvc-7.1-release-threading-multi">
  170. Warn</a></td>
  171. </tr>
  172. <tr>
  173. <td>regex_config_info</td>
  174. <td class="c1" align="right">Missing</td>
  175. <td align="right"><a href=
  176. "links.html#C:-Boost134-bin.v2-libs-regex-test-regex_config_info.test-msvc-7.1-debug-threading-multi">
  177. Pass</a></td>
  178. <td class="c1" align="right">Missing</td>
  179. <td align="right"><a href=
  180. "links.html#C:-Boost134-bin.v2-libs-regex-test-regex_config_info.test-msvc-7.1-release-threading-multi">
  181. Pass</a></td>
  182. </tr>
  183. <tr>
  184. <td>regex_dll_config_info</td>
  185. <td class="c1" align="right">Missing</td>
  186. <td align="right"><a href=
  187. "links.html#C:-Boost134-bin.v2-libs-regex-test-regex_dll_config_info.test-msvc-7.1-debug-threading-multi">
  188. Pass</a></td>
  189. <td class="c1" align="right">Missing</td>
  190. <td align="right"><a href=
  191. "links.html#C:-Boost134-bin.v2-libs-regex-test-regex_dll_config_info.test-msvc-7.1-release-threading-multi">
  192. Pass</a></td>
  193. </tr>
  194. <tr>
  195. <td>regex_regress</td>
  196. <td align="right"><a href=
  197. "links.html#C:-Boost134-bin.v2-libs-regex-test-regex_regress.test-msvc-7.1-debug-link-static-threading-multi">
  198. Pass</a><sup>*</sup></td>
  199. <td class="c1" align="right">Missing</td>
  200. <td align="right"><a href=
  201. "links.html#C:-Boost134-bin.v2-libs-regex-test-regex_regress.test-msvc-7.1-release-link-static-threading-multi">
  202. Pass</a><sup>*</sup></td>
  203. <td class="c1" align="right">Missing</td>
  204. </tr>
  205. <tr>
  206. <td>regex_regress_dll</td>
  207. <td class="c1" align="right">Missing</td>
  208. <td align="right"><a href=
  209. "links.html#C:-Boost134-bin.v2-libs-regex-test-regex_regress_dll.test-msvc-7.1-debug-threading-multi">
  210. Pass</a><sup>*</sup></td>
  211. <td class="c1" align="right">Missing</td>
  212. <td align="right"><a href=
  213. "links.html#C:-Boost134-bin.v2-libs-regex-test-regex_regress_dll.test-msvc-7.1-release-threading-multi">
  214. Pass</a><sup>*</sup></td>
  215. </tr>
  216. <tr>
  217. <td>regex_regress_threaded</td>
  218. <td class="c1" align="right">Missing</td>
  219. <td align="right">Pass</td>
  220. <td class="c1" align="right">Missing</td>
  221. <td align="right">Pass</td>
  222. </tr>
  223. <tr>
  224. <td>static_mutex_test</td>
  225. <td class="c1" align="right">Missing</td>
  226. <td align="right">Pass</td>
  227. <td class="c1" align="right">Missing</td>
  228. <td align="right">Pass</td>
  229. </tr>
  230. <tr>
  231. <td>test_collate_info</td>
  232. <td class="c1" align="right">Missing</td>
  233. <td align="right"><a class="c2" href=
  234. "links.html#C:-Boost134-bin.v2-libs-regex-test-test_collate_info.test-msvc-7.1-debug-threading-multi">
  235. Warn</a></td>
  236. <td class="c1" align="right">Missing</td>
  237. <td align="right"><a class="c2" href=
  238. "links.html#C:-Boost134-bin.v2-libs-regex-test-test_collate_info.test-msvc-7.1-release-threading-multi">
  239. Warn</a></td>
  240. </tr>
  241. <tr>
  242. <td>unicode_iterator_test</td>
  243. <td class="c1" align="right">Missing</td>
  244. <td align="right"><a class="c2" href=
  245. "links.html#C:-Boost134-bin.v2-libs-regex-test-unicode_iterator_test.test-msvc-7.1-debug-threading-multi">
  246. Warn</a></td>
  247. <td class="c1" align="right">Missing</td>
  248. <td align="right"><a class="c2" href=
  249. "links.html#C:-Boost134-bin.v2-libs-regex-test-unicode_iterator_test.test-msvc-7.1-release-threading-multi">
  250. Warn</a></td>
  251. </tr>
  252. <tr>
  253. <td>wide_posix_api_check_c</td>
  254. <td class="c1" align="right">Missing</td>
  255. <td align="right"><a class="c2" href=
  256. "links.html#C:-Boost134-bin.v2-libs-regex-test-wide_posix_api_check_c.test-msvc-7.1-debug-threading-multi">
  257. Warn</a></td>
  258. <td class="c1" align="right">Missing</td>
  259. <td align="right"><a class="c2" href=
  260. "links.html#C:-Boost134-bin.v2-libs-regex-test-wide_posix_api_check_c.test-msvc-7.1-release-threading-multi">
  261. Warn</a></td>
  262. </tr>
  263. <tr>
  264. <td>wide_posix_api_check_cpp</td>
  265. <td class="c1" align="right">Missing</td>
  266. <td align="right"><a class="c2" href=
  267. "links.html#C:-Boost134-bin.v2-libs-regex-test-wide_posix_api_check_cpp.test-msvc-7.1-debug-threading-multi">
  268. Warn</a></td>
  269. <td class="c1" align="right">Missing</td>
  270. <td align="right"><a class="c2" href=
  271. "links.html#C:-Boost134-bin.v2-libs-regex-test-wide_posix_api_check_cpp.test-msvc-7.1-release-threading-multi">
  272. Warn</a></td>
  273. </tr>
  274. </table>
  275. <p>This table was generated by invoking the following command line:</p>
  276. <p><code>../../../tools/regression/library_test --toolset=msvc-7.1
  277. variant=debug,release</code></p>
  278. <p>from within the .../libs/regex/test directory.</p>
  279. <p>This table shows the regex test results for both debug and release
  280. versions of the library. Also it displays the fact that one of the tests is
  281. run specifically with the static linking/multi-threading versions of the
  282. runtime libraries. The cells marked "Missing" correspond to tests that were
  283. not run for some reason or another. This is usually because the
  284. corresponding <code>Jamfile.v2</code> excludes this test for the given
  285. combination of compiler and build attributes. In this example, all tests
  286. were run with the same compiler. If additional compilers were used, they
  287. would appear as more columns in the table.</p>
  288. <p>The table above is just an illustration so the links don't actually
  289. point to anything. In the table you generated, the links will display a
  290. page describing any errors, warnings or other available information about
  291. the tests. If the test passes, usually, there is no additional information
  292. and hence no link.</p>
  293. <p>The tables are cumulative. That is, if you run one set of tests now and
  294. tests with different attributes later, the table will contain all the
  295. results to date. The test results are stored in
  296. <code>../bin.v2/libs/test/&lt;library%gt;/...</code>. To reinitialize the
  297. test results to empty, delete the corresponding files in this
  298. directory.</p>
  299. <p>The procedure above assumes that the table are generated within the
  300. directory <code>../libs/&lt;library&gt;/test</code>. This is the most
  301. common case since this directory contains the <code>Jamfile.v2</code> as
  302. well as the source code that is used by official boost testers. However,
  303. this is just a convention. The table can be generated for other directories
  304. within the libary. One possiblity would be to generate the table for all
  305. the examples in <code>../libs/%lt;library%gt;/example</code>. Or one might
  306. have a special directory of performance tests which take a long time to run
  307. and hence are not suitable for running by official boost testers. Just
  308. remember that library status table is generated in the directory from which
  309. the <code>library_test</code> command is invoked.</p>
  310. <h3>Running Tests for All Libraries</h3>For those with *nix or cygwin
  311. command line shells, there is shell script that can be run from the boost
  312. root directory:
  313. <p><code>tools/regression/library_test_all</code></p>
  314. <p>The command line arguments are the same as for running the test for one
  315. library. This script creates all the html files in all the test directories
  316. as well as an html page in the <code>status</code> directory named
  317. <code>library_status_summary.html</code>. This can be used to browse
  318. through all test results for all test in all libraries.</p>
  319. <hr />
  320. <p>Copyright 2007 Robert Ramey. Distributed under the Boost Software
  321. License, Version 1.0. (See accompanying file LICENSE_1_0.txt or
  322. http://www.boost.org/LICENSE_1_0.txt)</p>
  323. <p>Revised $Date$</p>
  324. </body>
  325. </html>
粤ICP备19079148号