kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Move documentation for new set_tests_properties properties.

This commit is contained in:
Zach Mullen 2009-12-17 14:34:47 -05:00
parent 5c2a5e06fd
commit 0477e97988
2 changed files with 46 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Source/cmSetTestsPropertiesCommand.h
View File

@ -64,23 +64,8 @@ public:
" Example: PASS_REGULAR_EXPRESSION \"[^a-z]Error;ERROR;Failed\"\n"
"Both PASS_REGULAR_EXPRESSION and FAIL_REGULAR_EXPRESSION expect a "
"list of regular expressions.\n"
"PROCESSORS: 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.\n"
"COST: Set this to a floating point value. Tests in a test set will be "
"run in descending order of cost.\n"
"TIMEOUT: Setting this will limit the test runtime to the number of "
"seconds specified.\n"
"RUN_SERIAL: If set to true, this test will not run in parallel with "
"any other tests. This should be used in conjunction with "
"the ctest_test PARALLEL_LEVEL option.\n"
"REQUIRED_FILES: Set this to a list of files that must exist in order "
"for the test to be run.\n"
"ATTACHED_FILES: Set this property to a list of files that will be "
"encoded and submitted to the dashboard as an addition to the test "
"result.\n"
"ATTACHED_FILES_ON_FAIL: Same as ATTACHED_FILES, but these files will "
"only be included if the test does not pass.\n";
"seconds specified.\n";
}
cmTypeMacro(cmSetTestsPropertiesCommand, cmCommand);

45
Source/cmTest.cxx
View File

@ -96,6 +96,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 "
@ -131,6 +156,26 @@ void cmTest::DefineProperties(cmake *cm)
"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.",