ceph/src/boost/libs/test/doc/test.qbk

   1 [/
   2  / Copyright (c) 2003 Boost.Test contributors
   3  /
   4  / Distributed under the Boost Software License, Version 1.0. (See accompanying
   5  / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
   6  /]
   7
   8 [library Boost.Test
   9     [quickbook 1.7]
  10     [copyright 2001 - 2016 Boost.Test contributors]
  11     [id boost_test]
  12     [purpose Testing library]
  13     [license
  14         Distributed under the Boost Software License, Version 1.0.
  15         (See accompanying file LICENSE_1_0.txt or copy at
  16         [@http://www.boost.org/LICENSE_1_0.txt])
  17     ]
  18     [authors [Rozental, Gennadiy] [Enficiaud, Raffi]]
  19     [category Correctness and testing]
  20 ]
  21
  22 [template ticket[number]'''<ulink url="https://svn.boost.org/trac/boost/ticket/'''[number]'''">'''#[number]'''</ulink>''']
  23 [template pull_request[number]'''<ulink url="https://github.com/boostorg/test/pull/'''[number]'''">'''#PR-[number]'''</ulink>''']
  24
  25 [def __UTF__ /Unit Test Framework/]
  26 [def __PEM__ /Program Execution Monitor]
  27
  28 [def __IEEE754__ [*IEEE754]]
  29
  30 [def __part_faq__                         [link boost_test.section_faq FAQ]]
  31
  32 [/ content in the test organization]
  33
  34 [def __floating_points_testing_tools__    [link boost_test.testing_tools.extended_comparison.floating_point.floating_points_comparison_theory Floating point comparison algorithms]]
  35 [def __master_test_suite__                [link boost_test.tests_organization.test_suite.master_test_suite master test suite]]
  36
  37 [def __runtime_configuration__            [link boost_test.runtime_config runtime configuration]]
  38 [def __output_test_stream_tool__          [link boost_test.testing_tools.output_stream_testing output test stream]]
  39
  40 [def __auto_linking__                     [link ref_pem_auto_link automatic linking]]
  41
  42 [def __BOOST_TEST_ALTERNATIVE_INIT_API__  [link boost_test.utf_reference.link_references.link_boost_test_alternative_init_macro `BOOST_TEST_ALTERNATIVE_INIT_API`]]
  43 [def __BOOST_TEST_MAIN__                  [link boost_test.utf_reference.link_references.link_boost_test_main_macro             `BOOST_TEST_MAIN`]]
  44 [def __BOOST_TEST_DYN_LINK__              [link boost_test.utf_reference.link_references.link_boost_test_dyn_link               `BOOST_TEST_DYN_LINK`]]
  45 [def __BOOST_TEST_NO_LIB__                [link boost_test.utf_reference.link_references.link_boost_test_no_lib                 `BOOST_TEST_NO_LIB`]]
  46 [def __BOOST_TEST_NO_MAIN__               [link boost_test.utf_reference.link_references.link_boost_test_no_main                `BOOST_TEST_NO_MAIN`]]
  47 [def __BOOST_TEST_MODULE__                [link boost_test.utf_reference.link_references.link_boost_test_module_macro           `BOOST_TEST_MODULE`]]
  48
  49 [def __BOOST_TEST_CHECKPOINT__            [link boost_test.utf_reference.testout_reference.test_output_macro_checkpoint   `BOOST_TEST_CHECKPOINT`]]
  50 [def __BOOST_TEST_PASSPOINT__             [link boost_test.utf_reference.testout_reference.test_output_macro_passpoint    `BOOST_TEST_PASSPOINT`]]
  51 [def __BOOST_TEST_MESSAGE__               [link boost_test.utf_reference.testout_reference.test_output_macro_message      `BOOST_TEST_MESSAGE`]]
  52 [def __BOOST_TEST_INFO__                  [link boost_test.utf_reference.testout_reference.test_output_macro_info         `BOOST_TEST_INFO`]]
  53 [def __BOOST_TEST_CONTEXT__               [link boost_test.utf_reference.testout_reference.test_output_macro_context      `BOOST_TEST_CONTEXT`]]
  54 [def __BOOST_TEST_DONT_PRINT_LOG_VALUE__  [link boost_test.utf_reference.testout_reference.test_output_macro_disable_type `BOOST_TEST_DONT_PRINT_LOG_VALUE`]]
  55
  56
  57 [/ Assertions ]
  58 [def __BOOST_TEST__                       [link boost_test.utf_reference.testing_tool_ref.assertion_boost_test_universal_macro `BOOST_TEST`]]
  59 [def __BOOST_TEST_LEVEL__                 [link boost_test.utf_reference.testing_tool_ref.assertion_boost_test_universal_macro `BOOST_TEST_<level>`]]
  60 [def __BOOST_TEST_REQUIRE__               [link boost_test.utf_reference.testing_tool_ref.assertion_boost_test_universal_macro `BOOST_TEST_REQUIRE`]]
  61
  62 [def __BOOST_LEVEL__                      [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level `BOOST_<level>`]]
  63
  64 [def __BOOST_LEVEL_MESSAGE__              [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_message `BOOST_<level>_MESSAGE`]]
  65
  66 [def __BOOST_LEVEL_EQUAL__                [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_eq `BOOST_<level>_EQUAL`]]
  67
  68 [def __BOOST_LEVEL_PREDICATE__            [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_predicate `BOOST_<level>_PREDICATE`]]
  69 [def __BOOST_LEVEL_EQUAL_COLLECTIONS__    [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_eq_collections `BOOST_<level>_EQUAL_COLLECTIONS`]]
  70 [def __BOOST_LEVEL_NE__                   [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_ne `BOOST_<level>_NE`]]
  71 [def __BOOST_LEVEL_GE__                   [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_ge `BOOST_<level>_GE`]]
  72 [def __BOOST_LEVEL_GT__                   [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_gt `BOOST_<level>_GT`]]
  73 [def __BOOST_LEVEL_LE__                   [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_le `BOOST_<level>_LE`]]
  74 [def __BOOST_LEVEL_LT__                   [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_lt `BOOST_<level>_LT`]]
  75
  76 [def __BOOST_LEVEL_NO_THROW__             [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_no_throw `BOOST_<level>_NO_THROW`]]
  77 [def __BOOST_LEVEL_THROW__                [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_throw `BOOST_<level>_THROW`]]
  78 [def __BOOST_LEVEL_EXCEPTION__            [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_exception `BOOST_<level>_EXCEPTION`]]
  79
  80 [def __BOOST_LEVEL_BITWISE_EQUAL__        [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_bitwise_eq `BOOST_<level>_BITWISE_EQUAL`]]
  81 [def __BOOST_ERROR__                      [link boost_test.utf_reference.testing_tool_ref.assertion_boost_error `BOOST_ERROR`]]
  82 [def __BOOST_FAIL__                       [link boost_test.utf_reference.testing_tool_ref.assertion_boost_fail `BOOST_FAIL`]]
  83 [def __BOOST_IS_DEFINED__                 [link boost_test.utf_reference.testing_tool_ref.assertion_boost_is_defined `BOOST_IS_DEFINED`]]
  84
  85 [def __BOOST_AUTO_TEST_CASE_EXPECTED_FAILURES__ [link boost_test.utf_reference.testing_tool_ref.test_org_boost_test_case_expected_failure `BOOST_AUTO_TEST_CASE_EXPECTED_FAILURES`]]
  86
  87 [/ Assertions / floating point]
  88 [def __BOOST_LEVEL_SMALL__                [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_small `BOOST_<level>_SMALL`]]
  89 [def __BOOST_CHECK_SMALL__                [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_small `BOOST_CHECK_SMALL`]]
  90 [def __BOOST_LEVEL_CLOSE__                [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_close `BOOST_<level>_CLOSE`]]
  91 [def __BOOST_CHECK_CLOSE__                [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_close `BOOST_CHECK_CLOSE`]]
  92 [def __BOOST_LEVEL_CLOSE_FRACTION__       [link boost_test.utf_reference.testing_tool_ref.assertion_boost_level_close_fraction `BOOST_<level>_CLOSE_FRACTION`]]
  93
  94 [/ Assertion control]
  95 [def __BOOST_TEST_TOOLS_UNDER_DEBUGGER__  [link boost_test.utf_reference.testing_tool_ref.assertion_control_under_debugger `BOOST_TEST_TOOLS_UNDER_DEBUGGER`]]
  96 [def __BOOST_TEST_TOOLS_DEBUGGABLE__      [link boost_test.utf_reference.testing_tool_ref.assertion_control_under_debuggable `BOOST_TEST_TOOLS_DEBUGGABLE`]]
  97
  98 [/ Tests cases organization]
  99 [def __BOOST_AUTO_TEST_CASE__                   [link boost_test.utf_reference.test_org_reference.test_org_boost_auto_test_case `BOOST_AUTO_TEST_CASE`]]
 100 [def __BOOST_TEST_CASE__                        [link boost_test.utf_reference.test_org_reference.test_org_boost_test_case `BOOST_TEST_CASE`]]
 101 [def __BOOST_AUTO_TEST_CASE_TEMPLATE__          [link boost_test.utf_reference.test_org_reference.test_org_boost_test_case_auto_template `BOOST_AUTO_TEST_CASE_TEMPLATE`]]
 102 [def __BOOST_TEST_CASE_TEMPLATE__               [link boost_test.utf_reference.test_org_reference.test_org_boost_test_case_template `BOOST_TEST_CASE_TEMPLATE`]]
 103 [def __BOOST_TEST_CASE_TEMPLATE_FUNCTION__      [link boost_test.utf_reference.test_org_reference.test_org_boost_test_case_template_function `BOOST_TEST_CASE_TEMPLATE_FUNCTION`]]
 104 [/ parametrized test cases]
 105 [def __BOOST_PARAM_TEST_CASE__                  [link boost_test.utf_reference.test_org_reference.test_org_boost_test_case_parameter `BOOST_PARAM_TEST_CASE`]]
 106 [def __BOOST_DATA_TEST_CASE__                   [link boost_test.utf_reference.test_org_reference.test_org_boost_test_dataset `BOOST_DATA_TEST_CASE`]]
 107 [def __BOOST_DATA_TEST_CASE_F__                 [link boost_test.utf_reference.test_org_reference.test_org_boost_test_dataset_fixture `BOOST_DATA_TEST_CASE_F`]]
 108 [def __BOOST_TEST_DATASET_MAX_ARITY__           [link boost_test.utf_reference.test_org_reference.test_org_boost_test_dataset `BOOST_TEST_DATASET_MAX_ARITY`]]
 109
 110 [/ test suites]
 111 [def __BOOST_AUTO_TEST_SUITE__                  [link boost_test.utf_reference.test_org_reference.test_org_boost_auto_test_suite `BOOST_AUTO_TEST_SUITE`]]
 112 [def __BOOST_AUTO_TEST_SUITE_END__              [link boost_test.utf_reference.test_org_reference.test_org_boost_auto_test_suite_end `BOOST_AUTO_TEST_SUITE_END`]]
 113 [def __BOOST_TEST_SUITE__                       [link boost_test.utf_reference.test_org_reference.test_org_boost_test_suite `BOOST_TEST_SUITE`]]
 114 [/ decorator]
 115 [def __BOOST_TEST_DECORATOR__                   [link boost_test.utf_reference.test_org_reference.test_org_boost_test_decorator `BOOST_TEST_DECORATOR`]]
 116 [/ fixtures]
 117 [def __BOOST_FIXTURE_TEST_CASE__                [link boost_test.utf_reference.test_org_reference.test_org_boost_test_case_fixture     `BOOST_FIXTURE_TEST_CASE`]]
 118 [def __BOOST_FIXTURE_TEST_SUITE__               [link boost_test.utf_reference.test_org_reference.test_org_boost_test_suite_fixture    `BOOST_FIXTURE_TEST_SUITE`]]
 119 [def __BOOST_GLOBAL_FIXTURE__                   [link boost_test.utf_reference.test_org_reference.test_org_boost_global_fixture   `BOOST_GLOBAL_FIXTURE`]]
 120
 121 [/ log]
 122 [def __BOOST_TEST_LOG_LEVEL__                   [link boost_test.utf_reference.rt_param_reference.log_level `BOOST_TEST_LOG_LEVEL`]] [/ this is an environment variable]
 123
 124 [/ runtime/cla parameters]
 125 [def __default_run_status__                     [link ref_default_run_status ['default run status]]]
 126 [def __param_run_test__                         [link boost_test.utf_reference.rt_param_reference.run_test `run_test`]]
 127
 128 [/ decorators]
 129 [def __decorator_label__                        [link boost_test.utf_reference.test_org_reference.decorator_label `label`]]
 130 [def __decorator_enabled__                      [link boost_test.utf_reference.test_org_reference.decorator_enabled `enabled`]]
 131 [def __decorator_disabled__                     [link boost_test.utf_reference.test_org_reference.decorator_enabled `disabled`]]
 132 [def __decorator_enable_if__                    [link boost_test.utf_reference.test_org_reference.decorator_enable_if `enable_if`]]
 133 [def __decorator_depends_on__                   [link boost_test.utf_reference.test_org_reference.decorator_depends_on `depends_on`]]
 134 [def __decorator_precondition__                 [link boost_test.utf_reference.test_org_reference.decorator_precondition `precondition`]]
 135 [def __decorator_fixture__                      [link boost_test.utf_reference.test_org_reference.decorator_fixture `fixture`]]
 136 [def __decorator_description__                  [link boost_test.utf_reference.test_org_reference.decorator_description   `description`]]
 137
 138 [def __decorator_expected_failures__            [link boost_test.utf_reference.testing_tool_ref.decorator_expected_failures `expected_failures`]]
 139 [def __decorator_timeout__                      [link boost_test.utf_reference.testing_tool_ref.decorator_timeout `timeout`]]
 140 [def __decorator_tolerance__                    [link boost_test.utf_reference.testing_tool_ref.decorator_tolerance `tolerance`]]
 141
 142
 143
 144 [/=============================================================================]
 145 [/ templates ]
 146
 147
 148 [template bt_example[name descr rule]
 149
 150 [h5 Example: [descr]]
 151
 152 [import ../examples/[name].[rule].cpp]
 153 [import ../examples/[name].output]
 154 [table
 155   [[Code]]
 156   [[[example_code]]]
 157 ]
 158
 159 [table
 160   [[Output]]
 161   [[[example_output]]]
 162 ]
 163 ] [/ end bt_example]
 164
 165
 166 [/ ### template for the example page  ]
 167 [template bt_example_page[name descr]
 168
 169 [section:ref_[name] [descr]]
 170
 171 [import examples/[name].run-fail.cpp]
 172 [import examples/[name].output]
 173
 174 [heading Source]
 175 [example_code]
 176
 177 [heading Output]
 178 [example_output]
 179
 180 [endsect]
 181
 182 ] [/ end bt_example_page]
 183
 184
 185
 186
 187 [/=============================================================================]
 188
 189 [/ introduction material and general presentation ]
 190 [include introduction/introduction.qbk]
 191
 192 [/ ##### Users guide ##### ]
 193 [/ intro into usage variants]
 194 [include usage_variants.qbk]
 195
 196 [/ organizing, generating and registering tests]
 197 [include test_organization/test_organization.qbk]
 198
 199 [/ creating assertions]
 200 [include testing_tools/testing_tools.qbk]
 201
 202 [/ controlling outputs]
 203 [include test_output/test_output.qbk]
 204
 205 [/ command line + environment options]
 206 [include runtime_configuration/runtime_configuration.qbk]
 207
 208 [/ ##### Advanced scenarios ##### ]
 209 [include adv_scenarios.qbk]
 210
 211 [/=============================================================================]
 212
 213 [/TOFIX ]
 214 [/include program_execution_monitor.qbk]
 215
 216 [/=============================================================================]
 217
 218 [include usage_recommendations.qbk]
 219
 220 [/=============================================================================]
 221 [/ Closing parts]
 222
 223 [include closing_chapters/faq.qbk]
 224 [include closing_chapters/glossary.qbk]
 225 [include closing_chapters/change_log.qbk]
 226 [include closing_chapters/acknowledgments.qbk]
 227
 228
 229 [/=============================================================================]
 230 [/ References]
 231
 232 [section:utf_reference __UTF__ API reference]
 233 [include test_organization/testorg_reference.qbk]
 234 [include testing_tools/testing_tools_reference.qbk]
 235 [include test_output/testout_reference.qbk]
 236 [include runtime_configuration/runtime_config_reference.qbk]
 237 [include adv_scenarios/link_reference.qbk]
 238 [/ doxygen auto-generated reference documentation]
 239 [xinclude doxygen_reference_generated_doc.xml]
 240 [endsect]
 241
 242
 243
 244 [/=============================================================================]
 245
 246
 247
 248 [/ EOF]