summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBen Boeckel <ben.boeckel@kitware.com>2014-10-03 17:42:43 (GMT)
committerBen Boeckel <ben.boeckel@kitware.com>2014-10-03 17:43:44 (GMT)
commit0b9ffffcd437c3538ff5aa1858d743a289b06129 (patch)
tree550b3d9321462981d701229932652bb893a4cb39
parent99d34f46fa394a9daabb7ca959e1540ae3a41ef2 (diff)
downloadCMake-0b9ffffcd437c3538ff5aa1858d743a289b06129.zip
CMake-0b9ffffcd437c3538ff5aa1858d743a289b06129.tar.gz
CMake-0b9ffffcd437c3538ff5aa1858d743a289b06129.tar.bz2
ctest: update documentation for CTEST_MEMORYCHECK_TYPE
The AddressSanitizer value was not documented. Also fix some typos.
-rw-r--r--Help/manual/ctest.1.rst6
-rw-r--r--Help/variable/CTEST_MEMORYCHECK_TYPE.rst5
-rw-r--r--Source/CTest/cmCTestMemCheckHandler.h2
3 files changed, 10 insertions, 3 deletions
diff --git a/Help/manual/ctest.1.rst b/Help/manual/ctest.1.rst
index a3210a9..9b783ba 100644
--- a/Help/manual/ctest.1.rst
+++ b/Help/manual/ctest.1.rst
@@ -824,6 +824,12 @@ 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``
+
``MemoryCheckSuppressionFile``
Specify a file containing suppression rules for the
``MemoryCheckCommand`` tool. It will be passed with options
diff --git a/Help/variable/CTEST_MEMORYCHECK_TYPE.rst b/Help/variable/CTEST_MEMORYCHECK_TYPE.rst
index f7875da..e8d5461 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,
+and AddressSanitizer.
diff --git a/Source/CTest/cmCTestMemCheckHandler.h b/Source/CTest/cmCTestMemCheckHandler.h
index 2195dab..f442376 100644
--- a/Source/CTest/cmCTestMemCheckHandler.h
+++ b/Source/CTest/cmCTestMemCheckHandler.h
@@ -49,7 +49,7 @@ private:
VALGRIND,
PURIFY,
BOUNDS_CHECKER,
- // checkers after hear do not use the standard error list
+ // checkers after here do not use the standard error list
THREAD_SANITIZER,
ADDRESS_SANITIZER
};