summaryrefslogtreecommitdiffstats
path: root/Source/cmTest.cxx
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2013-09-16 18:38:23 (GMT)
committerBrad King <brad.king@kitware.com>2013-10-16 13:22:36 (GMT)
commit399e9c46d88c12507f1a762e69225c5ab9f4ac08 (patch)
treeb220aa74b78aaccdb819e7a4d76a78dea3654b1f /Source/cmTest.cxx
parent6035c0458e511bae94959ff4e01800dd14384fc2 (diff)
downloadCMake-399e9c46d88c12507f1a762e69225c5ab9f4ac08.zip
CMake-399e9c46d88c12507f1a762e69225c5ab9f4ac08.tar.gz
CMake-399e9c46d88c12507f1a762e69225c5ab9f4ac08.tar.bz2
Drop builtin property documentation
Drop all DefineProperty calls for non-chained properties. Drop the documentation from the chained ones. The documentation for all properties is now in Help/prop_*/*.rst files.
Diffstat (limited to 'Source/cmTest.cxx')
-rw-r--r--Source/cmTest.cxx111
1 files changed, 0 insertions, 111 deletions
diff --git a/Source/cmTest.cxx b/Source/cmTest.cxx
index 0904431..9cda978 100644
--- a/Source/cmTest.cxx
+++ b/Source/cmTest.cxx
@@ -92,114 +92,3 @@ void cmTest::AppendProperty(const char* prop, const char* value, bool asString)
}
this->Properties.AppendProperty(prop, value, cmProperty::TEST, asString);
}
-
-//----------------------------------------------------------------------------
-void cmTest::DefineProperties(cmake *cm)
-{
- cm->DefineProperty
- ("ATTACHED_FILES", cmProperty::TEST,
- "Attach a list of files to a dashboard submission.",
- "Set this property to a list of files that will be encoded and "
- "submitted to the dashboard as an addition to the test result.");
-
- cm->DefineProperty
- ("ATTACHED_FILES_ON_FAIL", cmProperty::TEST,
- "Attach a list of files to a dashboard submission if the test fails.",
- "Same as ATTACHED_FILES, but these files will only be included if the "
- "test does not pass.");
-
- cm->DefineProperty
- ("COST", cmProperty::TEST,
- "Set this to a floating point value. Tests in a test set will be "
- "run in descending order of cost.", "This property describes the cost "
- "of a test. You can explicitly set this value; tests with higher COST "
- "values will run first.");
-
- cm->DefineProperty
- ("DEPENDS", cmProperty::TEST,
- "Specifies that this test should only be run after the specified "
- "list of tests.",
- "Set this to a list of tests that must finish before this test is run.");
-
- cm->DefineProperty
- ("ENVIRONMENT", cmProperty::TEST,
- "Specify environment variables that should be defined for running "
- "a test.",
- "If set to a list of environment variables and values of the form "
- "MYVAR=value those environment variables will be defined while "
- "running the test. The environment is restored to its previous state "
- "after the test is done.");
-
- cm->DefineProperty
- ("FAIL_REGULAR_EXPRESSION", cmProperty::TEST,
- "If the output matches this regular expression the test will fail.",
- "If set, if the output matches one of "
- "specified regular expressions, the test will fail."
- "For example: FAIL_REGULAR_EXPRESSION \"[^a-z]Error;ERROR;Failed\"");
-
- cm->DefineProperty
- ("LABELS", cmProperty::TEST,
- "Specify a list of text labels associated with a test.",
- "The list is reported in dashboard submissions.");
-
- cm->DefineProperty
- ("RESOURCE_LOCK", cmProperty::TEST,
- "Specify a list of resources that are locked by this test.",
- "If multiple tests specify the same resource lock, they are guaranteed "
- "not to run concurrently.");
-
- cm->DefineProperty
- ("MEASUREMENT", cmProperty::TEST,
- "Specify a CDASH measurement and value to be reported for a test.",
- "If set to a name then that name will be reported to CDASH as a "
- "named measurement with a value of 1. You may also specify a value "
- "by setting MEASUREMENT to \"measurement=value\".");
-
- cm->DefineProperty
- ("PASS_REGULAR_EXPRESSION", cmProperty::TEST,
- "The output must match this regular expression for the test to pass.",
- "If set, the test output will be checked "
- "against the specified regular expressions and at least one of the"
- " regular expressions has to match, otherwise the test will fail.");
-
- cm->DefineProperty
- ("PROCESSORS", cmProperty::TEST,
- "How many process slots this test requires",
- "Denotes the number of processors that this test will require. This is "
- "typically used for MPI tests, and should be used in conjunction with "
- "the ctest_test PARALLEL_LEVEL option.");
-
- cm->DefineProperty
- ("REQUIRED_FILES", cmProperty::TEST,
- "List of files required to run the test.",
- "If set to a list of files, the test will not be run unless all of the "
- "files exist.");
-
- cm->DefineProperty
- ("RUN_SERIAL", cmProperty::TEST,
- "Do not run this test in parallel with any other test.",
- "Use this option in conjunction with the ctest_test PARALLEL_LEVEL "
- "option to specify that this test should not be run in parallel with "
- "any other tests.");
-
- cm->DefineProperty
- ("TIMEOUT", cmProperty::TEST,
- "How many seconds to allow for this test.",
- "This property if set will limit a test to not take more than "
- "the specified number of seconds to run. If it exceeds that the "
- "test process will be killed and ctest will move to the next test. "
- "This setting takes precedence over "
- "CTEST_TESTING_TIMEOUT.");
-
- cm->DefineProperty
- ("WILL_FAIL", cmProperty::TEST,
- "If set to true, this will invert the pass/fail flag of the test.",
- "This property can be used for tests that are expected to fail and "
- "return a non zero return code.");
-
- cm->DefineProperty
- ("WORKING_DIRECTORY", cmProperty::TEST,
- "The directory from which the test executable will be called.",
- "If this is not set it is called from the directory the test executable "
- "is located in.");
-}