summaryrefslogtreecommitdiffstats
path: root/Help/manual/ctest.1.rst
Commit message (Collapse)AuthorAgeFilesLines
* Help: ctest(1): emphasize the --test-dir optionscivision2023-02-191-2/+3
| | | | | it seems few people know of this option and needlessly add extra shell commands to change directory.
* ctest(1): Add CTEST_NO_TESTS_ACTION env varfriendlyanon2023-01-131-0/+5
| | | | | This environment variable provides a default value for the --no-tests=<action> command line argument.
* Help: Use role `:program:`Alex Turbov2022-11-061-9/+9
| | | | | When mention execitable names use Sphinx semantic role `:program` instead of ``executable`` or **executable**.
* Help: cmake(1), ctest(1), versionadded for key flagsMichael Hirsch2022-10-211-0/+8
|
* Help: Add more CLI `:option:` references to various pagesAlex Turbov2022-10-201-3/+3
|
* Merge topic 'doc-cmake-cli-options'Brad King2022-08-161-87/+107
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | 0224576995 Help: Replace `cmake -P` option mentions w/ Sphinx role 1b94770f27 Help: Insert link to `cmake --toolchain` option 2c54cd871a Help: Turn items of presets manual page into description list e2198fd9dc Help: Format `-Werror`/`-Wno-error` in the way it can be referenced a6070b480f Help: Use placeholder instead of listing choices in option lines 8ba20cb56f Help: Simplify `cmake --log-level` option definition 146e4e6bad Help: Split `ctest` options into groups like `cmake` man page has 4c1008d739 Help: Use `:option:` role to reference `ctest` options ... Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !7554
| * Help: Use placeholder instead of listing choices in option linesAlex Turbov2022-08-141-2/+3
| | | | | | | | | | This avoids any ambiguity with whether the choices are literal values or not. It also makes the option lines more concise.
| * Help: Split `ctest` options into groups like `cmake` man page hasAlex Turbov2022-08-141-83/+100
| | | | | | | | Co-Authored-By: Craig Scott <craig.scott@crascit.com>
| * Help: Consistent spaces in option argsAlex Turbov2022-08-141-1/+1
| |
| * Help: Fix `ctest` options descriptionAlex Turbov2022-08-091-1/+3
| | | | | | | | Missed empty line after `.. option::` and the next paragraph.
* | Help: --build-target can be repeated in ctest --build-and-test modeCraig Scott2022-08-101-2/+5
|/
* Help: Turn some mentions of options into links on executables man pageAlex Turbov2022-08-041-39/+51
|
* Help: Use `option` directive for the executables manual pagesAlex Turbov2022-08-041-75/+149
| | | | | | | It'll allow to refer to a particular option of any executable. There are two "fake" programs added for the CMake script mode (`cmake_P`) and CMake CLI Tool mode (`cmake_E`).
* Help: Document version of ctest(1) adding output truncation modeBrad King2022-05-051-2/+8
| | | | | | While at it, fix mode value markup. Issue: #23206
* ctest: add option for output truncationFrank Winklmeier2022-03-081-0/+4
| | | | | | | | | | Add `--test-output-truncation` to `ctest`. This option can be used to customize which part of the test output is being truncated. Currently supported values are `tail`, `middle` and `head`. Also add equivalent `CTEST_CUSTOM_TEST_OUTPUT_TRUNCATION` variable. Fixes: #23206
* Merge topic 'doc-tests-labels-dynamic'Brad King2021-11-151-0/+4
|\ | | | | | | | | | | | | | | 250acbb099 Help: Improve cross-referencing of test LABELS and related features a77bdefa3e Help: Add missing version details for Additional Test Measurements Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6726
| * Help: Improve cross-referencing of test LABELS and related featuresCraig Scott2021-11-131-0/+4
| |
* | CTest: Add CTEST_SUBMIT_INACTIVITY_TIMEOUT variableNikhil Reddy Ramolla2021-10-141-0/+7
|/ | | | Fixes: #22617
* Help: Improve wording and cross-referencing for ctest JUnit outputCraig Scott2021-07-251-2/+4
|
* Help: Document ctest(1) --interactive-debug-mode limitationBrad King2021-06-091-5/+7
| | | | | Fixes: #22287 Issue: #20115
* Help: links to CMake regex syntaxMichael Hirsch2021-06-021-1/+2
|
* Help: Document CTest custom test measurementsZack Galbreath2021-04-271-0/+2
|
* Help: Fix link to cdash.org from CTest manualZack Galbreath2021-04-271-1/+1
|
* ctest: Add support for writing test results in JUnit XML formatZack Galbreath2021-04-261-0/+6
| | | | Addresses #18654
* ctest: Support multiple -L and -LE options to mean "AND"Adriaan de Groot2021-03-281-2/+48
| | | | Fixes: #21087
* ctest: Add support for '--prefix=<prefix>' form of the argumentBrad King2021-02-231-1/+1
| | | | | | | The main `cmake --preset` argument for configure presets supports both forms, so support it for `ctest --preset` too. Fixes: #21855
* Help: Link to tool-specific preset arguments from cmake-presets(7)Brad King2021-02-181-0/+2
| | | | Fixes: #21835
* Help: Add documentation for buildPresets and testPresetsSam Freed2021-02-011-0/+10
|
* Ctest: Support build tree on command lineAsit Dhal2020-12-171-0/+3
| | | | Fixes: #21268
* CTest: Rename CudaMemcheck to CudaSanitizerTobias Ribizel2020-11-171-5/+5
|
* Help: Add cuda-memcheck to CTest documentationTobias Ribizel2020-11-051-0/+14
| | | | Issue: #21388
* Fix typos identified using codespellJean-Christophe Fillion-Robin2020-07-221-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | See https://github.com/codespell-project/codespell#readme The following command was used: ``` codespell -q6 --skip="\ .git,\ *.json,\ ./Copyright.txt,\ ./Help/command/foreach.rst,\ ./Help/prop_test/REQUIRED_FILES.rst,\ ./Help/variable/CTEST_COVERAGE_COMMAND.rst,\ ./Modules/CMakeCheckCompilerFlagCommonPatterns.cmake,\ ./Modules/CMakeRCInformation.cmake,\ ./Modules/Internal/CPack/NSIS.template.in,\ ./Modules/FindMatlab.cmake,\ ./Modules/MatlabTestsRedirect.cmake,\ ./Modules/Platform/Windows-Clang.cmake,\ ./Modules/Platform/Windows-Intel-Fortran.cmake,\ ./Modules/Platform/Windows-MSVC.cmake,\ ./Source/CMakeVersion.cmake,\ ./Source/cmConvertMSBuildXMLToJSON.py,\ ./Source/cmCreateTestSourceList.cxx,\ ./Source/cmGlobalVisualStudio10Generator.cxx,\ ./Source/cmExportBuildFileGenerator.cxx,\ ./Source/cmExportInstallAndroidMKGenerator.cxx,\ ./Source/cmExportInstallFileGenerator.cxx,\ ./Source/cmExportSet.cxx,\ ./Source/cmExportTryCompileFileGenerator.cxx,\ ./Source/cmFindPackageCommand.cxx,\ ./Source/cmInstallCommand.cxx,\ ./Source/cmGeneratorExpressionLexer.cxx,\ ./Source/cmLocalVisualStudio7Generator.cxx,\ ./Source/cmOrderDirectories.cxx,\ ./Source/cmTarget.cxx,\ ./Source/kwsys/*,\ ./Source/QtDialog/CMakeSetupDialog.ui,\ ./Source/CPack/WiX/cmWIXRichTextFormatWriter.cxx,\ ./Source/CTest/cmParseCoberturaCoverage.h,\ ./Tests/CMakeTests/ImplicitLinkInfoTest.cmake.in,\ ./Tests/RunCMake/CPack/tests/DMG_SLA/English.license.rtf,\ ./Tests/RunCMake/CPack/tests/DMG_SLA/German.license.txt,\ ./Tests/RunCMake/CPack/tests/DMG_SLA/German.menu.txt,\ ./Tests/RunCMake/GoogleTest/xml_output.cpp,\ ./Tests/RunCMake/Make/TargetMessages*,\ ./Utilities/*,\ " \ -L "\ dependees,\ endwhile,\ fo,\ filetest,\ helpfull,\ nd,\ objext,\ stoll,\ supercedes,\ superceded,\ vas,\ varn,\ " ```
* Help: Clarify search order for resource spec fileKyle Edwards2020-07-071-3/+10
| | | | | | | | Clarify the order in which --resource-spec-file, RESOURCE_SPEC_FILE, and CTEST_RESOURCE_SPEC_FILE are searched, and add tests to enforce this. Fixes: #20914
* ctest: add option --stop-on-failureJohnny Jazeix2020-04-201-0/+3
| | | | | | To stop the tests once one has failed Fixes: #16628
* CTest: Add CTEST_RESOURCE_SPEC_FILE variableKyle Edwards2020-04-021-2/+6
|
* Help: Clarify that the CTest resource allocation feature doesn't oversubscribeKyle Edwards2020-02-211-0/+9
|
* Add --no-tests=<[error|ignore]> option to CTestStefan Dinkelacker2020-01-311-0/+8
| | | | | | | | | If no tests were found, the default behavior of CTest is to always log an error message but to return an error code in script mode only. This option unifies the behavior of CTest by either returning an error code if no tests were found or by ignoring it. Signed-off-by: Stefan Dinkelacker <s.dinkelacker@dkfz-heidelberg.de>
* ctest: add support for memcheck using Dr. MemoryDietmar Scheidl2019-12-101-0/+14
| | | | Fixes: #19788
* Merge topic 'ctest-resource-fixes'Brad King2019-11-261-0/+26
|\ | | | | | | | | | | | | | | | | a033bafbe0 Help: Clarify how tests are run if no resource spec file is specified a64ba0235f CTest: Clarify that resource requirements can be split f9f294f5fa CTest: Add version field to resource spec file Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !4080
| * Help: Clarify how tests are run if no resource spec file is specifiedKyle Edwards2019-11-261-0/+17
| | | | | | | | Fixes: #19985
| * CTest: Add version field to resource spec fileKyle Edwards2019-11-251-0/+9
| | | | | | | | Fixes: #20007
* | CTest: Consolidate '--repeat-* n' options as `--repeat *:n`Brad King2019-11-151-13/+17
| | | | | | | | | | | | | | Combine `--repeat-until-fail`, `--repeat-until-pass`, and `--repeat-after-timeout` to create a single `--repeat <mode>:<n>` option. Retain `--repeat-until-fail` too because that has been available in previous releases.
* | Merge branch 'backport-ctest-resource-groups'Brad King2019-11-051-71/+72
|\ \ | |/
| * Help: Fix error in resource allocation exampleKyle Edwards2019-11-051-2/+2
| |
| * CTest: Rename hardware -> resources for CMake variables, command optionsCraig Scott2019-11-051-36/+35
| | | | | | | | | | | | 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-051-37/+39
| | | | | | | | | | | | | | | | | | | | | | | | 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
* | ctest: Add --repeat-after-timeout optionBrad King2019-10-291-0/+8
| | | | | | | | | | Add an option to re-run tests if they timeout. This will help tolerate sporadic timeouts on busy machines.
* | ctest: Add --repeat-until-pass optionBrad King2019-10-291-0/+5
|/ | | | | | | | | Add an option to re-run tests if they fail. This will help tolerate sporadic failures. Issue: #17010 Co-Author: Ben Boeckel <ben.boeckel@kitware.com> Co-Author: Chuck Atkins <chuck.atkins@kitware.com>
* Help: Add documentation for CTest hardware allocationKyle Edwards2019-10-021-0/+229
|
* ctest: rename TRACK to GROUPZack Galbreath2019-08-221-4/+7
| | | | | | | | | | Update command-line options, script variables, and documentation to use the term "group" instead of "track". The old terms are still available for now, but they are now undocumented. This makes our terminology more consistent with CDash. The goal of this change is to make it more clear to our users how CTest and CDash interact with each other.