summaryrefslogtreecommitdiffstats
path: root/Source/cmTest.cxx
diff options
context:
space:
mode:
authorZach Mullen <zach.mullen@kitware.com>2009-12-17 19:34:47 (GMT)
committerZach Mullen <zach.mullen@kitware.com>2009-12-17 19:34:47 (GMT)
commit0477e979880607c7525a067899d1a461c54bde25 (patch)
tree64ef2ee261bd72864a96ea7236bbee16d22c71b6 /Source/cmTest.cxx
parent5c2a5e06fdebc7772ba6b98e075e055f0c18926d (diff)
downloadCMake-0477e979880607c7525a067899d1a461c54bde25.zip
CMake-0477e979880607c7525a067899d1a461c54bde25.tar.gz
CMake-0477e979880607c7525a067899d1a461c54bde25.tar.bz2
Move documentation for new set_tests_properties properties.
Diffstat (limited to 'Source/cmTest.cxx')
-rw-r--r--Source/cmTest.cxx45
1 files changed, 45 insertions, 0 deletions
diff --git a/Source/cmTest.cxx b/Source/cmTest.cxx
index 88b0eae..b52bc19 100644
--- a/Source/cmTest.cxx
+++ b/Source/cmTest.cxx
@@ -97,6 +97,31 @@ void cmTest::AppendProperty(const char* prop, const char* value)
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.",
@@ -132,6 +157,26 @@ void cmTest::DefineProperties(cmake *cm)
" 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 "