diff options
Diffstat (limited to 'share/cmake-3.2/Help/prop_test')
17 files changed, 128 insertions, 0 deletions
diff --git a/share/cmake-3.2/Help/prop_test/ATTACHED_FILES.rst b/share/cmake-3.2/Help/prop_test/ATTACHED_FILES.rst new file mode 100644 index 0000000..496d800 --- /dev/null +++ b/share/cmake-3.2/Help/prop_test/ATTACHED_FILES.rst @@ -0,0 +1,7 @@ +ATTACHED_FILES +-------------- + +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. diff --git a/share/cmake-3.2/Help/prop_test/ATTACHED_FILES_ON_FAIL.rst b/share/cmake-3.2/Help/prop_test/ATTACHED_FILES_ON_FAIL.rst new file mode 100644 index 0000000..6819143 --- /dev/null +++ b/share/cmake-3.2/Help/prop_test/ATTACHED_FILES_ON_FAIL.rst @@ -0,0 +1,7 @@ +ATTACHED_FILES_ON_FAIL +---------------------- + +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. diff --git a/share/cmake-3.2/Help/prop_test/COST.rst b/share/cmake-3.2/Help/prop_test/COST.rst new file mode 100644 index 0000000..3236a02 --- /dev/null +++ b/share/cmake-3.2/Help/prop_test/COST.rst @@ -0,0 +1,7 @@ +COST +---- + +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. diff --git a/share/cmake-3.2/Help/prop_test/DEPENDS.rst b/share/cmake-3.2/Help/prop_test/DEPENDS.rst new file mode 100644 index 0000000..ee946d9 --- /dev/null +++ b/share/cmake-3.2/Help/prop_test/DEPENDS.rst @@ -0,0 +1,6 @@ +DEPENDS +------- + +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. diff --git a/share/cmake-3.2/Help/prop_test/ENVIRONMENT.rst b/share/cmake-3.2/Help/prop_test/ENVIRONMENT.rst new file mode 100644 index 0000000..df9bc9e --- /dev/null +++ b/share/cmake-3.2/Help/prop_test/ENVIRONMENT.rst @@ -0,0 +1,9 @@ +ENVIRONMENT +----------- + +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. diff --git a/share/cmake-3.2/Help/prop_test/FAIL_REGULAR_EXPRESSION.rst b/share/cmake-3.2/Help/prop_test/FAIL_REGULAR_EXPRESSION.rst new file mode 100644 index 0000000..b02d17d --- /dev/null +++ b/share/cmake-3.2/Help/prop_test/FAIL_REGULAR_EXPRESSION.rst @@ -0,0 +1,8 @@ +FAIL_REGULAR_EXPRESSION +----------------------- + +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" diff --git a/share/cmake-3.2/Help/prop_test/LABELS.rst b/share/cmake-3.2/Help/prop_test/LABELS.rst new file mode 100644 index 0000000..8d75570 --- /dev/null +++ b/share/cmake-3.2/Help/prop_test/LABELS.rst @@ -0,0 +1,6 @@ +LABELS +------ + +Specify a list of text labels associated with a test. + +The list is reported in dashboard submissions. diff --git a/share/cmake-3.2/Help/prop_test/MEASUREMENT.rst b/share/cmake-3.2/Help/prop_test/MEASUREMENT.rst new file mode 100644 index 0000000..bc4936e --- /dev/null +++ b/share/cmake-3.2/Help/prop_test/MEASUREMENT.rst @@ -0,0 +1,8 @@ +MEASUREMENT +----------- + +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". diff --git a/share/cmake-3.2/Help/prop_test/PASS_REGULAR_EXPRESSION.rst b/share/cmake-3.2/Help/prop_test/PASS_REGULAR_EXPRESSION.rst new file mode 100644 index 0000000..bb35f77 --- /dev/null +++ b/share/cmake-3.2/Help/prop_test/PASS_REGULAR_EXPRESSION.rst @@ -0,0 +1,8 @@ +PASS_REGULAR_EXPRESSION +----------------------- + +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. diff --git a/share/cmake-3.2/Help/prop_test/PROCESSORS.rst b/share/cmake-3.2/Help/prop_test/PROCESSORS.rst new file mode 100644 index 0000000..763b6d0 --- /dev/null +++ b/share/cmake-3.2/Help/prop_test/PROCESSORS.rst @@ -0,0 +1,8 @@ +PROCESSORS +---------- + +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. diff --git a/share/cmake-3.2/Help/prop_test/REQUIRED_FILES.rst b/share/cmake-3.2/Help/prop_test/REQUIRED_FILES.rst new file mode 100644 index 0000000..fac357c --- /dev/null +++ b/share/cmake-3.2/Help/prop_test/REQUIRED_FILES.rst @@ -0,0 +1,7 @@ +REQUIRED_FILES +-------------- + +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. diff --git a/share/cmake-3.2/Help/prop_test/RESOURCE_LOCK.rst b/share/cmake-3.2/Help/prop_test/RESOURCE_LOCK.rst new file mode 100644 index 0000000..8c30f01 --- /dev/null +++ b/share/cmake-3.2/Help/prop_test/RESOURCE_LOCK.rst @@ -0,0 +1,7 @@ +RESOURCE_LOCK +------------- + +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. diff --git a/share/cmake-3.2/Help/prop_test/RUN_SERIAL.rst b/share/cmake-3.2/Help/prop_test/RUN_SERIAL.rst new file mode 100644 index 0000000..8f65ae1 --- /dev/null +++ b/share/cmake-3.2/Help/prop_test/RUN_SERIAL.rst @@ -0,0 +1,8 @@ +RUN_SERIAL +---------- + +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. diff --git a/share/cmake-3.2/Help/prop_test/SKIP_RETURN_CODE.rst b/share/cmake-3.2/Help/prop_test/SKIP_RETURN_CODE.rst new file mode 100644 index 0000000..c61273c --- /dev/null +++ b/share/cmake-3.2/Help/prop_test/SKIP_RETURN_CODE.rst @@ -0,0 +1,9 @@ +SKIP_RETURN_CODE +---------------- + +Return code to mark a test as skipped. + +Sometimes only a test itself can determine if all requirements for the +test are met. If such a situation should not be considered a hard failure +a return code of the process can be specified that will mark the test as +"Not Run" if it is encountered. diff --git a/share/cmake-3.2/Help/prop_test/TIMEOUT.rst b/share/cmake-3.2/Help/prop_test/TIMEOUT.rst new file mode 100644 index 0000000..d1cb90d --- /dev/null +++ b/share/cmake-3.2/Help/prop_test/TIMEOUT.rst @@ -0,0 +1,9 @@ +TIMEOUT +------- + +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 :variable:`CTEST_TEST_TIMEOUT`. diff --git a/share/cmake-3.2/Help/prop_test/WILL_FAIL.rst b/share/cmake-3.2/Help/prop_test/WILL_FAIL.rst new file mode 100644 index 0000000..f1f94a4 --- /dev/null +++ b/share/cmake-3.2/Help/prop_test/WILL_FAIL.rst @@ -0,0 +1,7 @@ +WILL_FAIL +--------- + +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. diff --git a/share/cmake-3.2/Help/prop_test/WORKING_DIRECTORY.rst b/share/cmake-3.2/Help/prop_test/WORKING_DIRECTORY.rst new file mode 100644 index 0000000..5222a19 --- /dev/null +++ b/share/cmake-3.2/Help/prop_test/WORKING_DIRECTORY.rst @@ -0,0 +1,7 @@ +WORKING_DIRECTORY +----------------- + +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. |