From 93b94ce443e2fecfa0cef7edb353f76b33afd843 Mon Sep 17 00:00:00 2001 From: Brad King Date: Tue, 15 May 2007 10:23:40 -0400 Subject: STYLE: Added basic usage documentation. --- Modules/CTest.cmake | 12 ++++++++++-- Modules/Dart.cmake | 16 +++++++++++++--- 2 files changed, 23 insertions(+), 5 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) diff --git a/Modules/Dart.cmake b/Modules/Dart.cmake index a463d13..6d0f86d 100644 --- a/Modules/Dart.cmake +++ b/Modules/Dart.cmake @@ -1,8 +1,18 @@ -# - setup for using Dart. +# - Configure a project for testing with CTest or old Dart Tcl Client +# This file is the backwards-compatibility version of the CTest module. +# It supports using the old Dart 1 Tcl client for driving dashboard +# submissions as well as testing with CTest. This module should be included +# in the CMakeLists.txt file at the top of a project. Typical usage: +# INCLUDE(Dart) +# IF(BUILD_TESTING) +# # ... testing related CMake code ... +# ENDIF(BUILD_TESTING) +# The BUILD_TESTING option is created by the Dart module to determine +# whether testing support should be enabled. The default is ON. + # This file configures a project to use the Dart testing/dashboard process. # It is broken into 3 sections. - -# +# # Section #1: Locate programs on the client and determine site and build name # Section #2: Configure or copy Tcl scripts from the source tree to build tree # Section #3: Custom targets for performing dashboard builds. -- cgit v0.12