summaryrefslogtreecommitdiffstats
path: root/Modules/CTest.cmake
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2007-05-15 14:23:40 (GMT)
committerBrad King <brad.king@kitware.com>2007-05-15 14:23:40 (GMT)
commit93b94ce443e2fecfa0cef7edb353f76b33afd843 (patch)
tree5fb8eefceed78a72f7b889e4c20a6c3664a5c68d /Modules/CTest.cmake
parentd940b667f80f7828cfc48815de135a36b59b2462 (diff)
downloadCMake-93b94ce443e2fecfa0cef7edb353f76b33afd843.zip
CMake-93b94ce443e2fecfa0cef7edb353f76b33afd843.tar.gz
CMake-93b94ce443e2fecfa0cef7edb353f76b33afd843.tar.bz2
STYLE: Added basic usage documentation.
Diffstat (limited to 'Modules/CTest.cmake')
-rw-r--r--Modules/CTest.cmake12
1 files changed, 10 insertions, 2 deletions
diff --git a/Modules/CTest.cmake b/Modules/CTest.cmake
index c8411ab..8663f41 100644
--- a/Modules/CTest.cmake
+++ b/Modules/CTest.cmake
@@ -1,6 +1,14 @@
-# - setup CTest
+# - Configure a project for testing with CTest/Dart
# This file configures a project to use the CTest/Dart
-# testing/dashboard process.
+# testing/dashboard process. This module should be included
+# in the CMakeLists.txt file at the top of a project. Typical usage:
+# INCLUDE(CTest)
+# IF(BUILD_TESTING)
+# # ... testing related CMake code ...
+# ENDIF(BUILD_TESTING)
+# The BUILD_TESTING option is created by the CTest module to determine
+# whether testing support should be enabled. The default is ON.
+
OPTION(BUILD_TESTING "Build the testing tree." ON)
IF(BUILD_TESTING)