summaryrefslogtreecommitdiffstats
path: root/Help/command/ctest_memcheck.rst
Commit message (Collapse)AuthorAgeFilesLines
* Help: Use CMake highlighting for command synopsisAlex Turbov2022-11-091-1/+1
| | | | Most of CMake commands use it. Fix a few of them to do the same.
* Help/ctest_memcheck: mention `ctest_test` argumentsBen Boeckel2021-07-141-0/+5
| | | | | These are handled internally by inheriting `ctest_test`'s argument bindings. Synchronize the documentation.
* Help: Add `.. versionadded` directives to commands documentationNikita Nemkin2020-11-091-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This change ony concerns directives that appear in the document body. The guidelines for inserting version directives: * Baseline version is CMake 3.0, i.e. directives start at 3.1. * Always use `.. versionadded::` directive, avoid ad-hoc version references. Exception: policy pages. * For new command signatures, put `versionadded` on a separate line after the signature. * For a group of new signatures in a new document section, a single version note at the beginning of the section is sufficient. * For new options, put `versionadded` on a separate line before option description. * If all the option descriptions in the list are short one-liners, it's fine to put `versionadded` on the same line as the description. * If multiple option descriptions in close proximity would have the same ..versionadded directive, consider adding a single directive after the list, mentioning all added options. * For compact value lists and sub-option lists, put a single `versionadded` directive after the list mentioning all additions. * When a change is described in a single paragraph, put `versionadded` into that paragraph. * When only part of the paragraph has changed, separate the changed part if it doesn't break the flow. Otherwise, write a follow-up clarification paragraph and apply version directive to that. * When multiple version directives are close by, order earlier additions before later additions. * Indent related lists and code blocks to include them in the scope of `versionadded` directive. Issue: #19715
* Add ctest options for limiting which tests fixtures addCraig Scott2017-05-011-0/+3
| | | | | The new options allow the user to restrict the setup and cleanup tests automatically added for fixtures.
* ctest_memcheck: Add DEFECT_COUNT option to capture defect countBetsy McPhail2016-11-091-1/+7
|
* ctest: Optionally avoid starting tests that may exceed a given CPU loadBetsy McPhail2015-06-301-0/+1
| | | | | | | | | | | | | | Add a TestLoad setting to CTest that can be set via a new --test-load command-line option, CTEST_TEST_LOAD variable, or TEST_LOAD option to the ctest_test command. Teach cmCTestMultiProcessHandler to measure the CPU load and avoid starting tests that may take more than the spare load currently available. The expression <current_load> + <test_processors> <= <max-load> must be true to start a new test. Co-Author: Zack Galbreath <zack.galbreath@kitware.com>
* Help: Revise ctest_* command documentation (#15559)Brad King2015-05-071-23/+19
| | | | | | Revise documentation for the major dashboard client step ``ctest_*`` commands. Modernize the documentation formatting. Add some missing options.
* ctest_memcheck: Add QUIET optionZack Galbreath2015-02-231-0/+4
|
* Convert builtin help to reStructuredText source filesKitware Robot2013-10-151-0/+28
Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.