mirror of
https://github.com/Kitware/CMake.git
synced 2025-10-14 02:08:27 +08:00
c705279bae
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
41 lines
1.3 KiB
ReStructuredText
41 lines
1.3 KiB
ReStructuredText
ctest_memcheck
|
|
--------------
|
|
|
|
Perform the :ref:`CTest MemCheck Step` as a :ref:`Dashboard Client`.
|
|
|
|
::
|
|
|
|
ctest_memcheck([BUILD <build-dir>] [APPEND]
|
|
[START <start-number>]
|
|
[END <end-number>]
|
|
[STRIDE <stride-number>]
|
|
[EXCLUDE <exclude-regex>]
|
|
[INCLUDE <include-regex>]
|
|
[EXCLUDE_LABEL <label-exclude-regex>]
|
|
[INCLUDE_LABEL <label-include-regex>]
|
|
[EXCLUDE_FIXTURE <regex>]
|
|
[EXCLUDE_FIXTURE_SETUP <regex>]
|
|
[EXCLUDE_FIXTURE_CLEANUP <regex>]
|
|
[PARALLEL_LEVEL <level>]
|
|
[TEST_LOAD <threshold>]
|
|
[SCHEDULE_RANDOM <ON|OFF>]
|
|
[STOP_TIME <time-of-day>]
|
|
[RETURN_VALUE <result-var>]
|
|
[DEFECT_COUNT <defect-count-var>]
|
|
[QUIET]
|
|
)
|
|
|
|
|
|
Run tests with a dynamic analysis tool and store results in
|
|
``MemCheck.xml`` for submission with the :command:`ctest_submit`
|
|
command.
|
|
|
|
Most options are the same as those for the :command:`ctest_test` command.
|
|
|
|
The options unique to this command are:
|
|
|
|
``DEFECT_COUNT <defect-count-var>``
|
|
.. versionadded:: 3.8
|
|
|
|
Store in the ``<defect-count-var>`` the number of defects found.
|