summaryrefslogtreecommitdiff
path: root/Help/prop_test
Commit message (Collapse)AuthorAgeFilesLines
* Help:add_test: emphasize important pointsscivision2023-02-151-2/+3
| | | | | | | * enable_testing must be called to enable testing * can only set properties on tests created in same directory * WILL_FAIL still fails on segfault and similar * compact wording
* Help: remove links from pages to themselvesBen Boeckel2022-11-181-3/+3
| | | | | At least the top-reference links. Internal `:ref:` usages have been left intact.
* Help: Use role `:program:`Alex Turbov2022-11-061-1/+1
| | | | | When mention execitable names use Sphinx semantic role `:program` instead of ``executable`` or **executable**.
* Help: Add more CLI `:option:` references to various pagesAlex Turbov2022-10-201-4/+5
|
* Help: Use `:option:` role to reference `ctest` optionsAlex Turbov2022-08-141-1/+1
|
* Merge topic 'doc-list-semicolons'Brad King2022-03-162-8/+9
|\ | | | | | | | | | | | | | | | | | | 8abd714176 Help: Clarify that ENVIRONMENT test properties take ;-separated lists 02cf404ace Help: Add advice for dealing with semicolons in lists c4117d9116 ExternalProject: Document that LIST_SEPARATOR works for CMAKE_ARGS too Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Ben Boeckel <ben.boeckel@kitware.com> Merge-request: !7066
| * Help: Clarify that ENVIRONMENT test properties take ;-separated listsBrad King2022-03-152-8/+9
| | | | | | | | | | | | | | | | Follow up commit 79f64cc773 (Help: ENVIRONMENT_MODIFICATION clarify only supports singular values, 2022-02-23) to specifically call out the list format. Issue: #23315
* | Help: ENVIRONMENT_MODIFICATION clarify only supports singular valuesRobert Maynard2022-02-231-9/+11
|/ | | | Lists need to be externally iterated
* Help: ENVIRONMENT_MODIFICATION path_list_... separator is based on hostCraig Scott2021-11-211-2/+4
| | | Fixes: #22937
* Help: Improve cross-referencing of test LABELS and related featuresCraig Scott2021-11-131-2/+6
|
* Help: Clarify ENVIRONMENT_MODIFICATION case sensitivityMichael Hirsch2021-10-261-2/+3
|
* Help: Update Sphinx versionadded directives for 3.22 releaseBrad King2021-10-071-0/+2
| | | | | | | | | Run the script: Utilities/Sphinx/update_versions.py --since v3.21.0 --overwrite Manually select updates that really belong to the 3.22 release, as against adding documentation for previously-existing entities.
* CTest: add an ENVIRONMENT_MODIFICATION propertyBen Boeckel2021-07-091-0/+33
| | | | | | | | | | | | | | | | | | | | This property allows projects to modify environment variables at test time rather than trying to guess what the state should be based on what is present at configure time. Of particular interest is the ability to use a `PATH` present at test time while adding entries known to be necessary for the test itself. There are multiple operations provided to modify variables, including: - setting and unsetting - appending and prepending as: - strings - path lists - CMake lists Additionally, a `reset` action is provided to cancel any prior modifications to that particular variable in the case of incremental additions to the test property.
* Help/prop_test/ENVIRONMENT: clarify the scope of the changesBen Boeckel2021-07-081-2/+2
| | | | | | | The "restored" bit is an implementation detail as it could also be implemented by passing a crafted environment to `execve` or `CreateProcess` arguments. Instead, state that the environment changes only affects the test with the property set.
* Help: Clarify {PASS,FAIL}_REGULAR_EXPRESSION semantics w.r.t. exit codeBrad King2021-05-273-2/+12
| | | | Also cross-reference them with each other and `SKIP_REGULAR_EXPRESSION`.
* Help: Fix typos and spelling in documentationJosef Angstenberger2021-05-071-2/+2
|
* Help: Add Sphinx 'versionadded' directives to each top-level documentKitware Robot2020-07-068-0/+16
| | | | | | | Run the `Utilities/Sphinx/update_versions.py` script to add initial markup to every top-level document and find module. Issue: #19715
* Help: Add example for REQUIRED_FILES test propertyMichael Hirsch2020-06-091-1/+32
|
* Help: Add example for DEPENDS test propertyMichael Hirsch2020-06-091-0/+12
|
* CTest: Clarify that resource requirements can be splitKyle Edwards2019-11-251-0/+16
| | | | | | | Add a note to the documentation to clarify this, and add test cases to ensure it. Fixes: #19987
* CTest: Rename hardware -> resources for CMake variables, command optionsCraig Scott2019-11-051-4/+4
| | | | | | Only changes the user-visible effects of renaming hardware allocation to resource allocation. Code changes are the minimum needed to achieve that.
* CTest: Rename PROCESSES test property to RESOURCE_GROUPSBrad King2019-11-053-61/+61
| | | | | | | | | | | | The `PROCESSES` test property name added for CMake 3.16 is too close to the existing `PROCESSORS` test property. Furthermore, the property in principle specifies groups of resources organized in a way that is meaningful to a particular test. The groups may often correspond to processes but they could have other meanings. Since the property name `PROCESSES` has not been in a final 3.16 release yet, simply rename it to `RESOURCE_GROUPS`. Fixes: #19914
* Help: Add documentation for CTest hardware allocationKyle Edwards2019-10-022-0/+62
|
* Help: Add documentation for SKIP_REGULAR_EXPRESSION test propertyGabor Bencze2019-07-182-0/+19
|
* Help: Valid range for test property, SKIP_RETURN_CODE, is 0 to 255, inclusiveStephen Manz2019-07-021-1/+2
|
* Help: Clarify the default value for test property COSTCraig Scott2019-06-021-4/+10
| | | | Co-Authored-By: Steve Mokris <smokris@softpixel.com>
* Help: Improve documentation formatingBartosz Kosiorek2019-04-046-16/+17
|
* CTest: Add options to control test process affinity to CPUsBrad King2018-03-052-0/+14
| | | | | | | | | | In commit v2.8.0~170 (ENH: Added ctest test options PROCESSORS and RUN_SERIAL, 2009-09-07) CTest learned to track the number of processors allocated to running tests in order to balance it against the desired level of parallelism. Extend this idea by introducing a new `PROCESSOR_AFFINITY` test property to ask that CTest run a test with the CPU affinity mask set. This will allow a set of tests that are running concurrently to use disjoint CPU resources.
* Help: Fix wrong default for WORKING_DIRECTORY test propertyCraig Scott2018-02-271-2/+4
|
* Help: Update documentation for PROCESSORS test propertyBill Hoffman2017-09-081-2/+7
| | | | | This updates the documentation for the PROCESSORS test property to show how it will affect the summary output for labels and sub projects.
* Help: Clarify test fixture naming and useCraig Scott2017-08-083-5/+9
| | | | | | | | * Make it clearer that fixture names are distinct from test case names. * Mention -FS, -FC and -FA ctest command line options for overriding fixture behavior. Fixes: #17141
* Add 'DISABLED' test propertyBetsy McPhail2017-03-291-0/+15
| | | | | | When this property is set, the test is skipped and its status is automatically set to 'Not Run'. A disabled test will not be counted in the total number of tests and its completion status will be 'Disabled'.
* CTest: report time spent after matching outputZack Galbreath2016-10-171-1/+3
| | | | | When using the TIMEOUT_AFTER_MATCH test property, only report the time spent by the test after the matching output was found.
* CTest: Add support for test fixturesCraig Scott2016-09-205-1/+195
| | | | | | | | | | | Add new test properties: * FIXTURES_SETUP * FIXTURES_CLEANUP * FIXTURES_REQUIRED to specify the roles and dependencies of tests providing/using test fixtures.
* Help: Hyperlink propertiesGregor Jasny2016-04-271-2/+2
|
* CTest: Optionally use a secondary test timeout after matching outputZack Galbreath2016-03-221-0/+37
| | | | | | Allow a test N seconds to complete after we detect a matching line in its output. Activate this behavior with a new TIMEOUT_AFTER_MATCH test property.
* Help: Link to properties in set_tests_properties.Stephen Kelly2015-04-042-3/+18
| | | | Remove help for specific properties to their own help pages.
* Help: Fix variable reference in TIMEOUT test property docsZack Galbreath2015-02-101-1/+1
| | | | Link to 'CTEST_TEST_TIMEOUT', not 'CTEST_TESTING_TIMEOUT'.
* allow to mark a test as "Not Run" with a specific return code (#8466)Rolf Eike Beer2014-01-141-0/+9
|
* Convert builtin help to reStructuredText source filesKitware Robot2013-10-1516-0/+119
Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
View Lorry Controller Status