Merge topic 'test_fixture_doc_improvements'

2e3d89a7 Help: Clarify test fixture naming and use

Acked-by: Kitware Robot <[email protected]>
Merge-request: !1114

Help/prop_test/FIXTURES_CLEANUP.rst

@@ -2,7 +2,8 @@ FIXTURES_CLEANUP
 ----------------
 
 Specifies a list of fixtures for which the test is to be treated as a cleanup
-test.
+test. These fixture names are distinct from test case names and are not
+required to have any similarity to the names of tests associated with them.
 
 Fixture cleanup tests are ordinary tests with all of the usual test
 functionality. Setting the ``FIXTURES_CLEANUP`` property for a test has two

Help/prop_test/FIXTURES_REQUIRED.rst

@@ -2,7 +2,7 @@ FIXTURES_REQUIRED
 -----------------
 
 Specifies a list of fixtures the test requires. Fixture names are case
-sensitive.
+sensitive and they are not required to have any similarity to test names.
 
 Fixtures are a way to attach setup and cleanup tasks to a set of tests. If a
 test requires a given fixture, then all tests marked as setup tasks for that
@@ -19,7 +19,9 @@ some setup tests fail.
 When CTest is asked to execute only a subset of tests (e.g. by the use of
 regular expressions or when run with the ``--rerun-failed`` command line
 option), it will automatically add any setup or cleanup tests for fixtures
-required by any of the tests that are in the execution set.
+required by any of the tests that are in the execution set. This behavior can
+be overridden with the ``-FS``, ``-FC`` and ``-FA`` command line options to
+:manual:`ctest(1)` if desired.
 
 Since setup and cleanup tasks are also tests, they can have an ordering
 specified by the :prop_test:`DEPENDS` test property just like any other tests.

Help/prop_test/FIXTURES_SETUP.rst

@@ -2,14 +2,15 @@ FIXTURES_SETUP
 --------------
 
 Specifies a list of fixtures for which the test is to be treated as a setup
-test.
+test. These fixture names are distinct from test case names and are not
+required to have any similarity to the names of tests associated with them.
 
 Fixture setup tests are ordinary tests with all of the usual test
 functionality. Setting the ``FIXTURES_SETUP`` property for a test has two
 primary effects:
 
 - CTest will ensure the test executes before any other test which lists the
-  fixture(s) in its :prop_test:`FIXTURES_REQUIRED` property.
+  fixture name(s) in its :prop_test:`FIXTURES_REQUIRED` property.
 
 - If CTest is asked to run only a subset of tests (e.g. using regular
   expressions or the ``--rerun-failed`` option) and the setup test is not in