diff options
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/manual/cmake-developer.7.rst | 4 | ||||
| -rw-r--r-- | Help/manual/cmake-variables.7.rst | 1 | ||||
| -rw-r--r-- | Help/manual/ctest.1.rst | 25 | ||||
| -rw-r--r-- | Help/module/FindITK.rst | 11 | ||||
| -rw-r--r-- | Help/module/FindVTK.rst | 11 | ||||
| -rw-r--r-- | Help/release/dev/ctest-memcheck-sanitizers.rst | 8 | ||||
| -rw-r--r-- | Help/release/dev/thread-sanitizer.rst | 5 | ||||
| -rw-r--r-- | Help/variable/CTEST_MEMORYCHECK_SANITIZER_OPTIONS.rst | 5 | ||||
| -rw-r--r-- | Help/variable/CTEST_MEMORYCHECK_TYPE.rst | 5 |
9 files changed, 56 insertions, 19 deletions
diff --git a/Help/manual/cmake-developer.7.rst b/Help/manual/cmake-developer.7.rst index cd979c9..625dac0 100644 --- a/Help/manual/cmake-developer.7.rst +++ b/Help/manual/cmake-developer.7.rst @@ -188,8 +188,8 @@ size_t Various implementations have differing implementation of ``size_t``. When assigning the result of ``.size()`` on a container for example, the result -should not be assigned to an ``unsigned int`` or similar. ``std::size_t`` must -not be used. +should be assigned to ``size_t`` not to ``std::size_t``, ``unsigned int`` or +similar types. Templates --------- diff --git a/Help/manual/cmake-variables.7.rst b/Help/manual/cmake-variables.7.rst index 3f92ec5..864ea6e 100644 --- a/Help/manual/cmake-variables.7.rst +++ b/Help/manual/cmake-variables.7.rst @@ -351,6 +351,7 @@ Variables for CTest /variable/CTEST_HG_UPDATE_OPTIONS /variable/CTEST_MEMORYCHECK_COMMAND /variable/CTEST_MEMORYCHECK_COMMAND_OPTIONS + /variable/CTEST_MEMORYCHECK_SANITIZER_OPTIONS /variable/CTEST_MEMORYCHECK_SUPPRESSIONS_FILE /variable/CTEST_MEMORYCHECK_TYPE /variable/CTEST_NIGHTLY_START_TIME diff --git a/Help/manual/ctest.1.rst b/Help/manual/ctest.1.rst index a3210a9..03e86af 100644 --- a/Help/manual/ctest.1.rst +++ b/Help/manual/ctest.1.rst @@ -111,7 +111,7 @@ Options ``-D <dashboard>, --dashboard <dashboard>`` Execute dashboard test - This option tells ctest to act as a Dart client and perform a + This option tells ctest to act as a CDash client and perform a dashboard test. All tests are <Mode><Test>, where Mode can be Experimental, Nightly, and Continuous, and Test can be Start, Update, Configure, Build, Test, Coverage, and Submit. @@ -127,14 +127,14 @@ Options ``-M <model>, --test-model <model>`` Sets the model for a dashboard - This option tells ctest to act as a Dart client where the TestModel + This option tells ctest to act as a CDash client where the TestModel can be Experimental, Nightly, and Continuous. Combining -M and -T is similar to -D ``-T <action>, --test-action <action>`` Sets the dashboard action to perform - This option tells ctest to act as a Dart client and perform some + This option tells ctest to act as a CDash client and perform some action such as start, build, test etc. Combining -M and -T is similar to -D @@ -328,11 +328,8 @@ Options used to detect implicit dependencies in a test suite. ``--submit-index`` - Submit individual dashboard tests with specific index - - This option allows performing the same CTest action (such as test) - multiple times and submit all stages to the same dashboard (Dart2 - required). Each execution requires different index. + Legacy option for old Dart2 dashboard server feature. + Do not use. ``--timeout <seconds>`` Set a global timeout on all tests. @@ -824,6 +821,18 @@ Configuration settings include: * `CTest Script`_ variable: :variable:`CTEST_MEMORYCHECK_COMMAND_OPTIONS` * :module:`CTest` module variable: ``MEMORYCHECK_COMMAND_OPTIONS`` +``MemoryCheckType`` + Specify the type of memory checking to perform. + + * `CTest Script`_ variable: :variable:`CTEST_MEMORYCHECK_TYPE` + * :module:`CTest` module variable: ``MEMORYCHECK_TYPE`` + +``MemoryCheckSanitizerOptions`` + Specify options to sanitizers when running with a sanitize-enabled build. + + * `CTest Script`_ variable: :variable:`CTEST_MEMORYCHECK_SANITIZER_OPTIONS` + * :module:`CTest` module variable: ``MEMORYCHECK_SANITIZER_OPTIONS`` + ``MemoryCheckSuppressionFile`` Specify a file containing suppression rules for the ``MemoryCheckCommand`` tool. It will be passed with options diff --git a/Help/module/FindITK.rst b/Help/module/FindITK.rst index dbfabbd..21a922f 100644 --- a/Help/module/FindITK.rst +++ b/Help/module/FindITK.rst @@ -1 +1,10 @@ -.. cmake-module:: ../../Modules/FindITK.cmake +FindITK +------- + +This module no longer exists. + +This module existed in versions of CMake prior to 3.1, but became +only a thin wrapper around ``find_package(ITK NO_MODULE)`` to +provide compatibility for projects using long-outdated conventions. +Now ``find_package(ITK)`` will search for ``ITKConfig.cmake`` +directly. diff --git a/Help/module/FindVTK.rst b/Help/module/FindVTK.rst index f9c1efe..3bc67c5 100644 --- a/Help/module/FindVTK.rst +++ b/Help/module/FindVTK.rst @@ -1 +1,10 @@ -.. cmake-module:: ../../Modules/FindVTK.cmake +FindVTK +------- + +This module no longer exists. + +This module existed in versions of CMake prior to 3.1, but became +only a thin wrapper around ``find_package(VTK NO_MODULE)`` to +provide compatibility for projects using long-outdated conventions. +Now ``find_package(VTK)`` will search for ``VTKConfig.cmake`` +directly. diff --git a/Help/release/dev/ctest-memcheck-sanitizers.rst b/Help/release/dev/ctest-memcheck-sanitizers.rst new file mode 100644 index 0000000..fa8fb81 --- /dev/null +++ b/Help/release/dev/ctest-memcheck-sanitizers.rst @@ -0,0 +1,8 @@ +ctest-memcheck-sanitizers +------------------------- + +* The :command:`ctest_memcheck` command learned to support sanitizer + modes, including ``AddressSanitizer``, ``MemorySanitizer``, + ``ThreadSanitizer``, and ``UndefinedBehaviorSanitizer``. + Options may be set using the new + :variable:`CTEST_MEMORYCHECK_SANITIZER_OPTIONS` variable. diff --git a/Help/release/dev/thread-sanitizer.rst b/Help/release/dev/thread-sanitizer.rst deleted file mode 100644 index f38e8e1..0000000 --- a/Help/release/dev/thread-sanitizer.rst +++ /dev/null @@ -1,5 +0,0 @@ -thread-sanitizer ----------------- - -* The :command:`ctest_memcheck` command learned to support - ``ThreadSanitizer``. diff --git a/Help/variable/CTEST_MEMORYCHECK_SANITIZER_OPTIONS.rst b/Help/variable/CTEST_MEMORYCHECK_SANITIZER_OPTIONS.rst new file mode 100644 index 0000000..2de5fb6 --- /dev/null +++ b/Help/variable/CTEST_MEMORYCHECK_SANITIZER_OPTIONS.rst @@ -0,0 +1,5 @@ +CTEST_MEMORYCHECK_SANITIZER_OPTIONS +----------------------------------- + +Specify the CTest ``MemoryCheckSanitizerOptions`` setting +in a :manual:`ctest(1)` dashboard client script. diff --git a/Help/variable/CTEST_MEMORYCHECK_TYPE.rst b/Help/variable/CTEST_MEMORYCHECK_TYPE.rst index f7875da..f1087c0 100644 --- a/Help/variable/CTEST_MEMORYCHECK_TYPE.rst +++ b/Help/variable/CTEST_MEMORYCHECK_TYPE.rst @@ -1,6 +1,7 @@ CTEST_MEMORYCHECK_TYPE -------------------------- +---------------------- Specify the CTest ``MemoryCheckType`` setting in a :manual:`ctest(1)` dashboard client script. -Valid values are Valgrind, Purify, BoundsChecker, and ThreadSanitizer. +Valid values are Valgrind, Purify, BoundsChecker, and ThreadSanitizer, +AddressSanitizer, MemorySanitizer, and UndefinedBehaviorSanitizer. |