summaryrefslogtreecommitdiffstats
path: root/Help/prop_test/DISABLED.rst
diff options
context:
space:
mode:
authorBartosz Kosiorek <bartosz.kosiorek@tomtom.com>2019-04-01 13:14:27 (GMT)
committerBartosz Kosiorek <bartosz.kosiorek@tomtom.com>2019-04-04 13:13:58 (GMT)
commit456e0fb64f5c70191145c34104d6f25bd24b7b37 (patch)
treef728b6b9ea236c5d0bb84ba91a9e5dd7a04471bc /Help/prop_test/DISABLED.rst
parent5ad73b608d4fc7cc6b30017159b800802a503b0c (diff)
downloadCMake-456e0fb64f5c70191145c34104d6f25bd24b7b37.zip
CMake-456e0fb64f5c70191145c34104d6f25bd24b7b37.tar.gz
CMake-456e0fb64f5c70191145c34104d6f25bd24b7b37.tar.bz2
Help: Improve documentation formating
Diffstat (limited to 'Help/prop_test/DISABLED.rst')
-rw-r--r--Help/prop_test/DISABLED.rst14
1 files changed, 7 insertions, 7 deletions
diff --git a/Help/prop_test/DISABLED.rst b/Help/prop_test/DISABLED.rst
index c18ae7f..1d469e8 100644
--- a/Help/prop_test/DISABLED.rst
+++ b/Help/prop_test/DISABLED.rst
@@ -1,15 +1,15 @@
DISABLED
--------
-If set to true, the test will be skipped and its status will be 'Not Run'. A
-DISABLED test will not be counted in the total number of tests and its
-completion status will be reported to CDash as 'Disabled'.
+If set to ``True``, the test will be skipped and its status will be 'Not Run'. A
+``DISABLED`` test will not be counted in the total number of tests and its
+completion status will be reported to CDash as ``Disabled``.
-A DISABLED test does not participate in test fixture dependency resolution.
-If a DISABLED test has fixture requirements defined in its
+A ``DISABLED`` test does not participate in test fixture dependency resolution.
+If a ``DISABLED`` test has fixture requirements defined in its
:prop_test:`FIXTURES_REQUIRED` property, it will not cause setup or cleanup
tests for those fixtures to be added to the test set.
-If a test with the :prop_test:`FIXTURES_SETUP` property set is DISABLED, the
-fixture behavior will be as though that setup test was passing and any test
+If a test with the :prop_test:`FIXTURES_SETUP` property set is ``DISABLED``,
+the fixture behavior will be as though that setup test was passing and any test
case requiring that fixture will still run.