Imported Upstream version 1.72.0

[platform/upstream/boost.git] / libs / test / doc / adv_scenarios / test_module_init_overview.qbk

diff --git a/libs/test/doc/adv_scenarios/test_module_init_overview.qbk b/libs/test/doc/adv_scenarios/test_module_init_overview.qbk
index cc3d8fd..a9f04a7 100644 (file)
--- a/libs/test/doc/adv_scenarios/test_module_init_overview.qbk
+++ b/libs/test/doc/adv_scenarios/test_module_init_overview.qbk
@@ -1,5 +1,5 @@
 [/
- / Copyright (c) 2003 Boost.Test contributors 
+ / Copyright (c) 2003 Boost.Test contributors
  /
  / Distributed under the Boost Software License, Version 1.0. (See accompanying
  / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
@@ -7,13 +7,13 @@
 
 [section:test_module_init_overview Test module's initialization]
 
-In order for a unit test module to successfully link and execute, it has to have access to the ['test module's initialization 
-function]. the module's initialization function is called only once during the execution of the program, just before the 
-[link boost_test.adv_scenarios.test_module_runner_overview ['test module runner]] is run. By default, the __UTF__ provides 
-a default definition of initialization function. The only thing you have to do is to instruct the framework in which translation 
-unit (`cpp` file) it needs to provide the definition. You do it by defining macro __BOOST_TEST_MODULE__ in the designated file. 
-The default implementation assigns the name to the [link ref_test_module test module] as well as the 
-[link boost_test.tests_organization.test_tree.master_test_suite master test suite]. The name to be assigned is specified by 
+In order for a unit test module to successfully link and execute, it has to have access to the ['test module's initialization
+function]. the module's initialization function is called only once during the execution of the program, just before the
+[link boost_test.adv_scenarios.test_module_runner_overview ['test module runner]] is run. By default, the __UTF__ provides
+a default definition of initialization function. The only thing you have to do is to instruct the framework in which translation
+unit (`cpp` file) it needs to provide the definition. You do it by defining macro __BOOST_TEST_MODULE__ in the designated file.
+The default implementation assigns the name to the [link ref_test_module test module] as well as the
+[link boost_test.tests_organization.test_tree.master_test_suite master test suite]. The name to be assigned is specified by
 the value of the macro __BOOST_TEST_MODULE__.
 
 [important
@@ -21,13 +21,18 @@ For a test module consisting of multiple source files you have to define __BOOST
 Otherwise you end up with multiple instances of the initialization function.
 ]
 
-There is practically no need to ever alter the default behavior of the test module's initialization function. The __UTF__ provides superior tools for performing customization tasks:
+There is practically no need to ever alter the default behavior of the test module's initialization function. The __UTF__ provides
+superior tools for performing customization tasks:
 
 * for automatic registration of test cases and test suites in the test tree, see section [link boost_test.tests_organization Tests organization];
 * in order to assign the custom name to the master test suite define macro __BOOST_TEST_MODULE__ to desired value;
-* in order to access the command-line parameters (except the ones consumed by the __UTF__), use the interface of the [link boost_test.tests_organization.test_tree.master_test_suite master test suite];
-* in order to perform a global initialization of the state required by the test cases, [link boost_test.tests_organization.fixtures.global global fixtures] offer a superior alternative: you can specify global set-up and tear-down in one place, allow access to the global data from every test case, and guarantee that clean-up and tear-down is repeated each time the tests are re-run during the execution of the program;
-* if the need for custom module initialization is only driven by legacy code (written against old versions of the __UTF__), it is recommended to update your program's code.
+* in order to access the command-line parameters (except the ones consumed by the __UTF__), use the interface of the
+  [link boost_test.tests_organization.test_tree.master_test_suite master test suite];
+* in order to perform a global initialization of the state required by the test cases, [link boost_test.tests_organization.fixtures.global global fixtures]
+  offer a superior alternative: you can specify global set-up and tear-down in one place, allow access to the global data from every test case, and guarantee
+  that clean-up and tear-down is repeated each time the tests are re-run during the execution of the program;
+* if the need for custom module initialization is only driven by legacy code (written against old versions of the __UTF__), it is recommended
+  to update your program's code.
 
 The default initialization function provided by the framework is defined with the following signature in the global namespace: